Связаться с намиПодключиться

Managed Service for ClickHouse API, REST: Cluster.StreamLogs

Статья создана
Обновлена 17 декабря 2024 г.

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

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}:stream_logs

Path parameters

Field

Description

clusterId

string

Required field. Required. ID of the ClickHouse cluster.

Query parameters

Field

Description

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

string (date-time)

Start timestamp for the logs request.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

toTime

string (date-time)

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.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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

Response

HTTP Code: 200 - OK

{
  "record": {
    "timestamp": "string",
    "message": "object"
  },
  "nextRecordToken": "string"
}

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.

LogRecord

Field

Description

timestamp

string (date-time)

Log record timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

message

object (map<string, string>)

Contents of the log record.
Предыдущая
ListLogs
Следующая
ListOperations