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 Google Cloud 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 the units used in the metric lists, see the unit field in the MetricDescriptor reference.

• 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.

• For pricing information, see Monitoring pricing.

external.googleapis.com

Metrics sent to Google Cloud projects 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. There is presently a limit of 10,000 external metric descriptors per Google Cloud project.

Cloud 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 24 months 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 Cloud Operations for GKE, metrics exported by Prometheus are converted to Cloud 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"
}

Other metrics

Metrics from other domains.

The following list was last generated at 2021-05-06 13:46:31 UTC. For more information about this process, see About the lists.

cloudvolumesgcp-api.netapp.com

Metrics from NetApp Cloud Volumes. Launch stages of these metrics: BETA

The "metric type" strings in this table must be prefixed with cloudvolumesgcp-api.netapp.com/. That prefix has been omitted from the entries in the table.

Metric type ^Launch stage Display name
Kind, Type, Unit Monitored resources	Description Labels
cloudvolume/replication_healthy ^BETA Volume Replication Healthy
GAUGE, INT64, 1 cloudvolumesgcp-api.netapp.com/CloudVolume	Values of TRUE for healthy and FALSE for unhealthy replication relationship.
cloudvolume/replication_lag_time ^BETA Volume Replication Transfer Lag Time
GAUGE, INT64, sec cloudvolumesgcp-api.netapp.com/CloudVolume	Elapsed time since the exported snapshot copy (last complete transfer) was created on the destination.
cloudvolume/replication_last_transfer_duration ^BETA Volume Replication Last Transfer Duration
GAUGE, INT64, sec cloudvolumesgcp-api.netapp.com/CloudVolume	Number of seconds of last transfer duration.
cloudvolume/replication_last_transfer_size ^BETA Volume Replication Last Transfer Size
GAUGE, INT64, By cloudvolumesgcp-api.netapp.com/CloudVolume	Number of bytes of last transfer duration.
cloudvolume/replication_relationship_progress ^BETA Volume Replication Transfer Progress
CUMULATIVE, INT64, By cloudvolumesgcp-api.netapp.com/CloudVolume	Amount of data transferred thus far for the current transfer.
cloudvolume/replication_relationship_status ^BETA Volume Replication Status
GAUGE, INT64, 1 cloudvolumesgcp-api.netapp.com/CloudVolume	Status of replication: TRUE = transferring, FALSE = idle.
cloudvolume/replication_total_transfer_bytes ^BETA Volume Replication Total Transfer Bytes
CUMULATIVE, INT64, By cloudvolumesgcp-api.netapp.com/CloudVolume	Total bytes of replication transfer.
cloudvolume_so/logical_bytes_backed_up ^BETA NetApp CVS-SO Logical Bytes Backed Up
GAUGE, INT64, By cloudvolumesgcp-api.netapp.com/CloudVolumeSO	Number of uncompressed/unencrypted bytes (represented by optimized bytes backed up) backed up per volume per metric period.
cloudvolume_so/operation_count ^BETA NetApp CVS-SO Operation Count
DELTA, INT64, 1 cloudvolumesgcp-api.netapp.com/CloudVolumeSO	Number of operations being performed on the cloud volume by the end users. type: Number of operations being performed on the cloud volume by the end users.
cloudvolume_so/read_bytes_count ^BETA NetApp CVS-SO Read Bytes Count
DELTA, INT64, By cloudvolumesgcp-api.netapp.com/CloudVolumeSO	I/O bytes from read operations by the end user.
cloudvolume_so/request_latencies ^BETA NetApp CVS-SO Request Latencies
DELTA, DISTRIBUTION, ms cloudvolumesgcp-api.netapp.com/CloudVolumeSO	Distribution of IO operation latencies, in milliseconds. A measure of responsiveness of the volume. method: Volume IO operation executed.
cloudvolume_so/volume_size ^BETA NetApp CVS-SO Volume Size
GAUGE, INT64, By cloudvolumesgcp-api.netapp.com/CloudVolumeSO	Space allocated to the volume, in bytes. A measure of the actual provisioned size of the volume.
cloudvolume_so/volume_usage ^BETA NetApp CVS-SO Volume Usage
GAUGE, INT64, By cloudvolumesgcp-api.netapp.com/CloudVolumeSO	Space utilized by the volume, in bytes. A measure of the actual size of the volume. type: Space utilized by the volume, in bytes. A measure of the actual size of the volume.
cloudvolume_so/write_bytes_count ^BETA NetApp CVS-SO Write Bytes Count
DELTA, INT64, By cloudvolumesgcp-api.netapp.com/CloudVolumeSO	I/O bytes from write operations by the end user.

netapp.com

Metrics from NetApp. Launch stages of these metrics: ALPHA

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

Metric type ^Launch stage Display name
Kind, Type, Unit Monitored resources	Description Labels
cloudvolume/inode_allocation ^ALPHA Volume inode allocation
GAUGE, INT64, {inode} netapp_cloud_volume	Inode allocated for the volume (hard cap). Tied to allocated capacity (size) of volume. Sampled every 300 seconds.
cloudvolume/inode_usage ^ALPHA Volume inode usage
GAUGE, INT64, {inode} netapp_cloud_volume	Number of inode in use on the volume. Sampled every 300 seconds. type: Type of usage, either logical or snapshot.
cloudvolume/operation_count ^ALPHA Operations count
DELTA, INT64, count netapp_cloud_volume	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 ^ALPHA Bytes read
DELTA, INT64, By netapp_cloud_volume	I/O bytes from read operations by the end user. Sampled every 60 seconds.
cloudvolume/request_latencies ^ALPHA Volume IO operation latency
DELTA, DISTRIBUTION, ms netapp_cloud_volume	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 ^ALPHA Volume space allocation
GAUGE, INT64, By netapp_cloud_volume	Space allocated to the volume, in bytes. A measure of the actual provisioned size of the volume. Sampled every 60 seconds.
cloudvolume/volume_usage ^ALPHA Volume space usage
GAUGE, INT64, By netapp_cloud_volume	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 ^ALPHA Bytes written
DELTA, INT64, By netapp_cloud_volume	I/O bytes from write operations by the end user. Sampled every 60 seconds.

Generated at 2021-05-06 13:46:31 UTC.