Managed Service for Elasticsearch API, gRPC: ClusterService.StreamLogs

Field

Description

cluster_id

string

Required field. ID of the Elasticsearch cluster.

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

column_filter[]

string

Columns from logs table to get in the response.

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

from_time

google.protobuf.Timestamp

Start timestamp for the logs request.

to_time

google.protobuf.Timestamp

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.

record_token

string

Record token.

Set record_token to the StreamLogRecord.next_record_token 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'

service_type

enum ServiceType

Type of the service to request logs about.

• SERVICE_TYPE_UNSPECIFIED
• ELASTICSEARCH
• KIBANA

Field

Description

record

LogRecord

One of the requested log records.

next_record_token

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.record_token parameter in the next StreamLogs request.

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

Field

Description

timestamp

google.protobuf.Timestamp

Log record timestamp.

message

object (map<string, string>)

Contents of the log record.