Struct glean_core::storage::StorageManager

pub struct StorageManager;

Snapshot metrics from the underlying database.

Methods

impl StorageManager

pub fn snapshot(
    &self,
    storage: &Database,
    store_name: &str,
    clear_store: bool
) -> Option<String>

Snapshot the given store and optionally clear it.

Arguments

• storage - the database to read from.
• store_name - the store to snapshot.
• clear_store - whether to clear the data after snapshotting.

Return value

Returns the stored data in a string encoded as JSON. Returns None if no data for the store exists.

pub fn snapshot_as_json(
    &self,
    storage: &Database,
    store_name: &str,
    clear_store: bool
) -> Option<JsonValue>

Snapshot the given store and optionally clear it.

Arguments

• storage - the database to read from.
• store_name - the store to snapshot.
• clear_store - whether to clear the data after snapshotting.

Return value

Returns a JSON representation of the stored data. Returns None if no data for the store exists.

pub fn snapshot_metric(
    &self,
    storage: &Database,
    store_name: &str,
    metric_id: &str
) -> Option<Metric>

Get the current value of a single metric identified by name.

This look for a value in stores for all lifetimes.

Arguments:

• storage - The database to get data from.
• store_name - The store name to look into.
• metric_id - The full metric identifier.

Return value:

Returns the decoded metric or None if no data is found.

pub fn snapshot_experiments_as_json(
    &self,
    storage: &Database,
    store_name: &str
) -> Option<JsonValue>

Snapshot the experiments.

Arguments:

• storage - The database to get data from.
• store_name - The store name to look into.

Return value

Returns a JSON representation of the experiment data, in the following format:

{
 "experiment-id": {
   "branch": "branch-id",
   "extra": {
     "additional": "property",
     // ...
   }
 }
}

Returns None if no data for experiments exists.