Viewing MongoDB cluster logs
Managed Service for MongoDB allows you to get a cluster log snippet for the selected period and view logs in real time.
Note
Cluster logs are kept for 30 days.
Getting a cluster log
- Go to the folder page and select Managed Service for MongoDB.
- Click the name of the cluster you need and select the
Logs tab. - Specify the time period you want the log info for: enter it manually or select in the calendar using the date input field.
- Specify the hosts and logging level in the line with the date input field if needed.
A list of log entries for the selected time period will be displayed. To view detailed information about an event, click the respective entry in the list.
If there are too many entries and not all of them are displayed, click Load more at the end of the list.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name
or --folder-id
parameter.
-
View the description of the CLI command to view cluster logs:
yc managed-mongodb cluster list-logs --help
-
Run the following command to get cluster logs (our example does not contain a complete list of available parameters):
yc managed-mongodb cluster list-logs <cluster_name_or_ID> \ --limit <entry_number_limit> \ --service-type <service_type> \ --columns <list_of_data_columns> \ --filter <entry_filtration_settings> \ --since <time_range_left_boundary> \ --until <time_range_right_boundary>
Where:
-
--limit
: limits on the number of entries to output. -
--service-type
: Type of the service for which you want to output entries (mongod
,mongos
,mongocfg
, oraudit
). -
--columns
: List of data columns:component
: Type of component to log. e.g.,CONTROL
.context
: Name of the executable module, e.g.,signalProcessingThread
.hostname
: Host name.message
: Message output by the component.severity
: Logging level, e.g.,I
orW
(Info
andWarning
, respectively).
Note
The list of data columns depends on the selected
--service-type
. -
--filter
: record filter settings, for example,message.hostname='node1.mdb.yandexcloud.net'
. -
--since
: Left boundary of a time range in RFC-3339 ,HH:MM:SS
format or a time interval relative to the current time. Examples:2006-01-02T15:04:05Z
,15:04:05
,2h
,3h30m ago
. -
--until
: right boundary of a time range, the format is similar to that of--since
.
-
You can request the cluster name and ID with the list of clusters in the folder.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Cluster.ListLogs method and send the following request, e.g., via cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/<cluster_ID>:logs' \ --url-query serviceType=<service_type> \ --url-query columnFilter=<column_list> \ --url-query fromTime=<time_range_left_boundary> \ --url-query toTime=<time_range_right_boundary>
Where:
-
serviceType
: Type of the service to get logs for:MONGOD
: MongoDB operations log.AUDIT
: Audit log.
-
columnFilter
: List of data columns:hostname
: Host name.component
: Type of component to log, Example:HTTP-Session
.message
: Message output by the component.query_id
: Request ID.severity
: Logging level, e.g.,Debug
.thread
: ID of the thread involved in query handling.
You can specify only one column in the
columnFilter
parameter. If you want to filter logs by more than one column, provide a list of the columns in several parameters.fromTime
: Left boundary of a time range in RFC-3339 format, Example:2006-01-02T15:04:05Z
.
toTime
: Right boundary of a time range, the format is the same as forfromTime
.
You can request the cluster ID with the list of clusters in the folder.
-
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Below, we assume the repository contents are stored in the
~/cloudapi/
directory. -
Use the ClusterService.ListLogs call and send the following request, e.g., via gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "<cluster_ID>", "service_type": "<service_type>", "column_filter": [ "<column_1>", "<column_2>", ..., "<column_N>" ], "from_time": "<time_range_left_boundary>", "to_time": "<time_range_right_boundary>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.mongodb.v1.ClusterService.ListLogs
Where:
-
service_type
: Type of the service to get logs for:MONGOD
: MongoDB operations log.AUDIT
: Audit log.
-
column_filter
: List of data columns:hostname
: Host name.component
: Type of component to log, Example:HTTP-Session
.message
: Message output by the component.query_id
: Request ID.severity
: Logging level, e.g.,Debug
.thread
: ID of the thread involved in query handling.
You can specify more than one column in the
column_filter
parameter if you want to filter logs by multiple columns.from_time
: Left boundary of a time range in RFC-3339 format, Example:2006-01-02T15:04:05Z
.
to_time
: Right boundary of a time range, the format is the same as forfrom_time
.
You can request the cluster ID with the list of clusters in the folder.
-
-
View the server response to make sure the request was successful.
Getting a cluster log stream
This method allows you to get cluster logs in real time.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name
or --folder-id
parameter.
To view cluster logs as they become available, run this command:
yc managed-mongodb cluster list-logs <cluster_name_or_ID> --follow
You can request the cluster name and ID with the list of clusters in the folder.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Cluster.StreamLogs method and send the following request, e.g., via cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/<cluster_ID>:stream_logs' \ --url-query serviceType=<service_type> \ --url-query columnFilter=<column_list> \ --url-query fromTime=<time_range_left_boundary> \ --url-query toTime=<time_range_right_boundary> \ --url-query filter=<log_filter>
Where:
-
serviceType
: Type of the service to get logs for:MONGOD
: MongoDB operations log.AUDIT
: Audit log.
-
columnFilter
: List of data columns:hostname
: Host name.component
: Type of component to log, Example:HTTP-Session
.message
: Message output by the component.query_id
: Request ID.severity
: Logging level, e.g.,Debug
.thread
: ID of the thread involved in query handling.
You can specify only one column in the
columnFilter
parameter. If you want to filter logs by more than one column, provide a list of the columns in several parameters.fromTime
: Left boundary of a time range in RFC-3339 format, Example:2006-01-02T15:04:05Z
.
toTime
: Right boundary of a time range, the format is the same as forfromTime
.
-
filter
: Log filter. You can filter logs so that the stream contains only the logs you need.For more information about filters and their syntax, see the API reference.
Tip
A filter can contain quotation marks and other characters. Escape them if you need to.
Supported filters:
message.hostname
: Filtering by host name.message.severity
: Filtering by logging level.
You can request the cluster ID with the list of clusters in the folder.
-
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Below, we assume the repository contents are stored in the
~/cloudapi/
directory. -
Use the ClusterService.StreamLogs call and send the following request, e.g., via gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "<cluster_ID>", "service_type": "<service_type>", "column_filter": [ "<column_1>", "<column_2>", ..., "<column_N>" ], "from_time": "<time_range_left_boundary>", "to_time": "<time_range_right_boundary>", "filter": "<log_filter>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.mongodb.v1.ClusterService.StreamLogs
Where:
-
service_type
: Type of the service to get logs for:MONGOD
: MongoDB operations log.AUDIT
: Audit log.
-
column_filter
: List of data columns:hostname
: Host name.component
: Type of component to log, Example:HTTP-Session
.message
: Message output by the component.query_id
: Request ID.severity
: Logging level, e.g.,Debug
.thread
: ID of the thread involved in query handling.
You can specify more than one column in the
column_filter
parameter if you want to filter logs by multiple columns.from_time
: Left boundary of a time range in RFC-3339 format, Example:2006-01-02T15:04:05Z
.
to_time
: Right boundary of a time range, the format is the same as forfrom_time
.
-
filter
: Log filter. You can filter logs so that the stream contains only the logs you need.For more information about filters and their syntax, see the API reference.
Tip
A filter can contain quotation marks and other characters. Escape them if you need to.
Supported filters:
message.hostname
: Filtering by host name.message.severity
: Filtering by logging level.
You can request the cluster ID with the list of clusters in the folder.
-
-
View the server response to make sure the request was successful.