Struct google_monitoring3::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 type_: Option<String>,
    pub unit: Option<String>,
    pub name: Option<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.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

Fields

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.

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

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

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

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.

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "appengine.googleapis.com/http/server/response_latencies"

Optional. The unit in which the metric value is reported. For example, kBy/s means kilobytes/sec, and 1 is the dimensionless unit. The supported units are a subset of The Unified Code for Units of Measure standard (http://unitsofmeasure.org/ucum.html).

This field is part of the metric's documentation, but it is ignored by Stackdriver.

The resource name of the metric descriptor.

Trait Implementations

impl Default for MetricDescriptor
[src]

Returns the "default value" for a type. Read more

impl Clone for MetricDescriptor
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Debug for MetricDescriptor
[src]

Formats the value using the given formatter. Read more

impl RequestValue for MetricDescriptor
[src]

impl ResponseResult for MetricDescriptor
[src]

Auto Trait Implementations