diff options
Diffstat (limited to 'toolkit/components/glean/docs/code_organization.md')
| -rw-r--r-- | toolkit/components/glean/docs/code_organization.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/toolkit/components/glean/docs/code_organization.md b/toolkit/components/glean/docs/code_organization.md new file mode 100644 index 0000000000..2055fd0469 --- /dev/null +++ b/toolkit/components/glean/docs/code_organization.md @@ -0,0 +1,64 @@ +# FOG code organization + +```eval_rst +.. note:: + + Project FOG is currently being designed and implemented. + This documentation is incomplete and may change significantly before FOG is usable inside mozilla-central. +``` + + + +The diagram shows the different modules of Project FOG. + +## FOG control + +This module is the glue between Firefox and Glean. + +* The code lives in `toolkit/components/glean/src`. +* It is written in Rust. +* The crate is named `fog_control`. +* It is not published to crates.io. +* It is not consumed by other Rust crates inside mozilla-central. + +This module is responsible for + +* collecting and assembling the [client information](https://mozilla.github.io/glean/book/user/pings/index.html#the-client_info-section) +* configuring Glean +* watching the Firefox Telemetry data upload preference (`datareporting.healthreport.uploadEnabled`) +* scheduling builtin pings +* controling ping upload workers +* passing IPC buffers + +It calls into `glean_core` to: + +* configure and initialize Glean +* toggle `upload_enabled` +* get upload tasks + +It calls into `fog` to: + +* pass IPC buffers +* record to its own metrics + +## FOG API + +This module provides the user-facing API for Glean inside mozilla-central. + +* The code lives in `toolkit/components/glean/api`. +* It is written in Rust. +* The crate is named `fog`. +* It is not published to crates.io. +* It can be consumed by other Rust crates inside mozilla-central for their Glean usage. +* It will provide a build task for `glean_parser` integration. + +This module is responsible for + +* exposing a specific metric API in Rust +* wrapping metric implementations for handling IPC +* exposing FFI functionality to implement other language APIs on top + +It calls into `glean_core` for: + +* metric types (including pings) +* querying `upload_enabled` status. |