Performance analysis tools

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To view Yandex StoreDoc logs:

1. See the description of the CLI command to view the logs:

   yc managed-mongodb cluster list-logs --help
   

2. To get all the cluster logs, run the command:

   yc managed-mongodb cluster list-logs --id <cluster_ID>
   

   You can get the cluster ID with the list of clusters in the folder.

1. Get an IAM token for API authentication and place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.ListLogs method to execute the following request 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: Source service type for logs:

     • MONGOD: Yandex StoreDoc operations log.
     • AUDIT: Audit log.

   • columnFilter: List of output 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: The end time of the time range in the same format as fromTime.

   You can get the cluster ID from the folder’s cluster list.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

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

3. Use the ClusterService.ListLogs call to execute 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: Source service type for logs:

     • MONGOD: Yandex StoreDoc 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: The end time of the time range in the same format as from_time.

   You can get the cluster ID from the folder’s cluster list.

4. Check the server response to make sure your request was successful.