Log Entries

Log entries within the Google Cloud Logging API.

class google.cloud.logging_v2.entries.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)

Bases: google.cloud.logging_v2.entries.LogEntry

Log entry.

• Parameters

  • 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.

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

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)

classmethod from_api_repr(resource, client, *, loggers=None)

Construct an entry given its API representation

• Parameters

  • resource( dict ) – text entry resource representation returned from the API

  • client( Client ) – Client which holds credentials and project configuration.

  • loggers( Optional [ dict ] ) – A mapping of logger fullnames -> loggers. If not passed, the entry will have a newly-created logger if possible, or an empty logger field if not.

• Returns

  Log entry parsed from resource .

• Return type

  google.cloud.logging.entries.LogEntry

to_api_repr()

API repr (JSON format) for entry.

class google.cloud.logging_v2.entries.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)

Bases: google.cloud.logging_v2.entries.LogEntry

Log entry with protobuf message payload.

• Parameters

  • 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 ) – payload for the log entry.

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

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(message)

Parse payload into a protobuf message.

Mutates the passed-in message in place.

• Parameters

  message( google.protobuf.Message ) – the message to be logged

to_api_repr()

API repr (JSON format) for entry.

class google.cloud.logging_v2.entries.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)

Bases: google.cloud.logging_v2.entries.LogEntry

Log entry with JSON payload.

• Parameters

  • 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 ) – payload for the log entry.

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

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)

to_api_repr()

API repr (JSON format) for entry.

class google.cloud.logging_v2.entries.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)

Bases: google.cloud.logging_v2.entries.LogEntry

Log entry with text payload.

• Parameters

  • 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 ) – payload for the log entry.

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

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)

to_api_repr()

API repr (JSON format) for entry.

google.cloud.logging_v2.entries.logger_name_from_path(path, project=None)

Validate a logger URI path and get the logger name.

• Parameters

  • path( str ) – URI path for a logger API request

  • project( str ) – The project the path is expected to belong to

• Returns

  Logger name parsed from path .

• Return type

  str

• Raises

  ValueError – If the path is ill-formed of if the project from path does not agree with the project passed in.