Contact UsGet started

Managed Service for Apache Kafka® API, gRPC: ClusterService.ListLogs

Written by
Updated at December 17, 2024

Retrieves logs for the specified Apache Kafka® cluster.

For more information about logs, see the Logs section in the documentation.

gRPC request

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

{
  "cluster_id": "string",
  "column_filter": [
    "string"
  ],
  "from_time": "google.protobuf.Timestamp",
  "to_time": "google.protobuf.Timestamp",
  "page_size": "int64",
  "page_token": "string",
  "always_next_page_token": "bool",
  "filter": "string"
}

Field

Description

cluster_id

string

Required field. ID of the Apache Kafka® cluster to request logs for.

To get the Apache Kafka® cluster ID, make a ClusterService.List request.

column_filter[]

string

Columns from the logs table to request.

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.

page_size

int64

The maximum number of results per page to return.

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

page_token

string

Page token.

To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by the previous list request.

always_next_page_token

bool

The flag that defines behavior of providing the next page token.

If this flag is set to true, this API method will always return ListClusterLogsResponse.next_page_token, even if current page is empty.

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 1-63 characters long and match the regular expression [a-z0-9.-]{1,61}.

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

ListClusterLogsResponse

{
  "logs": [
    {
      "timestamp": "google.protobuf.Timestamp",
      "message": "map<string, string>"
    }
  ],
  "next_page_token": "string"
}

Field

Description

logs[]

LogRecord

Requested log records.

next_page_token

string

Token that allows you to get the next page of results for list requests.

If the number of results is larger than ListClusterLogsRequest.page_size, use next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request.
Each subsequent list request will have its own next_page_token to continue paging through the results.
This value is interchangeable with StreamLogRecord.next_record_token from StreamLogs method.

LogRecord

A single log record.

Field

Description

timestamp

google.protobuf.Timestamp

Log record timestamp.

message

object (map<string, string>)

Contents of the log record.
Previous
RescheduleMaintenance
Next
StreamLogs