Struct google_logging2::MetricDescriptor [−][src]
pub struct MetricDescriptor { pub display_name: Option<String>, pub description: Option<String>, pub metric_kind: Option<String>, pub value_type: Option<String>, pub labels: Option<Vec<LabelDescriptor>>, pub name: Option<String>, pub type_: Option<String>, pub unit: Option<String>, pub metadata: Option<MetricDescriptorMetadata>, }
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.
This type is not used in any activity, and only used as part of another schema.
Fields
display_name: Option<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.
description: Option<String>
A detailed description of the metric, which can be used in documentation.
metric_kind: Option<String>
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: Option<String>
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
labels: Option<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.
name: Option<String>
The resource name of the metric descriptor.
type_: Option<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"
unit: Option<String>
The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (103) M mega (106) G giga (109) T tera (1012) P peta (1015) E exa (1018) Z zetta (1021) Y yotta (1024) 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 (210) Mi mebi (220) Gi gibi (230) Ti tebi (240)GrammarThe grammar also includes these connectors: / division (as an infix operator, e.g. 1/s). . multiplication (as an infix operator, e.g. GBy.d)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 and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'. 1 represents dimensionless value 1, such as in 1/s. % represents dimensionless value 1/100, and annotates values giving a percentage.
metadata: Option<MetricDescriptorMetadata>
Optional. Metadata which can be used to guide usage of the metric.
Trait Implementations
impl Default for MetricDescriptor
[src]
impl Default for MetricDescriptor
fn default() -> MetricDescriptor
[src]
fn default() -> MetricDescriptor
Returns the "default value" for a type. Read more
impl Clone for MetricDescriptor
[src]
impl Clone for MetricDescriptor
fn clone(&self) -> MetricDescriptor
[src]
fn clone(&self) -> MetricDescriptor
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for MetricDescriptor
[src]
impl Debug for MetricDescriptor
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Part for MetricDescriptor
[src]
impl Part for MetricDescriptor
Auto Trait Implementations
impl Send for MetricDescriptor
impl Send for MetricDescriptor
impl Sync for MetricDescriptor
impl Sync for MetricDescriptor