Skip to content

Latest commit

 

History

History

alerts-client

README.rst

Google Stackdriver Alerting API Python Samples

https://gstatic.com/cloudssh/images/open-btn.png

This directory contains samples for Google Stackdriver Alerting 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's Alerting API allows you to create, delete, and make back up copies of your alert policies.

To run the sample, you need to enable the API at: https://console.cloud.google.com/apis/library/monitoring.googleapis.com

To run the sample, you need to have Monitoring Admin role.

Please visit [the Cloud Console UI of this API](https://console.cloud.google.com/monitoring) and [create a new Workspace with the same name of your Cloud project](https://cloud.google.com/monitoring/workspaces/create).

Setup

Authentication

This sample requires you to have authentication setup. Refer to the Authentication Getting Started Guide for instructions on setting up credentials for applications.

Install Dependencies

  1. Clone python-docs-samples and change directory to the sample directory you want to use.

    $ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

  2. Install pip and virtualenv if you do not already have them. You may want to refer to the Python Development Environment Setup Guide for Google Cloud Platform for instructions.

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

    $ virtualenv env
$ source env/bin/activate

  4. Install the dependencies needed to run the samples.

    $ pip install -r requirements.txt

Samples

Snippets

https://gstatic.com/cloudssh/images/open-btn.png

To run this sample:

$ python snippets.py

usage: snippets.py [-h]
                   {list-alert-policies,list-notification-channels,enable-alert-policies,disable-alert-policies,replace-notification-channels,backup,restore}
                   ...

Demonstrates AlertPolicy API operations.

positional arguments:
  {list-alert-policies,list-notification-channels,enable-alert-policies,disable-alert-policies,replace-notification-channels,backup,restore}
    list-alert-policies
    list-notification-channels
    enable-alert-policies
                        Enable or disable alert policies in a project.
                        Arguments: project_name (str) enable (bool): Enable or
                        disable the policies. filter_ (str, optional): Only
                        enable/disable alert policies that match this filter_.
                        See
                        https://cloud.google.com/monitoring/api/v3/sorting-
                        and-filtering
    disable-alert-policies
                        Enable or disable alert policies in a project.
                        Arguments: project_name (str) enable (bool): Enable or
                        disable the policies. filter_ (str, optional): Only
                        enable/disable alert policies that match this filter_.
                        See
                        https://cloud.google.com/monitoring/api/v3/sorting-
                        and-filtering
    replace-notification-channels
    backup
    restore

optional arguments:
  -h, --help            show this help message and exit

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.