Managed Service for MongoDB API, gRPC: ClusterService.ListLogs

Field

Description

cluster_id

string

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

The maximum string length in characters is 50.

column_filter[]

string

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

service_type

enum ServiceType

Type of the service to request logs about.

• MONGOD: Logs of mongod activity.
• MONGOS: Logs of mongos activity.
• MONGOCFG: Logs of mongocfg activity.
• AUDIT: MongoDB Enterprise audit logs

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.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

The maximum value is 1000.

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.

The maximum string length in characters is 100.

always_next_page_token

bool

Always return 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. Currently filtering can be applied to the [LogRecord.logs.message.hostname], [LogRecord.logs.message.severity] fields.
2. A conditional operator. Can be either = or != for single values, IN or NOT IN for lists of values.
3. The 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.severity IN ('E', 'F')

The maximum string length in characters is 1000.

order_by

string

Order by specification as a JSON array of {field, order} objects.
Supported fields: TIMESTAMP. Supported orders: ASC, DESC.
Example: [{"field": "TIMESTAMP", "order": "DESC"}]

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