Managed Service for ClickHouse API, gRPC: ClusterService.ListLogs

Field

Description

cluster_id

string

Required field. ID of the ClickHouse cluster to request logs for.
To get the ClickHouse cluster ID, use a ClusterService.List request.

column_filter[]

string

Columns from logs table to request.
If no columns are specified, entire log records are returned.

service_type

enum ServiceType

Required field. Type of the service to request logs about.

• SERVICE_TYPE_UNSPECIFIED
• CLICKHOUSE: Logs of ClickHouse activity.

from_time

google.protobuf.Timestamp

Start timestamp for the logs request, in RFC3339 text format.

to_time

google.protobuf.Timestamp

End timestamp for the logs request, in RFC3339 text format.

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.

Field

Description

logs[]

LogRecord

Requested log records.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClusterLogsRequest.page_size, use the 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 the StreamLogRecord.next_record_token from StreamLogs method.

Field

Description

timestamp

google.protobuf.Timestamp

Log record timestamp in RFC3339 text format.

message

object (map<string, string>)

Contents of the log record.