• Parameters

  • project (Optional[str]) – the project which the client acts on behalf of.If not passed, falls back to the default inferredfrom the environment.

  • credentials (Optional[google.auth.credentials.Credentials]) – Thehe OAuth2 Credentials to use for thisclient. If not passed (and if no_http object ispassed), falls back to the default inferred from theenvironment.

  • _http (Optional[requests.Session]) – HTTP object to make requests.Can be any object that definesrequest() with the same interface asrequests.Session.request(). If not passed, an_http object is created that is bound to thecredentials for the current object.This parameter should be considered private, and couldchange in the future.

  • _use_grpc (Optional[bool]) – Explicitly specifies whetherto use the gRPC transport or HTTP. If unset,falls back to theGOOGLE_CLOUD_DISABLE_GRPCenvironment variableThis parameter should be considered private, and couldchange in the future.

  • client_info (Optional[Union[google.api_core.client_info.ClientInfo, *[google.api_core.gapic_v1.client_info.ClientInfo](https://googleapis.dev/python/google-api-core/latest/client_info.html#google.api_core.gapic_v1.client_info.ClientInfo)]*]) – The client info used to send a user-agent string along with APIrequests. IfNone, then default info will be used. Generally,you only need to set this if you’re developing your own libraryor partner tool.

  • client_options (Optional[Union[dict, *[google.api_core.client_options.ClientOptions](https://googleapis.dev/python/google-api-core/latest/client_options.html#google.api_core.client_options.ClientOptions)]*]) – Client options used to set user optionson the client. API Endpoint should be set through client_options.

SCOPE(: Optional[Tuple[str, ...] = ('https://www.googleapis.com/auth/logging.read', 'https://www.googleapis.com/auth/logging.write', 'https://www.googleapis.com/auth/logging.admin', 'https://www.googleapis.com/auth/cloud-platform' )

The scopes required for authenticating as a Logging consumer.

get_default_handler(**kw)

Return the default logging handler based on the local environment.

• Parameters

  kw (dict) – keyword args passed to handler constructor

• Returns

  The default log handler based on the environment

• Return type

  logging.Handler

list_entries(*, resource_names=None, filter_=None, order_by=None, max_results=None, page_size=None, page_token=None)

Return a generator of log entry resources.

• Parameters

  • resource_names (Sequence[str]) – Names of one or more parent resourcesfrom which to retrieve log entries:

    "projects/[PROJECT_ID]""organizations/[ORGANIZATION_ID]""billingAccounts/[BILLING_ACCOUNT_ID]""folders/[FOLDER_ID]"

    If not passed, defaults to the project bound to the API’s client.

  • filter (str) – a filter expression. Seehttps://cloud.google.com/logging/docs/view/advanced_filters

  • order_by (str) – orDESCENDING.

  • max_results (Optional[int]) – Optional. The maximum number of entries to return.Non-positive values are treated as 0. If None, uses API defaults.

  • page_size (int) – number of entries to fetch in each API call. Althoughrequests are paged internally, logs are returned by the generatorone at a time. If not passed, defaults to a value set by the API.

  • page_token (str) – opaque marker for the starting “page” of entries. If notpassed, the API will return the first page of entries.

• Returns

  Generator[~logging_v2.LogEntry]

list_metrics(*, max_results=None, page_size=None, page_token=None)

List metrics for the project associated with this client.

Seehttps://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics/list

• Parameters

  • max_results (Optional[int]) – Optional. The maximum number of entries to return.Non-positive values are treated as 0. If None, uses API defaults.

  • page_size (int) – number of entries to fetch in each API call. Althoughrequests are paged internally, logs are returned by the generatorone at a time. If not passed, defaults to a value set by the API.

  • page_token (str) – opaque marker for the starting “page” of entries. If notpassed, the API will return the first page of entries.

• Returns

  Generator[logging_v2.Metric]

list_sinks(*, parent=None, max_results=None, page_size=None, page_token=None)

List sinks for the a parent resource.

Seehttps://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/list

• Parameters

  • parent (Optional[str]) – The parent resource whose sinks are to be listed:

    "projects/[PROJECT_ID]""organizations/[ORGANIZATION_ID]""billingAccounts/[BILLING_ACCOUNT_ID]""folders/[FOLDER_ID]".

    If not passed, defaults to the project bound to the API’s client.

  • max_results (Optional[int]) – Optional. The maximum number of entries to return.Non-positive values are treated as 0. If None, uses API defaults.

  • page_size (int) – number of entries to fetch in each API call. Althoughrequests are paged internally, logs are returned by the generatorone at a time. If not passed, defaults to a value set by the API.

  • page_token (str) – opaque marker for the starting “page” of entries. If notpassed, the API will return the first page of entries.

• Returns

  Generator[~logging_v2.Sink]

logger(name, *, labels=None, resource=None)

Creates a logger bound to the current client.

• Parameters

  • name (str) – The name of the logger to be constructed.

  • resource (Optional[Resource]) – a monitored resource objectrepresenting the resource the code was run on. If not given, willbe inferred from the environment.

  • labels (Optional[dict]) – Mapping of default labels for entries writtenvia this logger.

• Returns

  Logger created with the current client.

• Return type

  Logger

property logging_api()

Helper for logging-related API calls.

Seehttps://cloud.google.com/logging/docs/reference/v2/rest/v2/entrieshttps://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs

metric(name, *, filter_=None, description='')

Creates a metric bound to the current client.

• Parameters

  • name (str) – The name of the metric to be constructed.

  • filter (Optional[str]) – The advanced logs filter expression defining theentries tracked by the metric. If notpassed, the instance should already exist, to berefreshed viaMetric.reload().

  • description (Optional[str]) – The description of the metric to be constructed.If not passed, the instance should already exist,to be refreshed viaMetric.reload().

• Returns

  Metric created with the current client.

• Return type

  Metric

property metrics_api()

Helper for log metric-related API calls.

Seehttps://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics

setup_logging(*, log_level=20, excluded_loggers=('google.cloud', 'google.auth', 'google_auth_httplib2', 'google.api_core.bidi', 'werkzeug'), **kw)

Attach default Cloud Logging handler to the root logger.

This method uses the default log handler, obtained byget_default_handler(), and attaches it to the root Pythonlogger, so that a call such aslogging.warn, as well as all childloggers, will report to Cloud Logging.

• Parameters

  • log_level (Optional[int]) – Python logging log level. Defaults tologging.INFO.

  • excluded_loggers (Optional[Tuple[str]]) – The loggers to not attach thehandler to. This will always include theloggers in the path of the logging clientitself.

• Returns

  keyword args passed to handler constructor

• Return type

  dict

sink(name, *, filter_=None, destination=None)

Creates a sink bound to the current client.

• Parameters

  • name (str) – the name of the sink to be constructed.

  • filter (Optional[str]) – the advanced logs filter expressiondefining the entries exported by the sink. If notpassed, the instance should already exist, to berefreshed viaSink.reload().

  • destination (str) – destination URI for the entries exported bythe sink. If not passed, the instance shouldalready exist, to be refreshed viaSink.reload().

• Returns

  Sink created with the current client.

• Return type

  Sink

property sinks_api()

Helper for log sink-related API calls.

Seehttps://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks