Module entries (3.1.2)

Log entries within the Google Cloud Logging API.

Classes

LogEntry

LogEntry(
    log_name=None,
    labels=None,
    insert_id=None,
    severity=None,
    http_request=None,
    timestamp=None,
    resource=Resource(type="global", labels={}),
    trace=None,
    span_id=None,
    trace_sampled=None,
    source_location=None,
    operation=None,
    logger=None,
    payload=None,
)

Log entry.

Parameters
NameDescription
log_name str

The name of the logger used to post the entry.

labels Optional[dict]

Mapping of labels for the entry

insert_id Optional[str]

The ID used to identify an entry uniquely.

severity Optional[str]

The severity of the event being logged.

http_request Optional[dict]

Info about HTTP request associated with the entry.

timestamp Optional[datetime.datetime]

Timestamp for the entry.

resource Optional[google.cloud.logging_v2.resource.Resource]

Monitored resource of the entry.

trace Optional[str]

Trace ID to apply to the entry.

span_id Optional[str]

Span ID within the trace for the log entry. Specify the trace parameter if span_id is set.

trace_sampled Optional[bool]

The sampling decision of the trace associated with the log entry.

source_location Optional[dict]

Location in source code from which the entry was emitted.

operation Optional[dict]

Additional information about a potentially long-running operation associated with the log entry.

logger logging_v2.logger.Logger See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry

the logger used to write the entry.

ProtobufEntry

ProtobufEntry(
    log_name=None,
    labels=None,
    insert_id=None,
    severity=None,
    http_request=None,
    timestamp=None,
    resource=Resource(type="global", labels={}),
    trace=None,
    span_id=None,
    trace_sampled=None,
    source_location=None,
    operation=None,
    logger=None,
    payload=None,
)

Log entry with protobuf message payload.

Parameters
NameDescription
log_name str

The name of the logger used to post the entry.

labels Optional[dict]

Mapping of labels for the entry

insert_id Optional[str]

The ID used to identify an entry uniquely.

severity Optional[str]

The severity of the event being logged.

http_request Optional[dict]

Info about HTTP request associated with the entry.

timestamp Optional[datetime.datetime]

Timestamp for the entry.

resource Optional[google.cloud.logging_v2.resource.Resource]

Monitored resource of the entry.

trace Optional[str]

Trace ID to apply to the entry.

span_id Optional[str]

Span ID within the trace for the log entry. Specify the trace parameter if span_id is set.

trace_sampled Optional[bool]

The sampling decision of the trace associated with the log entry.

source_location Optional[dict]

Location in source code from which the entry was emitted.

operation Optional[dict]

Additional information about a potentially long-running operation associated with the log entry.

logger logging_v2.logger.Logger

the logger used to write the entry.

payload google.protobuf.Message See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry

payload for the log entry.

StructEntry

StructEntry(
    log_name=None,
    labels=None,
    insert_id=None,
    severity=None,
    http_request=None,
    timestamp=None,
    resource=Resource(type="global", labels={}),
    trace=None,
    span_id=None,
    trace_sampled=None,
    source_location=None,
    operation=None,
    logger=None,
    payload=None,
)

Log entry with JSON payload.

Parameters
NameDescription
log_name str

The name of the logger used to post the entry.

labels Optional[dict]

Mapping of labels for the entry

insert_id Optional[str]

The ID used to identify an entry uniquely.

severity Optional[str]

The severity of the event being logged.

http_request Optional[dict]

Info about HTTP request associated with the entry.

timestamp Optional[datetime.datetime]

Timestamp for the entry.

resource Optional[google.cloud.logging_v2.resource.Resource]

Monitored resource of the entry.

trace Optional[str]

Trace ID to apply to the entry.

span_id Optional[str]

Span ID within the trace for the log entry. Specify the trace parameter if span_id is set.

trace_sampled Optional[bool]

The sampling decision of the trace associated with the log entry.

source_location Optional[dict]

Location in source code from which the entry was emitted.

operation Optional[dict]

Additional information about a potentially long-running operation associated with the log entry.

logger logging_v2.logger.Logger

the logger used to write the entry.

payload dict See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry

payload for the log entry.

TextEntry

TextEntry(
    log_name=None,
    labels=None,
    insert_id=None,
    severity=None,
    http_request=None,
    timestamp=None,
    resource=Resource(type="global", labels={}),
    trace=None,
    span_id=None,
    trace_sampled=None,
    source_location=None,
    operation=None,
    logger=None,
    payload=None,
)

Log entry with text payload.

Parameters
NameDescription
log_name str

The name of the logger used to post the entry.

labels Optional[dict]

Mapping of labels for the entry

insert_id Optional[str]

The ID used to identify an entry uniquely.

severity Optional[str]

The severity of the event being logged.

http_request Optional[dict]

Info about HTTP request associated with the entry.

timestamp Optional[datetime.datetime]

Timestamp for the entry.

resource Optional[google.cloud.logging_v2.resource.Resource]

Monitored resource of the entry.

trace Optional[str]

Trace ID to apply to the entry.

span_id Optional[str]

Span ID within the trace for the log entry. Specify the trace parameter if span_id is set.

trace_sampled Optional[bool]

The sampling decision of the trace associated with the log entry.

source_location Optional[dict]

Location in source code from which the entry was emitted.

operation Optional[dict]

Additional information about a potentially long-running operation associated with the log entry.

logger logging_v2.logger.Logger

the logger used to write the entry.

payload str See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry

payload for the log entry.

Modules Functions

logger_name_from_path

logger_name_from_path(path, project=None)

Validate a logger URI path and get the logger name.

Parameters
NameDescription
path str

URI path for a logger API request

project str

The project the path is expected to belong to

Exceptions
TypeDescription
ValueErrorIf the ``path`` is ill-formed of if the project from ``path`` does not agree with the ``project`` passed in.
Returns
TypeDescription
strLogger name parsed from ``path``.