Logger(name, client, labels=None)Loggers represent named targets for log entries.
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs
Parameters | |
|---|---|
| Name | Description |
name |
str
the name of the logger |
client |
Client
A client which holds credentials and project configuration for the logger (which requires a project). |
labels |
dict
(optional) mapping of default labels for entries written via this logger. |
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
batch
batch(client=None)Return a batch to use as a context manager.
| Parameter | |
|---|---|
| Name | Description |
client |
Client or
the client to use. If not passed, falls back to the |
| Returns | |
|---|---|
| Type | Description |
| A batch to use as a context manager. |
delete
delete(client=None)API call: delete all entries in a logger via a DELETE request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs/delete
| Parameter | |
|---|---|
| Name | Description |
client |
Client or
the client to use. If not passed, falls back to the |
list_entries
list_entries(
projects=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
| Parameters | |
|---|---|
| Name | Description |
projects |
list of strings
project IDs to include. If not passed, defaults to the project bound to the client. |
filter_ |
str
a filter expression. See https://cloud.google.com/logging/docs/view/advanced_filters |
order_by |
str
One of :data: |
page_size |
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 |
str
Optional. If present, return the next batch of entries, using the value, which must correspond to the |
| Returns | |
|---|---|
| Type | Description |
| Iterator of log entries accessible to the current logger. See LogEntry. |
log_empty
log_empty(client=None, **kw)API call: log an empty message via a POST request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write
| Parameters | |
|---|---|
| Name | Description |
kw |
dict
(optional) additional keyword arguments for the entry. See LogEntry. |
client |
Client or
the client to use. If not passed, falls back to the |
log_proto
log_proto(message, client=None, **kw)API call: log a protobuf message via a POST request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list
| Parameters | |
|---|---|
| Name | Description |
kw |
dict
(optional) additional keyword arguments for the entry. See LogEntry. |
message |
The protobuf message to be logged. |
client |
Client or
the client to use. If not passed, falls back to the |
log_struct
log_struct(info, client=None, **kw)API call: log a structured message via a POST request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write
| Parameters | |
|---|---|
| Name | Description |
kw |
dict
(optional) additional keyword arguments for the entry. See LogEntry. |
info |
dict
the log entry information |
client |
Client or
the client to use. If not passed, falls back to the |
log_text
log_text(text, client=None, **kw)API call: log a text message via a POST request
See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write
| Parameters | |
|---|---|
| Name | Description |
kw |
dict
(optional) additional keyword arguments for the entry. See LogEntry. |
text |
str
the log message. |
client |
Client or
the client to use. If not passed, falls back to the |