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.

.. _Google Stackdriver Monitoring API: https://cloud.google.com/monitoring/docs/

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:

#. When running locally, use the `Google Cloud SDK`_

.. code-block:: bash

#. 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`_.

#. 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:

.. code-block:: bash

.. _Application Default Credentials: https://cloud.google.com/docs/authentication#getting_credentials_for_server-centric_flow

.. _additional scopes: https://cloud.google.com/compute/docs/authentication#using

.. _Service Account key file: https://developers.google.com/identity/protocols/OAuth2ServiceAccount#creatinganaccount

Install Dependencies

#. Install `pip`_ and `virtualenv`_ if you do not already have them.

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

.. code-block:: bash

#. Install the dependencies needed to run the samples.

.. code-block:: bash

.. _pip: https://pip.pypa.io/

.. _virtualenv: https://virtualenv.pypa.io/

Samples

Quickstart

To run this sample:

.. code-block:: bash

Snippets

To run this sample:

.. code-block:: bash

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`_.

.. _Google Cloud SDK: https://cloud.google.com/sdk/

# This file is used to generate README.rst

product:

name: Google Stackdriver Monitoring API

short_name: Stackdriver Monitoring API

url: https://cloud.google.com/monitoring/docs/

description: >

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:

- auth

- install_deps

samples:

- name: Quickstart

file: quickstart.py

- name: Snippets

file: snippets.py

show_help: true

cloud_client_library: true

from google.cloud import monitoring

def run_quickstart():

client = monitoring.Client()

resource = client.resource(

type_='gce_instance',

labels={

'instance_id': '1234567890123456789',

'zone': 'us-central1-f',

}

)

metric = client.metric(

type_='custom.googleapis.com/my_metric',

labels={

'status': 'successful',

}

)

client.write_point(metric, resource, 3.14)

print('Successfully wrote time series.')

if __name__ == '__main__':

run_quickstart()

import quickstart

def test_quickstart(capsys):

quickstart.run_quickstart()

out, _ = capsys.readouterr()

assert 'wrote' in out