google_api_service_user v0.0.1 GoogleApi.ServiceUser.V1.Model.MetricDescriptor View Source
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.
Attributes
- description (String): A detailed description of the metric, which can be used in documentation. Defaults to:
null
. - displayName (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". Defaults to:
null
. - labels (List[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. Defaults to:
null
. metricKind (String): Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. Defaults to:
null
.- Enum - one of [METRIC_KIND_UNSPECIFIED, GAUGE, DELTA, CUMULATIVE]
- name (String): The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the `type` field of this descriptor. For example, following is the resource name of a custom metric within the GCP project `my-project-id`: "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount" Defaults to:
null
. - type (String): 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" Defaults to:
null
. - unit (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 standard: Basic units (UNIT) `bit` bit `By` byte `s` second `min` minute `h` hour `d` day Prefixes (PREFIX) `k` kilo (10**3) `M` mega (106) * `G` giga (109) `T` tera (10**12) `P` peta (1015) * `E` exa (1018) `Z` zetta (10**21) `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 (2**30) `Ti` tebi (240) Grammar* The grammar includes the dimensionless unit `1`, such as `1/s`. The 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 '}'. Defaults to:
null
. valueType (String): Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. Defaults to:
null
.- Enum - one of [VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]