Metrics Scopes: Manages your Cloud Monitoring data and configurations.

• 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 Metrics Scopes.

4. Set up Authentication.

Installation

Install this library in a virtual environment usingvenv.venv is a tool thatcreates isolated Python environments. These isolated environments can have separateversions of Python packages, which allows you to isolate one project’s dependenciesfrom the dependencies of other projects.

Withvenv, it’s possible to install this library without needing systeminstall permissions, and without clashing with the installed systemdependencies.

Code samples and snippets

Code samples and snippets live in thesamples/ folder.

Supported Python Versions

Our client libraries are compatible with all currentactive andmaintenance versions ofPython.

Python >= 3.7

Unsupported Python Versions

Python <= 3.6

If you are using anend-of-lifeversion 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/activatepip install google-cloud-monitoring-metrics-scopes

Windows

py -m venv <your-env>.\<your-env>\Scripts\activatepip install google-cloud-monitoring-metrics-scopes

Next Steps

• Read theClient Library Documentation for Metrics Scopesto see other available methods on the client.

• Read theMetrics Scopes Product documentation to learnmore about the product and see How-to Guides.

• View thisREADME to see the full list of CloudAPIs that we cover.

Logging

This library uses the standard Pythonlogging functionality to log some RPC events that could be of interest for debugging and monitoring purposes.Note the following:

1. Logs may contain sensitive information. Take care torestrict access to the logs if they are saved, whether it be on local storage or on Google Cloud Logging.

2. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking.Do not depend on immutability of the logging events.

3. By default, the logging events from this library are not handled. You mustexplicitly configure log handling using one of the mechanisms below.

Simple, environment-based configuration

To enable logging for this library without any changes in your code, set theGOOGLE_SDK_PYTHON_LOGGING_SCOPE environment variable to a valid Googlelogging scope. This configures handling of logging events (at levellogging.DEBUG or higher) from this library in a default manner, emitting the loggedmessages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any loggingevent.

A logging scope is a period-separated namespace that begins withgoogle, identifying the Python module or package to log.

• Valid logging scopes:google,google.cloud.asset.v1,google.api,google.auth, etc.

• Invalid logging scopes:foo,123, etc.

NOTE: If the logging scope is invalid, the library does not set up any logging handlers.

Environment-Based Examples

• Enabling the default handler for all Google-based loggers

export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google

• Enabling the default handler for a specific Google module (for a client library calledlibrary_v1):

export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1

Advanced, code-based configuration

You can also configure a valid logging scope using Python’s standard logging mechanism.

Code-Based Examples

• Configuring a handler for all Google-based loggers

import loggingfrom google.cloud import library_v1base_logger = logging.getLogger("google")base_logger.addHandler(logging.StreamHandler())base_logger.setLevel(logging.DEBUG)

• Configuring a handler for a specific Google module (for a client library calledlibrary_v1):

import loggingfrom google.cloud import library_v1base_logger = logging.getLogger("google.cloud.library_v1")base_logger.addHandler(logging.StreamHandler())base_logger.setLevel(logging.DEBUG)

Logging details

1. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the rootlogger from the google-level logger. If you need the events to be propagated to the root logger, you must explicitly setlogging.getLogger("google").propagate = True in your code.

2. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration forone library, but decide you need to also set up environment-based logging configuration for another library.

   1. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectualif the code -based configuration gets applied first.

3. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) getexecuted the first timeany client library is instantiated in your application, and only if the affected loggers have not been previously configured.(This is the reason for 2.i. above.)