Managed Service for ClickHouse API, gRPC: ClusterService.StreamLogs

Field

Description

clusterId

string

Required field. Required. ID of the ClickHouse cluster.

columnFilter[]

string

Columns from logs table to get in the response.

serviceType

enum ServiceType

Required field.

• SERVICE_TYPE_UNSPECIFIED
• CLICKHOUSE: Logs of ClickHouse activity.

fromTime

google.protobuf.Timestamp

Start timestamp for the logs request.

toTime

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.

recordToken

string

Record token. Set recordToken to the StreamLogRecord.nextRecordToken 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.severity] 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.severity IN ('Error', 'Fatal') AND message.hostname != 'node2.db.cloud.yandex.net'.

Field

Description

record

LogRecord

One of the requested log records.

nextRecordToken

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 the StreamClusterLogsRequest.recordToken parameter in the next StreamLogs request.
This value is interchangeable with the ListClusterLogsResponse.nextPageToken from ListLogs method.

Field

Description

timestamp

google.protobuf.Timestamp

Log record timestamp in RFC3339 text format.

message

string

Contents of the log record.