Contact UsGet started

Cloud Logging Service, gRPC: LogReadingService.Read

Written by
Updated at October 28, 2024

Read log entries from the specified log group.

gRPC request

rpc Read (ReadRequest) returns (ReadResponse)

ReadRequest

{
  // Includes only one of the fields `pageToken`, `criteria`
  "pageToken": "string",
  "criteria": {
    "logGroupId": "string",
    "resourceTypes": [
      "string"
    ],
    "resourceIds": [
      "string"
    ],
    "since": "google.protobuf.Timestamp",
    "until": "google.protobuf.Timestamp",
    "levels": [
      "Level"
    ],
    "filter": "string",
    "streamNames": [
      "string"
    ],
    "pageSize": "int64",
    "maxResponseSize": "int64"
  }
  // end of the list of possible fields
}

Field

Description

pageToken

string

Page token. To get the next page of results, set page_token to the
ReadResponse.nextPageToken or ReadResponse.previousPageToken returned by a previous read request.

Includes only one of the fields pageToken, criteria.

Read selector.

criteria

Criteria

Read criteria.

See Criteria for details.

Includes only one of the fields pageToken, criteria.

Read selector.

Criteria

Read criteria. Should be used in initial ReadRequest.

Field

Description

logGroupId

string

Required field. ID of the log group to return.

To get a log group ID make a LogGroupService.List request.

resourceTypes[]

string

List of resource types to limit log entries to.

Empty list disables filter.

resourceIds[]

string

List of resource IDs to limit log entries to.

Empty list disables filter.

since

google.protobuf.Timestamp

Lower bound of log entries timestamps.

until

google.protobuf.Timestamp

Upper bound of log entries timestamps.

levels[]

enum Level

List of log levels to limit log entries to.

Empty list disables filter.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

filter

string

Filter expression. For details about filtering, see documentation.

streamNames[]

string

List of stream names to limit log entries to.

Empty list disables filter.

pageSize

int64

The maximum number of results per page to return.

maxResponseSize

int64

Limits response to maximum size in bytes. Prevents gRPC resource exhaustion.

Default value for max response size is 3.5 MiB

ReadResponse

{
  "logGroupId": "string",
  "entries": [
    {
      "uid": "string",
      "resource": {
        "type": "string",
        "id": "string"
      },
      "timestamp": "google.protobuf.Timestamp",
      "ingestedAt": "google.protobuf.Timestamp",
      "savedAt": "google.protobuf.Timestamp",
      "level": "Level",
      "message": "string",
      "jsonPayload": "google.protobuf.Struct",
      "streamName": "string"
    }
  ],
  "nextPageToken": "string",
  "previousPageToken": "string"
}

Field

Description

logGroupId

string

Log group ID the read was performed from.

entries[]

LogEntry

List of matching log entries.

nextPageToken

string

Token for getting the next page of the log entries.

After getting log entries initially with Criteria, you can use next_page_token as the value
for the ReadRequest.pageToken parameter in the next read request.

Each subsequent page will have its own next_page_token to continue paging through the results.

previousPageToken

string

Token for getting the previous page of the log entries.

After getting log entries initially with Criteria, you can use previous_page_token as the value
for the ReadRequest.pageToken parameter in the next read request.

Each subsequent page will have its own next_page_token to continue paging through the results.

LogEntry

Field

Description

uid

string

Unique entry ID.

Useful for logs deduplication.

resource

LogEntryResource

Entry resource specification.

May contain information about source service and resource ID.
Also may be provided by the user.

timestamp

google.protobuf.Timestamp

Timestamp of the entry.

ingestedAt

google.protobuf.Timestamp

Entry ingestion time observed by LogIngestionService.

savedAt

google.protobuf.Timestamp

Entry save time.

Entry is ready to be read since this moment.

level

enum Level

Entry severity.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

message

string

Entry text message.

jsonPayload

google.protobuf.Struct

Entry annotation.

streamName

string

Entry stream name.

LogEntryResource

Log entry resource specification.

May be used either by services and by user.

Field

Description

type

string

Resource type, i.e., serverless.function

id

string

Resource ID, i.e., ID of the function producing logs.
Previous
Overview
Next
Overview