Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for OpenSearch API, gRPC: ClusterService.StreamLogs

Written by
Updated at October 28, 2024

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

gRPC request

rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)

StreamClusterLogsRequest

{
  "clusterId": "string",
  "columnFilter": [
    "string"
  ],
  "fromTime": "google.protobuf.Timestamp",
  "toTime": "google.protobuf.Timestamp",
  "recordToken": "string",
  "filter": "string",
  "serviceType": "ServiceType"
}

Field

Description

clusterId

string

Required field. ID of the OpenSearch cluster.

columnFilter[]

string

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

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 are sent as well as the new ones as they appear.

In essence it has tail -f semantics.

recordToken

string

Record token. Set record_token to the next_record_token returned by the previous StreamLogs
request to start streaming from the next log record.

filter

string

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] field.

  2. A conditional operator. Can be either = or != for single values, IN or NOT IN for lists of values.

  3. A 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.error_severity IN ("ERROR", "FATAL", "PANIC") AND message.hostname = "node1.db.cloud.yandex.net".

serviceType

enum ServiceType

Type of the service to request logs about.

  • SERVICE_TYPE_UNSPECIFIED: Type is not specified.
  • OPENSEARCH: OpenSearch logs.
  • DASHBOARDS: Dashboards logs.

StreamLogRecord

{
  "record": {
    "timestamp": "google.protobuf.Timestamp",
    "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 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.

LogRecord

Field

Description

timestamp

google.protobuf.Timestamp

Time when the log was recorded.

message

string

Contents of the log record.
Previous
ListLogs
Next
ListOperations