Entries

Log entries within the Google Stackdriver Logging API.

class google.cloud.logging.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.entries.LogEntry

Log entry.

  • Parameters

    • 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 (google.cloud.logging.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)

Factory: construct an entry given its API representation

  • Parameters

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

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

    • loggers (dict) – (Optional) A mapping of logger fullnames -> loggers. If not passed, the entry will have a newly-created logger.

  • Return type

    google.cloud.logging.entries.LogEntry

  • Returns

    Log entry parsed from resource.

to_api_repr()

API repr (JSON format) for entry.

class google.cloud.logging.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.entries.LogEntry

Log entry with protobuf message payload.

  • Parameters

    • 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 (google.cloud.logging.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

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 (Protobuf message) – the message to be logged

to_api_repr()

API repr (JSON format) for entry.

class google.cloud.logging.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.entries.LogEntry

Log entry with JSON payload.

  • Parameters

    • 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 (google.cloud.logging.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.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.entries.LogEntry

Log entry with text payload.

  • Parameters

    • 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 (google.cloud.logging.logger.Logger) – the logger used to write the entry.

    • payload (str | unicode) – 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.entries.logger_name_from_path(path)

Validate a logger URI path and get the logger name.

  • Parameters

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

  • Return type

    str

  • Returns

    Logger name parsed from path.

  • Raises

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.