Method streamLogs

Статья создана

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

Parameter	Description
clusterId	Required. Required. ID of the ClickHouse cluster. The maximum string length in characters is 50.

Parameter	Description
columnFilter	Columns from logs table to get in the response.
serviceType	CLICKHOUSE: Logs of ClickHouse activity.
fromTime	Start timestamp for the logs request. String in RFC3339 text format.
toTime	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.
recordToken	Record token. Set recordToken to the `nextRecordToken` returned by a previous StreamLogs request to start streaming from next log record. The maximum string length in characters is 100.
filter	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. A conditional operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values. 3. The value. 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'`. The maximum string length in characters is 1000.

HTTP Code: 200 - OK

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

Field	Description
record	object One of the requested log records.
record. timestamp	string (date-time) Log record timestamp in RFC3339 text format. String in RFC3339 text format.
record. message	object Contents of the log record.
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 recordToken parameter in the next StreamLogs request. This value is interchangeable with the nextPageToken from ListLogs method.