1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# 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 the Glean SDK via the Rust Language Binding
* watching the Firefox Telemetry data upload preference (`datareporting.healthreport.uploadEnabled`)
* scheduling builtin pings
* controling ping upload workers
* passing IPC buffers
It calls into `glean` (the Glean SDK Rust Language Binding) 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.
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.
See also [Adding a New Metric Type](new_metric_types.md).
It calls into `glean` (the Glean SDK Rust Language Binding) for:
* metric types (including pings)
|
