Python Client for Stackdriver Monitoring API (Alpha)

image image

Stackdriver Monitoring API: Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.

• Client Library Documentation

• Product Documentation

Quick Start

In order to use this library, you first need to go through the following steps:

1. Select or create a Cloud Platform project.

2. Enable billing for your project.

3. Enable the Stackdriver Monitoring API.

4. Setup Authentication.

Installation

Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With virtualenv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Supported Python Versions

Python >= 3.5

Deprecated Python Versions

Python == 2.7. Python 2.7 support will be removed on January 1, 2020.

Mac/Linux

pip install virtualenv
virtualenv <your-env>
source <your-env>/bin/activate
<your-env>/bin/pip install google-cloud-monitoring

Windows

pip install virtualenv
virtualenv <your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exe install google-cloud-monitoring

Preview

MetricServiceClient

from google.cloud import monitoring_v3
client = monitoring_v3.MetricServiceClient()
name = client.project_path('[PROJECT]')
# Iterate over all results
for element in client.list_monitored_resource_descriptors(name):
 # process element
 pass
# Or iterate over results one page at a time
for page in client.list_monitored_resource_descriptors(name).pages:
 for element in page:
 # process element
 pass

Next Steps

• Read the Client Library Documentation for Stackdriver Monitoring API to see other available methods on the client.

• Read the Product documentation to learn more about the product and see How-to Guides.