Skip to content

Commit

Permalink
Stackdriver monitoring alerts sample. (#1475)
Browse files Browse the repository at this point in the history
* Stackdriver monitoring alerts sample.

* Lint

* py27 tests pass

* Accomodate reviewer's comments.

* Add spaces around code blocks, Inc => LLC, and add docstring.

* Reformat doc comments to look like Google doc comments.
  • Loading branch information
SurferJeffAtGoogle authored May 15, 2018
1 parent fcb6493 commit 87af05c
Show file tree
Hide file tree
Showing 8 changed files with 612 additions and 0 deletions.
1 change: 1 addition & 0 deletions monitoring/api/v3/alerts-client/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
backup.json
117 changes: 117 additions & 0 deletions monitoring/api/v3/alerts-client/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
.. This file is automatically generated. Do not edit this file directly.
Google Stackdriver Alerting API Python Samples
===============================================================================

.. image:: https://gstatic.com/cloudssh/images/open-btn.png
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=monitoring/api/v3/alerts-client/README.rst


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.




.. _Google Stackdriver Alerting API: https://cloud.google.com/monitoring/alerts/

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.

.. _Authentication Getting Started Guide:
https://cloud.google.com/docs/authentication/getting-started

Install Dependencies
++++++++++++++++++++

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

.. code-block:: bash
$ git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
#. 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.

.. _Python Development Environment Setup Guide:
https://cloud.google.com/python/setup

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

.. code-block:: bash
$ virtualenv env
$ source env/bin/activate
#. Install the dependencies needed to run the samples.

.. code-block:: bash
$ pip install -r requirements.txt
.. _pip: https://pip.pypa.io/
.. _virtualenv: https://virtualenv.pypa.io/

Samples
-------------------------------------------------------------------------------

Snippets
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. image:: https://gstatic.com/cloudssh/images/open-btn.png
:target: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=monitoring/api/v3/alerts-client/snippets.py,monitoring/api/v3/alerts-client/README.rst




To run this sample:

.. code-block:: bash
$ 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
disable-alert-policies
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`_.

.. _Google Cloud Client Library for Python:
https://googlecloudplatform.github.io/google-cloud-python/
.. _browse the source:
https://github.com/GoogleCloudPlatform/google-cloud-python
.. _report issues:
https://github.com/GoogleCloudPlatform/google-cloud-python/issues


.. _Google Cloud SDK: https://cloud.google.com/sdk/
26 changes: 26 additions & 0 deletions monitoring/api/v3/alerts-client/README.rst.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# This file is used to generate README.rst

product:
name: Google Stackdriver Alerting API
short_name: Stackdriver Alerting API
url: https://cloud.google.com/monitoring/alerts/
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's Alerting API allows you to create,
delete, and make back up copies of your alert policies.

setup:
- auth
- install_deps

samples:
- name: Snippets
file: snippets.py
show_help: true

cloud_client_library: true

folder: monitoring/api/v3/alerts-client
2 changes: 2 additions & 0 deletions monitoring/api/v3/alerts-client/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
google-cloud-monitoring==0.29.0
tabulate==0.8.2
Loading

0 comments on commit 87af05c

Please sign in to comment.