Python logging
handlers for Stackdriver Logging.
Classes
CloudLoggingHandler
CloudLoggingHandler
(
client
,
name
=
'python'
,
transport
=
< class
'
google
.
cloud
.
logging
.
handlers
.
transports
.
background_thread
.
BackgroundThreadTransport
'>, resource=Resource(type='
global
', labels=
{}
), labels=None, stream=None)
Handler that directly makes Stackdriver logging API calls.
This is a Python standard logging
handler using that can be used to
route Python standard logging messages directly to the Stackdriver
Logging API.
This handler is used when not in GAE or GKE environment.
This handler supports both an asynchronous and synchronous transport.
client
name
str
the name of the custom log in Stackdriver Logging. Defaults to 'python'. The name of the Python logger will be represented in the python_logger
field.
transport
type
Class for creating new transport objects. It should extend from the base .Transport
type and implement :meth .Transport.send
. Defaults to .BackgroundThreadTransport
. The other option is .SyncTransport
.
resource
Resource
(Optional) Monitored resource of the entry, defaults to the global resource type.
labels
dict
(Optional) Mapping of labels for the entry.
stream
file-like object
(optional) stream to be used by the handler. Example: .. code-block:: python import logging import google.cloud.logging from google.cloud.logging.handlers import CloudLoggingHandler client = google.cloud.logging.Client() handler = CloudLoggingHandler(client) cloud_logger = logging.getLogger('cloudLogger') cloud_logger.setLevel(logging.INFO) cloud_logger.addHandler(handler) cloud_logger.error('bad news') # API call
Modules Functions
setup_logging
setup_logging
(
handler
,
excluded_loggers
=
(
"google.cloud"
,
"google.auth"
,
"google_auth_httplib2"
),
log_level
=
20
,
)
Attach a logging handler to the Python root logger
Excludes loggers that this library itself uses to avoid infinite recursion.
handler
logging.handler
the handler to attach to the global handler
excluded_loggers
tuple
(Optional) The loggers to not attach the handler to. This will always include the loggers in the path of the logging client itself.
log_level
int
(Optional) Python logging log level. Defaults to :const: logging.INFO
. Example: .. code-block:: python import logging import google.cloud.logging from google.cloud.logging.handlers import CloudLoggingHandler client = google.cloud.logging.Client() handler = CloudLoggingHandler(client) google.cloud.logging.handlers.setup_logging(handler) logging.getLogger().setLevel(logging.DEBUG) logging.error('bad news') # API call
