MonitoringMetricDescriptor

Property Value
Google Cloud Service Name Cloud Monitoring
Google Cloud Service Documentation /monitoring/docs/
Google Cloud REST Resource Name v3.projects.metricDescriptors
Google Cloud REST Resource Documentation /monitoring/api/ref_v3/rest/v3/projects.metricDescriptors
Config Connector Resource Short Names gcpmonitoringmetricdescriptor
gcpmonitoringmetricdescriptors
monitoringmetricdescriptor
Config Connector Service Name monitoring.googleapis.com
Config Connector Resource Fully Qualified Name monitoringmetricdescriptors.monitoring.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Spec

Schema

  description: string
  displayName: string
  labels:
  - description: string
    key: string
    valueType: string
  launchStage: string
  metadata:
    ingestDelay: string
    launchStage: string
    samplePeriod: string
  metricKind: string
  projectRef:
    external: string
    name: string
    namespace: string
  type: string
  unit: string
  valueType: string
Fields

description

Optional

string

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

displayName

Optional

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.

labels

Optional

list (object)

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.

labels.[]

Optional

object

labels.[].description

Optional

string

A human-readable description for the label.

labels.[].key

Optional

string

The key for this label. The key must meet the following criteria: * Does not exceed 100 characters. * Matches the following regular expression: `[a-zA-Z][a-zA-Z0-9_]*` * The first character must be an upper- or lower-case letter. * The remaining characters must be letters, digits, or underscores.

labels.[].valueType

Optional

string

The type of data that can be assigned to the label. Possible values: STRING, BOOL, INT64

launchStage

Optional

string

Optional. The launch stage of the metric definition. Possible values: LAUNCH_STAGE_UNSPECIFIED, UNIMPLEMENTED, PRELAUNCH, EARLY_ACCESS, ALPHA, BETA, GA, DEPRECATED

metadata

Optional

object

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

metadata.ingestDelay

Optional

string

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

metadata.launchStage

Optional

string

Deprecated. Must use the `MetricDescriptor.launch_stage` instead. Possible values: LAUNCH_STAGE_UNSPECIFIED, UNIMPLEMENTED, PRELAUNCH, EARLY_ACCESS, ALPHA, BETA, GA, DEPRECATED

metadata.samplePeriod

Optional

string

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

metricKind

Required

string

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. Possible values: METRIC_KIND_UNSPECIFIED, GAUGE, DELTA, CUMULATIVE

projectRef

Required

object

The Project that this resource belongs to.

projectRef.external

Optional

string

The project for the resource

projectRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

projectRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

type

Required

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

Optional

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 may 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 may 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 (https://en.wikipedia.org/wiki/Dimensionless_quantity) 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").

valueType

Required

string

Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. Possible values: STRING, BOOL, INT64

Status

Schema

  conditions:
  - lastTransitionTime: string
    message: string
    reason: string
    status: string
    type: string
  monitoredResourceTypes:
  - string
  observedGeneration: integer
  selfLink: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions.[]

object

conditions.[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions.[].message

string

Human-readable message indicating details about last transition.

conditions.[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions.[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions.[].type

string

Type is the type of the condition.

monitoredResourceTypes

list (string)

Read-only. If present, then a , that is associated with this metric type can only be associated with one of the monitored resource types listed here.

monitoredResourceTypes.[]

string

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

selfLink

string

The resource name of the metric descriptor.

Sample YAML(s)

Typical Use Case

  # Copyright 2021 Google LLC
  #
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  #
  #     http://www.apache.org/licenses/LICENSE-2.0
  #
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  
  apiVersion: monitoring.cnrm.cloud.google.com/v1beta1
  kind: MonitoringMetricDescriptor
  metadata:
    name: monitoringmetricdescriptor-sample
  spec:
    labels:
    - key: system_stable
      valueType: BOOL
      description: True if the estimation system is stable.
    - key: condition_summary
      valueType: STRING
      description: A description of the condition the market system is in.
    launchStage: BETA
    metadata:
      ingestDelay: 1000s
      samplePeriod: 100s
    metricKind: GAUGE
    type: custom.googleapis.com/market/measurements/volume
    unit: "{USD}/h"
    valueType: DISTRIBUTION
    description: Tracks a combination of estimates of trade volume for a given resource, in $USD per hour.
    displayName: Trading Volume Estimate