Viewing PostgreSQL cluster logs

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View the description of the CLI command to view cluster logs:

   yc managed-postgresql cluster list-logs --help
   

2. Run the following command to get cluster logs (our example does not contain a complete list of available parameters):

   yc managed-postgresql cluster list-logs <cluster_name_or_ID> \
      --limit <entry_number_limit> \
      --format <output_format> \
      --service-type <service_type> \
      --columns <list_of_columns_for_data_output> \
      --filter <entry_filtration_settings> \
      --since <time_range_left_boundary> \
      --until <time_range_right_boundary>
   

   Where:

   • --limit: limits on the number of entries to output.

   • --format: Format for log entries (text, yaml, json, or json-rest).

   • --service-type: Type of the service for which you want to output records (postgresql or pooler).

   • --columns: List of columns for data output:

     • hostname: Host name.
     • db: Database name.
     • level: Logging level, e.g., info.
     • pid: ID of the current session’s server process.
     • text: Message output by the component.

     Note

     The example shows only the main columns. A list of columns to output depends on the selected --service-type.

     To output separate columns, provide the --format key and specify the output format (yaml, json, or json-rest). Columns are not supported for text output format that is set by default.

   • --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 a list of clusters in the folder.

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.listLogs method and make a request, e.g., via cURL:

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<cluster_ID>:logs?serviceType=<service_type>&columnFilter=<column_list>&fromTime=<time_range_left_boundary>&toTime=<time_range_right_boundary>'
   

   Where:

   • serviceType: Type of the service to get logs for:

     • POSTGRESQL: PostgreSQL operation logs.
     • POOLER: Connection pooler operation logs.

   • columnFilter: List of columns to output data for. To provide values, use the message object fields from the response to your request.

   • fromTime: Left boundary of a time range in RFC-3339 format, Example: 2024-09-18T15:04:05Z.

   • toTime: Right boundary of a time range, the format is the same as for fromTime.

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 and make a request, e.g., via gRPCurl:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/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.postgresql.v1.ClusterService.ListLogs
   

   Where:

   • service_type: Type of the service to get logs for:

     • POSTGRESQL: PostgreSQL operation logs.
     • POOLER: Connection pooler operation logs.

   • column_filter: Array of columns to output data for. The array elements are strings, where each string is a column name. To provide values, use the message object fields from the response to your request.

   • from_time: Left boundary of a time range in RFC-3339 format, e.g., 2024-09-18T15:04:05Z.

   • to_time: Right boundary of a time range, the format is the same as for from_time.

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

4. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.streamLogs method and make a request, e.g., via cURL:

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<cluster_ID>:stream_logs?serviceType=<service_type>&columnFilter=<column_list>'
   

   Where:

   • serviceType: Type of the service to get logs for:

     • POSTGRESQL: PostgreSQL operation logs.
     • POOLER: Connection pooler operation logs.

   • columnFilter: List of columns to output data for. To provide values, use the message object fields from the response to your request.

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

3. View the server response to make sure the request was successful.

   Once you run the command, it does not terminate. The command output displays new logs in real time.

1. Get an IAM token for API authentication and put it into the 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/StreamLogs call and make a request, e.g., via gRPCurl:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/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>"
           ]
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.ClusterService.StreamLogs
   

   Where:

   • service_type: Type of the service to get logs for:

     • POSTGRESQL: PostgreSQL operation logs.
     • POOLER: Connection pooler operation logs.

   • column_filter: Array of columns to output data for. The array elements are strings, where each string is a column name. To provide values, use the message object fields from the response to your request.

   • from_time: Left boundary of a time range in RFC-3339 format, e.g., 2024-09-18T15:04:05Z.

   • to_time: Right boundary of a time range, the format is the same as for from_time.

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

4. View the server response to make sure the request was successful.

   Once you run the command, it does not terminate. The command output displays new logs in real time.