google_api_service_user v0.8.0 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.t): A detailed description of the metric, which can be used in documentation. Defaults to: null.
  • displayName (String.t): 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. Defaults to: null.
  • labels ([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.
  • launchStage (String.t): Optional. The launch stage of the metric definition. Defaults to: null.

    • Enum - one of [LAUNCH_STAGE_UNSPECIFIED, EARLY_ACCESS, ALPHA, BETA, GA, DEPRECATED]
  • metadata (MetricDescriptorMetadata): Optional. Metadata which can be used to guide usage of the metric. Defaults to: null.
  • metricKind (String.t): 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.t): The resource name of the metric descriptor. Defaults to: null.
  • type (String.t): 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" Defaults to: null.
  • unit (String.t): 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 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. Defaults to: null.
  • valueType (String.t): 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]

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.ServiceUser.V1.Model.MetricDescriptor{
  description: any(),
  displayName: any(),
  labels: [GoogleApi.ServiceUser.V1.Model.LabelDescriptor.t()],
  launchStage: any(),
  metadata: GoogleApi.ServiceUser.V1.Model.MetricDescriptorMetadata.t(),
  metricKind: any(),
  name: any(),
  type: any(),
  unit: any(),
  valueType: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.