Logger
(
name
,
client
,
*
,
labels
=
None
,
resource
=
Resource
(
type
=
"global"
,
labels
=
{}))
Loggers represent named targets for log entries.
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs
Properties
client
Clent bound to the logger.
full_name
Fully-qualified name used in logging APIs
path
URI path for use in logging APIs
project
Project bound to the logger.
Methods
Logger
Logger
(
name
,
client
,
*
,
labels
=
None
,
resource
=
Resource
(
type
=
"global"
,
labels
=
{}))
name
str
The name of the logger.
client
logging_v2.client.Client
A client which holds credentials and project configuration for the logger (which requires a project).
resource
logging_v2.Resource
a monitored resource object representing the resource the code was run on.
labels
Optional[dict]
Mapping of default labels for entries written via this logger.
batch
batch
(
*
,
client
=
None
)
Return a batch to use as a context manager.
client
Union[None, logging_v2.client.Client
]
The client to use. If not passed, falls back to the client
stored on the current sink.
Batch
delete
delete
(
logger_name
=
None
,
*
,
client
=
None
)
Delete all entries in a logger via a DELETE request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs/delete
logger_name
Optional[str]
The resource name of the log to delete: :: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" [LOG_ID]
must be URL-encoded. For example, "projects/my-project-id/logs/syslog"
, "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"
. If not passed, defaults to the project bound to the client.
client
Optional[ logging_v2.client.Client
]
The client to use. If not passed, falls back to the client
stored on the current logger.
list_entries
list_entries
(
*
,
resource_names
=
None
,
filter_
=
None
,
order_by
=
None
,
page_size
=
None
,
page_token
=
None
)
Return a page of log entries.
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list
resource_names
Optional[Sequence[str]]
Names of one or more parent resources from 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 client.
filter_
Optional[str]
a filter expression. See https://cloud.google.com/logging/docs/view/advanced_filters By default, a 24 hour filter is applied.
order_by
Optional[str]
One of :data: logging_v2.ASCENDING
or :data: logging_v2.DESCENDING
.
page_size
Optional[int]
Optional. The maximum number of entries in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API.
page_token
Optional[str]
Optional. If present, return the next batch of entries, using the value, which must correspond to the nextPageToken
value returned in the previous response. Deprecated: use the pages
property of the returned iterator instead of manually passing the token.
log_empty
log_empty
(
*
,
client
=
None
,
**
kw
)
Log an empty message via a POST request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write
kw
Optional[dict]
additional keyword arguments for the entry. See logging_v2.entries.LogEntry
.
client
Optional[ logging_v2.client.Client
]
The client to use. If not passed, falls back to the client
stored on the current sink.
log_proto
log_proto
(
message
,
*
,
client
=
None
,
**
kw
)
Log a protobuf message via a POST request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list
kw
Optional[dict]
additional keyword arguments for the entry. See logging_v2.entries.LogEntry
.
message
google.protobuf.message.Message
The protobuf message to be logged.
client
Optional[ logging_v2.client.Client
]
The client to use. If not passed, falls back to the client
stored on the current sink.
log_struct
log_struct
(
info
,
*
,
client
=
None
,
**
kw
)
Log a structured message via a POST request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write
kw
Optional[dict]
additional keyword arguments for the entry. See logging_v2.entries.LogEntry
.
info
dict
the log entry information
client
Optional[ logging_v2.client.Client
]
The client to use. If not passed, falls back to the client
stored on the current sink.
log_text
log_text
(
text
,
*
,
client
=
None
,
**
kw
)
Log a text message via a POST request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write
kw
Optional[dict]
additional keyword arguments for the entry. See logging_v2.entries.LogEntry
.
text
str
the log message
client
Optional[ logging_v2.client.Client
]
The client to use. If not passed, falls back to the client
stored on the current sink.
