Подключиться
Yandex Managed Service for Greenplum®

Managed Service for Greenplum® API, REST: Cluster.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-greenplum/v1/clusters/{clusterId}:stream_logs

Path parameters

Parameter Description
clusterId

Required. ID of the Greenplum® cluster.

The maximum string length in characters is 50.

Query parameters

Parameter Description
columnFilter

Columns from log table to get in the response. If no columns are specified, entire log records are returned.
serviceType

Type of the service to request logs about.

  • SERVICE_TYPE_UNSPECIFIED: Type is not specified. - GREENPLUM: Greenplum® activity logs.
  • GREENPLUM_POOLER: Greenplum® pooler logs.
fromTime

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

End timestamp for the logs request.

If this field is not set, all existing logs are sent as well as 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

Record token. Set recordToken to the [StreamLogs.next_record_token] returned by the previous [StreamLogs] request to start streaming from the 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. A field name. Currently filtering can be applied to the [LogRecord.logs.message.hostname], [LogRecord.logs.message.error_severity] (for GREENPLUM service), [LogRecord.logs.message.level] (for POOLER service) fields.

  2. An = operator.

  3. A 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".

The maximum string length in characters is 1000.

Response

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)

Time when the log was recorded.

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).
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 do that, specify value of nextRecordToken as the value for [StreamLogs.record_token] parameter in the next [StreamLogs] request.

This value is interchangeable with [ListLogs.next_page_token] from [ListLogs] method.
В этой статье: