Struct MetricTemplate

pub struct MetricTemplate {
    pub selectors: Vec<String>,
    pub metric_id: MetricId,
    pub metric_type: MetricType,
    pub event_codes: Vec<EventCode>,
    pub upload_once: bool,
    pub project_id: Option<ProjectId>,
}

Configuration for a single FIRE metric template to map from an Inspect property to a cobalt metric. Unlike MetricConfig, selectors aren’t parsed.

Fields

selectors: Vec<String>

Selector identifying the metric to sample via the diagnostics platform.

metric_id: MetricId

Cobalt metric id to map the selector to.

metric_type: MetricType

Data type to transform the metric to.

event_codes: Vec<EventCode>

Event codes defining the dimensions of the cobalt metric. Notes:

• Order matters, and must match the order of the defined dimensions in the cobalt metric file.
• The FIRE component-ID will be inserted as the first element of event_codes.
• The event_codes field may be omitted from the config file if component-ID is the only event code.

upload_once: bool

Optional boolean specifying whether to upload the specified metric only once, the first time it becomes available to the sampler. Defaults to false.

project_id: Option<ProjectId>

Optional project id. When present this project id will be used instead of the top-level project id.

Trait Implementations

impl Clone for MetricTemplate

fn clone(&self) -> MetricTemplate

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricTemplate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricTemplate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MetricTemplate

fn eq(&self, other: &MetricTemplate) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MetricTemplate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MetricTemplate

impl StructuralPartialEq for MetricTemplate