Contact UsGet started

Managed Service for OpenSearch API, gRPC: ClusterService.ListLogs

Written by
Updated at October 17, 2024

Retrieves logs for the specified OpenSearch cluster.
For detailed description, see the Logs section in the developer's guide.

gRPC request

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

{
  "clusterId": "string",
  "columnFilter": [
    "string"
  ],
  "fromTime": "google.protobuf.Timestamp",
  "toTime": "google.protobuf.Timestamp",
  "pageSize": "int64",
  "pageToken": "string",
  "alwaysNextPageToken": "bool",
  "filter": "string",
  "serviceType": "ServiceType"
}

Field

Description

clusterId

string

Required field. ID of the OpenSearch cluster to request logs for.

To get the OpenSearch cluster ID use a ClusterService.List request.

columnFilter[]

string

Columns from log table to request.
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.

pageSize

int64

The maximum number of results per page to return.

If the number of available results is larger than pageSize, the service returns a ListClusterLogsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListClusterLogsResponse.nextPageToken returned by the previous list request.

alwaysNextPageToken

bool

The service always returns a ListClusterLogsResponse.nextPageToken, even if the current page is empty.

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.

ListClusterLogsResponse

{
  "logs": [
    {
      "timestamp": "google.protobuf.Timestamp",
      "message": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

logs[]

LogRecord

Requested log records.

nextPageToken

string

This token allows you to get the next page of results for list requests.

If the number of results is larger than ListClusterLogsRequest.pageSize, use the nextPageToken as the value
for the ListClusterLogsRequest.pageToken query parameter in the next list request.

Each subsequent list request has its own nextPageToken to continue paging through the results.

This value is interchangeable with the StreamLogRecord.nextRecordToken from StreamLogs method.

LogRecord

Field

Description

timestamp

google.protobuf.Timestamp

Time when the log was recorded.

message

string

Contents of the log record.
Previous
Stop
Next
StreamLogs