Struct glean_core::Glean

pub struct Glean { /* fields omitted */ }

The object holding meta information about a Glean instance.

Example

Create a new Glean instance, register a ping, record a simple counter and then send the final ping.

let cfg = Configuration {
    data_path: "/tmp/glean".into(),
    application_id: "glean.sample.app".into(),
    upload_enabled: true,
    max_events: None,
    delay_ping_lifetime_io: false,
};
let mut glean = Glean::new(cfg).unwrap();
let ping = PingType::new("sample", true, false, vec![]);
glean.register_ping_type(&ping);

let call_counter: CounterMetric = CounterMetric::new(CommonMetricData {
    name: "calls".into(),
    category: "local".into(),
    send_in_pings: vec!["sample".into()],
    ..Default::default()
});

call_counter.add(&glean, 1);

glean.submit_ping(&ping, None).unwrap();

Note

In specific language bindings, this is usually wrapped in a singleton and all metric recording goes to a single instance of this object. In the Rust core, it is possible to create multiple instances, which is used in testing.

Implementations

impl Glean

pub fn new(cfg: Configuration) -> Result<Self>

Create and initialize a new Glean object.

This will create the necessary directories and files in data_path. This will also initialize the core metrics.

pub fn destroy_db(&mut self)

Destroy the database. After this Glean needs to be reinitialized.

pub fn on_ready_to_submit_pings(&self) -> bool

Called when Glean is initialized to the point where it can correctly assemble pings. Usually called from the language specific layer after all of the core metrics have been set and the ping types have been registered.

Return value

true if at least one ping was generated, false otherwise.

pub fn set_upload_enabled(&mut self, flag: bool) -> bool

Set whether upload is enabled or not.

When uploading is disabled, metrics aren't recorded at all and no data is uploaded.

When disabling, all pending metrics, events and queued pings are cleared.

When enabling, the core Glean metrics are recreated.

If the value of this flag is not actually changed, this is a no-op.

Arguments

• flag - When true, enable metric collection.

Returns

• Returns true when the flag was different from the current value, and actual work was done to clear or reinstate metrics.

pub fn is_upload_enabled(&self) -> bool

Determine whether upload is enabled.

When upload is disabled, no data will be recorded.

pub fn get_application_id(&self) -> &str

Get the application ID as specified on instantiation.

pub fn get_data_path(&self) -> &Path

Get the data path of this instance.

pub fn storage(&self) -> &Database

Get a handle to the database.

pub fn event_storage(&self) -> &EventDatabase

Get a handle to the event database.

pub fn get_max_events(&self) -> usize

Get the maximum number of events to store before sending a ping.

pub fn get_upload_task(&self) -> PingUploadTask

Gets the next task for an uploader.

This can be one of:

• Wait - which means the requester should ask again later;
• Upload(PingRequest) - which means there is a ping to upload. This wraps the actual request object;
• Done - which means there are no more pings queued right now.

Return value

PingUploadTask - an enum representing the possible tasks.

pub fn process_ping_upload_response(&self, uuid: &str, status: UploadResult)

Processes the response from an attempt to upload a ping.

Arguments

• uuid - The UUID of the ping in question.
• status - The upload result.

pub fn snapshot(&mut self, store_name: &str, clear_store: bool) -> String

Take a snapshot for the given store and optionally clear it.

Arguments

• store_name - The store to snapshot.
• clear_store - Whether to clear the store after snapshotting.

Return value

Returns the snapshot in a string encoded as JSON. If the snapshot is empty, it returns an empty string.

pub fn submit_ping(&self, ping: &PingType, reason: Option<&str>) -> Result<bool>

Collect and submit a ping for eventual uploading.

The ping content is assembled as soon as possible, but upload is not guaranteed to happen immediately, as that depends on the upload policies.

If the ping currently contains no content, it will not be sent.

Returns true if a ping was assembled and queued, false otherwise. Returns an error if collecting or writing the ping to disk failed.

Arguments

• ping: The ping to submit
• reason: A reason code to include in the ping

pub fn submit_ping_by_name(
    &self,
    ping_name: &str,
    reason: Option<&str>
) -> Result<bool>

Collect and submit a ping by name for eventual uploading.

The ping content is assembled as soon as possible, but upload is not guaranteed to happen immediately, as that depends on the upload policies.

If the ping currently contains no content, it will not be sent.

Returns true if a ping was assembled and queued, false otherwise. Returns an error if collecting or writing the ping to disk failed.

Arguments

• ping_name: The name of the ping to submit
• reason: A reason code to include in the ping

pub fn get_ping_by_name(&self, ping_name: &str) -> Option<&PingType>

Get a PingType by name.

Return value

Returns the PingType if a ping of the given name was registered before. Returns None otherwise.

pub fn register_ping_type(&mut self, ping: &PingType)

Register a new PingType.

pub fn set_experiment_active(
    &self,
    experiment_id: String,
    branch: String,
    extra: Option<HashMap<String, String>>
)

Indicate that an experiment is running. Glean will then add an experiment annotation to the environment which is sent with pings. This information is not persisted between runs.

Arguments

• experiment_id - The id of the active experiment (maximum 30 bytes).
• branch - The experiment branch (maximum 30 bytes).
• extra - Optional metadata to output with the ping.

pub fn set_experiment_inactive(&self, experiment_id: String)

Indicate that an experiment is no longer running.

Arguments

• experiment_id - The id of the active experiment to deactivate (maximum 30 bytes).

pub fn persist_ping_lifetime_data(&self) -> Result<()>

Persist Lifetime::Ping data that might be in memory in case delay_ping_lifetime_io is set or was set at a previous time.

If there is no data to persist, this function does nothing.

pub fn clear_application_lifetime_metrics(&self)

** This is not meant to be used directly.**

Clear all the metrics that have Lifetime::Application.

pub fn is_first_run(&self) -> bool

Return whether or not this is the first run on this profile.

pub fn set_dirty_flag(&self, new_value: bool)

** This is not meant to be used directly.**

Set the value of a "dirty flag" in the permanent storage. The "dirty flag" is meant to have the following behaviour, implemented by the consumers of the FFI layer:

• on mobile: set to false when going to background or shutting down, set to true at startup and when going to foreground.
• on non-mobile platforms: set to true at startup and false at shutdown.

At startup, before setting its new value, if the "dirty flag" value is true, then Glean knows it did not exit cleanly and can implement coping mechanisms (e.g. sending a baseline ping).

pub fn is_dirty_flag_set(&self) -> bool

** This is not meant to be used directly.**

Check the stored value of the "dirty flag".

pub fn test_is_experiment_active(&self, experiment_id: String) -> bool

Test-only API (exported for FFI purposes).

Check if an experiment is currently active.

Arguments

• experiment_id - The id of the experiment (maximum 30 bytes).

Return value

True if the experiment is active, false otherwise.

pub fn test_get_experiment_data_as_json(
    &self,
    experiment_id: String
) -> Option<String>

Test-only API (exported for FFI purposes).

Get stored data for the requested experiment.

Arguments

• experiment_id - The id of the active experiment (maximum 30 bytes).

Return value

If the requested experiment is active, a JSON string with the following format: { 'branch': 'the-branch-name', 'extra': {'key': 'value', ...}} Otherwise, None.

pub fn test_clear_all_stores(&self)

Test-only API (exported for FFI purposes).

Delete all stored metrics. Note that this also includes the ping sequence numbers, so it has the effect of resetting those to their initial values.

Trait Implementations

impl Debug for Glean

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.