Struct MetricDescriptor

#[non_exhaustive]
pub struct MetricDescriptor {
    pub name: String,
    pub type: String,
    pub labels: Vec<LabelDescriptor>,
    pub metric_kind: MetricKind,
    pub value_type: ValueType,
    pub unit: String,
    pub description: String,
    pub display_name: String,
    pub metadata: Option<MetricDescriptorMetadata>,
    pub launch_stage: LaunchStage,
    pub monitored_resource_types: Vec<String>,
}

Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type’s existing data unusable.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The resource name of the metric descriptor.

type: String

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example:

"custom.googleapis.com/invoice/paid/amount"
"external.googleapis.com/prometheus/up"
"appengine.googleapis.com/http/server/response_latencies"

labels: Vec<LabelDescriptor>

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

metric_kind: MetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

value_type: ValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

unit: String

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.

Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.

If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.

Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).

The supported units are a subset of The Unified Code for Units of Measure standard:

Basic units (UNIT)

• bit bit
• By byte
• s second
• min minute
• h hour
• d day
• 1 dimensionless

Prefixes (PREFIX)

• k kilo (10^3)

• M mega (10^6)

• G giga (10^9)

• T tera (10^12)

• P peta (10^15)

• E exa (10^18)

• Z zetta (10^21)

• Y yotta (10^24)

• m milli (10^-3)

• u micro (10^-6)

• n nano (10^-9)

• p pico (10^-12)

• f femto (10^-15)

• a atto (10^-18)

• z zepto (10^-21)

• y yocto (10^-24)

• Ki kibi (2^10)

• Mi mebi (2^20)

• Gi gibi (2^30)

• Ti tebi (2^40)

• Pi pebi (2^50)

Grammar

The grammar also includes these connectors:

• / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value).
• . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.

The grammar for a unit is as follows:

Expression = Component { "." Component } { "/" Component } ;

Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
          | Annotation
          | "1"
          ;

Annotation = "{" NAME "}" ;

Notes:

• Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s.
• NAME is a sequence of non-blank printable ASCII characters not containing { or }.
• 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, “new users per day” can be represented as 1/d or {new-users}/d (and a metric value 5 would mean “5 new users). Alternatively, “thousands of page views per day” would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean “5300 page views per day”).
• % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means “3 percent”).
• 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means “3 percent”).

description: String

A detailed description of the metric, which can be used in documentation.

display_name: String

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example “Request count”. This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

metadata: Option<MetricDescriptorMetadata>

Optional. Metadata which can be used to guide usage of the metric.

launch_stage: LaunchStage

Optional. The launch stage of the metric definition.

monitored_resource_types: Vec<String>

Read-only. If present, then a [time series][google.monitoring.v3.TimeSeries], which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

Implementations

impl MetricDescriptor

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_type<T: Into<String>>(self, v: T) -> Self

Sets the value of r#type.

pub fn set_metric_kind<T: Into<MetricKind>>(self, v: T) -> Self

Sets the value of metric_kind.

pub fn set_value_type<T: Into<ValueType>>(self, v: T) -> Self

Sets the value of value_type.

pub fn set_unit<T: Into<String>>(self, v: T) -> Self

Sets the value of unit.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_metadata<T: Into<Option<MetricDescriptorMetadata>>>( self, v: T, ) -> Self

Sets the value of metadata.

pub fn set_launch_stage<T: Into<LaunchStage>>(self, v: T) -> Self

Sets the value of launch_stage.

pub fn set_labels<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<LabelDescriptor>,

Sets the value of labels.

pub fn set_monitored_resource_types<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of monitored_resource_types.

Trait Implementations

impl Clone for MetricDescriptor

fn clone(&self) -> MetricDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricDescriptor

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

Formats the value using the given formatter.

impl Default for MetricDescriptor

fn default() -> MetricDescriptor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricDescriptor

where MetricDescriptor: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for MetricDescriptor

fn typename() -> &'static str

The typename of this message.

impl PartialEq for MetricDescriptor

fn eq(&self, other: &MetricDescriptor) -> 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 MetricDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetricDescriptor