Contact UsGet started

Managed Service for PostgreSQL API, gRPC: ClusterService.StreamLogs

Written by
Updated at December 17, 2024

Same as ListLogs but using server-side streaming. Also allows for 'tail -f' semantics.

gRPC request

rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)

StreamClusterLogsRequest

{
  "cluster_id": "string",
  "column_filter": [
    "string"
  ],
  "service_type": "ServiceType",
  "from_time": "google.protobuf.Timestamp",
  "to_time": "google.protobuf.Timestamp",
  "record_token": "string",
  "filter": "string"
}

Field

Description

cluster_id

string

Required field. Required. ID of the PostgreSQL cluster.

column_filter[]

string

Columns from logs table to get in the response.

service_type

enum ServiceType

  • SERVICE_TYPE_UNSPECIFIED
  • POSTGRESQL: Logs of PostgreSQL activity.
  • POOLER: Logs of connection pooler activity.

from_time

google.protobuf.Timestamp

Start timestamp for the logs request.

to_time

google.protobuf.Timestamp

End timestamp for the logs request.
If this field is not set, all existing logs will be sent and then the new ones as
they appear. In essence it has 'tail -f' semantics.

record_token

string

Record token. Set record_token to the next_record_token returned by a previous StreamLogs
request to start streaming from next log record.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

  1. The field name. Currently filtering can be applied to the [LogRecord.logs.message.hostname],
    [LogRecord.logs.message.error_severity] (for POSTGRESQL service), [LogRecord.logs.message.level] (for POOLER service) fields.
  2. An = operator.
  3. The value in double quotes ("). Must be 1-63 characters long and match the regular expression [a-z0-9.-]{1,61}.
    Examples of a filter:
    message.hostname='node1.db.cloud.yandex.net'
    message.error_severity IN ("ERROR", "FATAL", "PANIC") AND message.hostname = "node1.db.cloud.yandex.net"

StreamLogRecord

{
  "record": {
    "timestamp": "google.protobuf.Timestamp",
    "message": "map<string, string>"
  },
  "next_record_token": "string"
}

Field

Description

record

LogRecord

One of the requested log records.

next_record_token

string

This token allows you to continue streaming logs starting from the exact
same record. To continue streaming, specify value of next_record_token
as value for record_token parameter in the next StreamLogs request.
This value is interchangeable with next_page_token from ListLogs method.

LogRecord

Field

Description

timestamp

google.protobuf.Timestamp

Log record timestamp in RFC3339 text format.

message

object (map<string, string>)

Contents of the log record.
Previous
ListLogs
Next
ListOperations