This page describes some of the features of the Stackdriver Monitoring API v3.
For the API reference documentation, see either of the following pages:
API resources
Metrics
The Monitoring API v3 gives you access to over 1,000 Stackdriver Monitoring metrics from Google Cloud and Amazon Web Services. You can create your own custom metrics and can organize your cloud resources using groups.
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 Stackdriver Monitoring, but the Monitoring API v3 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.
Service monitoring
The service monitoring resources are used to set up service-level objectives that can be used to monitor the health of your services.
Service Monitoring adds the following resources to the Monitoring API:
For more information about these service-monitoring concepts and about using the API, see Service monitoring.
API concepts
Filters
The Monitoring API v3 uses filters to select metrics, to fetch time-series data, and to collect monitored resources into groups. For more information, see Monitoring filters.
The Monitoring API v3 also uses filters to restrict the result set of certain list
operations. See Sorting and filtering for details
on managing the results of the alertPolicies.list
and notificationChannels.list methods.
Users of the v2 API
The Cloud Monitoring API v2 was turned down in August, 2017 in favor of the Stackdriver Monitoring API v3.
Next Steps
See the introduction to Metrics, time series, and resources.
See the introduction to Using alerting policies.
See how to call API methods from the API Explorer.
See the client libraries for Stackdriver Monitoring to get started with Stackdriver Monitoring in your language of choice.
See the API reference, Stackdriver Monitoring API (REST) or Stackdriver Monitoring API (gRPC).
