Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for Elasticsearch API, REST: Cluster.StreamLogs

Written by
Updated at October 17, 2024

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

HTTP request

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

Path parameters

Field

Description

clusterId

string

Required field. ID of the Elasticsearch cluster.

To get the Elasticsearch cluster ID, make a ClusterService.List request.

Query parameters

Field

Description

columnFilter[]

string

Columns from logs table to get in the response.

If no columns are specified, full log records are returned.

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 asthey 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 record_token to the StreamLogRecord.nextRecordToken returned by a previous ClusterService.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 to filter by. Currently filtering can be applied to the hostname field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

Example of a filter: message.hostname='node1.db.cloud.yandex.net'

serviceType

enum (ServiceType)

Type of the service to request logs about.

  • SERVICE_TYPE_UNSPECIFIED
  • ELASTICSEARCH
  • KIBANA

Response

HTTP Code: 200 - OK

{
  "record": {
    "timestamp": "string",
    "message": "string"
  },
  "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 StreamClusterLogsRequest.recordToken parameter in the next StreamLogs request.

This value is interchangeable with ListClusterLogsResponse.nextPageToken from ListLogs method.

LogRecord

A single log record.

Field

Description

timestamp

string (date-time)

Log record timestamp.

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

string

Contents of the log record.
Previous
ListLogs
Next
ListOperations