Class ProtobufEntry (1.14.0)

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 dict

(optional) mapping of labels for the entry

insert_id text

(optional) the ID used to identify an entry uniquely.

severity str

(optional) severity of event being logged.

http_request dict

(optional) info about HTTP request associated with the entry.

timestamp datetime.datetime

(optional) timestamp for the entry

resource Resource

(Optional) Monitored resource of the entry

trace str

(optional) traceid to apply to the entry.

span_id str

(optional) span_id within the trace for the log entry. Specify the trace parameter if span_id is set.

trace_sampled bool

(optional) the sampling decision of the trace associated with the log entry.

source_location dict

(optional) location in source code from which the entry was emitted.

operation dict

(optional) additional information about a potentially long-running operation associated with the log entry.

logger Logger

the logger used to write the entry.

payload protobuf message

payload for the log entry. See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry

Methods

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,
)

Create new instance of LogEntry(log_name, labels, insert_id, severity, http_request, timestamp, resource, trace, span_id, trace_sampled, source_location, operation, logger, payload)

parse_message

parse_message(message)

Parse payload into a protobuf message.

Mutates the passed-in message in place.

Parameter
NameDescription
message Protobuf message

the message to be logged

to_api_repr

to_api_repr()

API repr (JSON format) for entry.