Skip to content

Latest commit

 

History

History
 
 

README.rst

Google Stackdriver Monitoring API Python Samples

This directory contains samples for Google Stackdriver Monitoring API. Stackdriver Monitoring collects metrics, events, and metadata from Google Cloud Platform, Amazon Web Services (AWS), hosted uptime probes, application instrumentation, and a variety of common application components including Cassandra, Nginx, Apache Web Server, Elasticsearch
and many others. Stackdriver ingests that data and generates insights via dashboards, charts, and alerts.

Setup

Authentication

Authentication is typically done through Application Default Credentials, which means you do not have to change the code to authenticate as long as your environment has credentials. You have a few options for setting up authentication:

  1. When running locally, use the Google Cloud SDK

    gcloud beta auth application-default login
  2. When running on App Engine or Compute Engine, credentials are already set-up. However, you may need to configure your Compute Engine instance with additional scopes.

  3. You can create a Service Account key file. This file can be used to authenticate to Google Cloud Platform services from any environment. To use the file, set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the path to the key file, for example:

    export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json

Install Dependencies

  1. Install pip and virtualenv if you do not already have them.

  2. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.

    $ virtualenv env
    $ source env/bin/activate
  3. Install the dependencies needed to run the samples.

    $ pip install -r requirements.txt

Samples

Quickstart

To run this sample:

$ python quickstart.py

Snippets

To run this sample:

$ python snippets.py

usage: snippets.py [-h] [--project_id PROJECT_ID]
                   {create-metric-descriptor,list-metric-descriptors,delete-metric-descriptor,list-resources,get-resource,write-time-series,list-time-series,list-time-series-header,list-time-series-reduce,list-time-series-aggregate}
                   ...

Demonstrates Monitoring API operations.

positional arguments:
  {create-metric-descriptor,list-metric-descriptors,delete-metric-descriptor,list-resources,get-resource,write-time-series,list-time-series,list-time-series-header,list-time-series-reduce,list-time-series-aggregate}
    create-metric-descriptor
    list-metric-descriptors
    delete-metric-descriptor
    list-resources
    get-resource
    write-time-series
    list-time-series
    list-time-series-header
    list-time-series-reduce
    list-time-series-aggregate

optional arguments:
  -h, --help            show this help message and exit
  --project_id PROJECT_ID
                        Your cloud project ID.

The client library

This sample uses the `Google Cloud Client Library for Python`_. You can read the documentation for more details on API usage and use GitHub to `browse the source`_ and `report issues`_.