Introduction to the Stackdriver Monitoring API

The Stackdriver Monitoring API v3 gives you access to over 900 Monitoring metrics from Google Cloud Platform and Amazon Web Services. You can create your own custom metrics and can organize your cloud resources using groups.

For the API reference documentation, see Stackdriver Monitoring API.

API resources

Metrics

For an introduction to metric concepts and the data structures that represent them, see Metrics, Time Series, and Resources.

To learn how to manage your custom metrics and the built-in metrics, see Using Custom Metrics.

For a complete list of available metrics, see Metrics List.

Monitored resources

A monitored resource is something about which metrics are collected. For example, you might be interested in the activity of a VM instance or a piece of hardware.

For a list of the available monitored resources, see the Monitored Resource List.

Monitored resource groups

A group is a dynamic collection of monitored resources. You have always been able to create groups manually in Monitoring, but the v3 API allows you to write code that creates and uses groups.

For more information, see the Group collection in the API.

Alerting policies

An alerting policy is a configuration resource that describes the criteria for generating incidents and how to notify you when those incidents are created. Alerting concepts explains the basic concepts of alerting policies. For more information, see the AlertPolicy reference.

The API also lets you create alerting policies based on a ratio of two metrics. Ratios cannot currently be created through the Monitoring console. For more information, see MetricThreshold in the AlertPolicy reference.

Notification channels

A notification channel is a configuration resource that describes how to notify you when incidents occur. Notification channels can reference a variety of different kinds of communication services and endpoints; these are specified in descriptors. The descriptors determine the set of configuration parameters that are included in a channel object.

For more information, see the NotificationChannel reference and the NotificationChannelDescriptor reference.

API concepts

Filters

The v3 API uses filters to select metrics, to fetch time-series data, and to collect monitored resources into groups. For more information, see Monitoring Filters.

The v3 API also uses filters to restrict the result set of certain list operations. See Sorting and Filtering for details on managing the results of the projects.alertPolicies.list and projects.notificationChannels.list methods.

Users of the v2 API

The Cloud Monitoring API v2 was turned down in August, 2017 in favor of the Monitoring API v3.

Next Steps

Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Monitoring