As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Python Client for Monitoring Dashboards

Monitoring Dashboards: are one way for you to view and analyze metric data. The Cloud Console provides predefined dashboards that require no setup or configuration. You can also define custom dashboards. With custom dashboards, you have complete control over the charts that are displayed and their configuration.

• 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 Monitoring Dashboards.

4. Setup Authentication.

Installation

Install this library in a virtual environment using venv. venv is a tool that creates isolated Python environments. These isolated environments can have separate versions of Python packages, which allows you to isolate one project’s dependencies from the dependencies of other projects.

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

Code samples and snippets

Code samples and snippets live in the samples/ folder.

Supported Python Versions

Our client libraries are compatible with all current active and maintenance versions of Python.

Python >= 3.7

Unsupported Python Versions

Python <= 3.6

If you are using an end-of-life version of Python, we recommend that you update as soon as possible to an actively supported version.

Mac/Linux

python3 -m venv <your-env>
source <your-env>/bin/activate
pip install google-cloud-monitoring-dashboards

Windows

py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-monitoring-dashboards

Next Steps

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

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

• View this README to see the full list of Cloud APIs that we cover.

Note

Because this client uses grpc library, it is safe to share instances across threads. In multiprocessing scenarios, the best practice is to create client instances after the invocation of os.fork() by multiprocessing.pool.Pool or multiprocessing.Process.

API Reference

• Services for Google Cloud Monitoring Dashboard v1 API
  • DashboardsService
• Types for Google Cloud Monitoring Dashboard v1 API

Changelog

For a list of all google-cloud-monitoring-dashboards releases:

• Changelog
  • 2.16.1 (2024-11-11)
  • 2.16.0 (2024-10-24)
  • 2.15.3 (2024-07-30)
  • 2.15.2 (2024-07-08)
  • 2.15.1 (2024-03-05)
  • 2.15.0 (2024-02-22)
  • 2.14.1 (2024-02-06)
  • 2.14.0 (2024-02-01)
  • 2.13.0 (2023-12-07)
  • 2.12.3 (2023-11-15)
  • 2.12.2 (2023-07-04)
  • 2.12.1 (2023-03-23)
  • 2.12.0 (2023-02-16)
  • 2.11.1 (2023-01-20)
  • 2.11.0 (2023-01-12)
  • 2.10.0 (2023-01-10)
  • 2.9.0 (2022-12-14)
  • 2.8.0 (2022-10-27)
  • 2.7.4 (2022-10-10)
  • 2.7.3 (2022-10-03)
  • 2.7.2 (2022-08-11)
  • 2.7.1 (2022-07-13)
  • 2.7.0 (2022-07-06)
  • 2.6.1 (2022-06-06)
  • 2.6.0 (2022-05-05)
  • 2.5.1 (2022-03-05)
  • 2.5.0 (2022-02-11)
  • 2.4.1 (2021-11-01)
  • 2.4.0 (2021-10-14)
  • 2.3.0 (2021-10-08)
  • 2.2.4 (2021-09-30)
  • 2.2.3 (2021-09-24)
  • 2.2.2 (2021-07-26)
  • 2.2.1 (2021-07-14)
  • 2.2.0 (2021-07-09)
  • 2.1.0 (2021-05-22)
  • 2.0.0 (2021-02-11)
  • 1.0.0 (2020-05-19)
  • 0.1.0 (2020-01-15)