External metrics list

This page lists some of the metric types available from open-source projects and other external sources.

• For a general explanation of the entries in the tables, including information about values like DELTA and GAUGE, see Metric types.

  Note: Metric types with values of type STRING can't be retrieved by using the Stackdriver Monitoring console or used in alerting policies. To retrieve string-valued data, you must use a method in the Monitoring API like timeSeries.list.

• For information about statements of the form “Sampled every x seconds” and “After sampling, data is not visible for up to y seconds”, see Additional information: metadata.

• For a set of complete, current lists of supported metric types, see Metrics list.

external.googleapis.com

Metrics sent to Workspaces with a metric type beginning external.googleapis.com are known as external metrics. The metrics are typically exported by open-source projects and third-party providers.

Stackdriver Monitoring treats external metrics the same as custom metrics, with one exception. For external metrics, a resource_type of global is invalid and results in the metric data being discarded.

External metric descriptors that are created but then not used for at least 6 weeks are subject to deletion.

Note: Until an external metric is used in a project, there is no metric descriptor for it. This is also true of custom metrics. Therefore, this page cannot list information about all the possible external metric types. If you use external metrics in your project, you can look at their metric descriptors using the metricDescriptors.list or metricDescriptors.get Monitoring API methods.

prometheus

Metrics whose names begin external.googleapis.com/prometheus/ come from Prometheus, an open-source monitoring tool often used with Kubernetes. When you configure Prometheus with Stackdriver Kubernetes Engine Monitoring, metrics exported by Prometheus are converted to Stackdriver Monitoring metric types with simple metric descriptors, such as the following:

{
  "name": "projects/my-gcp-project/metricDescriptors/external.googleapis.com/prometheus/apiserver_client_certificate_expiration_seconds",
  "metricKind": "CUMULATIVE",
  "valueType": "DISTRIBUTION",
  "description": "Auto-created custom metric.",
  "type": "external.googleapis.com/prometheus/apiserver_client_certificate_expiration_seconds"
}

Note: There is presently a limit of 10,000 Prometheus-exported metric descriptors per GCP project.

Other metrics

Metrics from other domains.

knative

Metrics from Knative. Launch stages of these metrics: BETA

The following metric type names must be prefixed with knative.dev/. That prefix has been omitted from the entries in the table.

Metric type Display name
Kind, Type, Unit Launch stage	Description Labels
serving/activator/request_count Activator Request Count
CUMULATIVE, INT64, 1 BETA	The number of requests that are routed to the activator. Sampled every 60 seconds. response_code_class: One of '1xx', '2xx', '3xx', '4xx', or '5xx' according to response code of the request. If any other code is returned, it should be reported as '5xx'. response_code: (INT64) Response code of the request according to protocol. num_tries: (INT64) The number of tries (retry on 503s only) it takes to get a response from a reserve revision.
serving/activator/request_latencies Activator Request Latencies
CUMULATIVE, DISTRIBUTION, ms BETA	Distribution of service request times in milliseconds for requests that go through the activator. Value is the total time requests spent in activator and revision pods. Sampled every 60 seconds. response_code_class: One of '1xx', '2xx', '3xx', '4xx', or '5xx' according to response code of the request. If any other code is returned, it should be reported as '5xx'. response_code: (INT64) Response code of the request according to protocol.
serving/autoscaler/actual_pods Actual Pod Count
GAUGE, INT64, 1 BETA	Number of pods that are allocated currently. Sampled every 60 seconds.
serving/autoscaler/desired_pods Desired Pod Count
GAUGE, INT64, 1 BETA	Number of pods autoscaler wants to allocate. Sampled every 60 seconds.
serving/autoscaler/panic_mode Panic Mode
GAUGE, INT64, 1 BETA	Set to 1 if autoscaler is in panic mode for the revision, otherwise 0. Sampled every 60 seconds.
serving/autoscaler/panic_request_concurrency Observed Panic Concurrency
GAUGE, DOUBLE, 1 BETA	Average requests concurrency observed per pod during the shorter panic autoscaling window. Sampled every 60 seconds.
serving/autoscaler/requested_pods Requested Pod Count
GAUGE, INT64, 1 BETA	Number of pods autoscaler requested from Kubernetes. Sampled every 60 seconds.
serving/autoscaler/stable_request_concurrency Observed Stable Concurrency
GAUGE, DOUBLE, 1 BETA	Average requests concurrency observed per pod during the stable autoscaling window. Sampled every 60 seconds.
serving/autoscaler/target_concurrency_per_pod Target Concurrency Per Pod
GAUGE, DOUBLE, 1 BETA	The desired average requests concurrency per pod during the stable autoscaling window. Sampled every 60 seconds.
serving/revision/request_count Request Count
CUMULATIVE, INT64, 1 BETA	The number of requests reaching the revision. Sampled every 60 seconds. response_code_class: One of '1xx', '2xx', '3xx', '4xx', or '5xx' according to response code of the request. If any other code is returned, it should be reported as '5xx'. response_code: (INT64) Response code of the request according to protocol.
serving/revision/request_latencies Request Latencies
CUMULATIVE, DISTRIBUTION, ms BETA	Distribution of service request times in milliseconds for requests reaching the revision. Value is the time requests spent in revision pods. Sampled every 60 seconds. response_code_class: One of '1xx', '2xx', '3xx', '4xx', or '5xx' according to response code of the request. If any other code is returned, it should be reported as '5xx'. response_code: (INT64) Response code of the request according to protocol.

netapp.com

Metrics from NetApp. Launch stages of these metrics: ALPHA

The following metric type names must be prefixed with netapp.com/. That prefix has been omitted from the entries in the table.

Metric type Display name
Kind, Type, Unit Launch stage	Description Labels
cloudvolume/operation_count Operations count
DELTA, INT64, count ALPHA	Number of operations being performed on the cloud volume by the end users. Sampled every 60 seconds. type: Type of utilization, either logical or snapshot.
cloudvolume/read_bytes_count Bytes read
DELTA, INT64, By ALPHA	I/O bytes from read operations by the end user. Sampled every 60 seconds.
cloudvolume/request_latencies Volume IO operation latency
DELTA, DISTRIBUTION, ms ALPHA	Distribution of IO operation request latencies, in milliseconds. A measure of responsiveness of the volume. Sampled every 60 seconds. method: NetApp Cloud Volume IO operation.
cloudvolume/volume_size Volume space allocation
GAUGE, INT64, By ALPHA	Space allocated to the volume, in bytes. A measure of the actual provisioned size of the volume. Sampled every 60 seconds.
cloudvolume/volume_usage Volume space usage
GAUGE, INT64, By ALPHA	Space utilized by the volume, in bytes. A measure of the actual size of the volume. Sampled every 60 seconds. type: Type of usage, either logical or snapshot.
cloudvolume/write_bytes_count Bytes written
DELTA, INT64, By ALPHA	I/O bytes from write operations by the end user. Sampled every 60 seconds.

This metric data was last updated at 10/17/19 20:47:48 UTC.