Export Logs From a CockroachDB Dedicated Cluster

CockroachDB Dedicated users with clusters on the AWS platform can use the Cloud API to configure log export to AWS CloudWatch. Once the export is configured, logs will flow from all nodes in all regions of your CockroachDB Dedicated cluster to your CloudWatch log sink.

Availability

Log export is currently only available for CockroachDB Dedicated clusters on the AWS platform. CockroachDB Dedicated clusters on the GCP platform do not yet support log export.

Log export is currently limited to the AWS CloudWatch log sink. Additional cloud log sinks are planned for the future.

The logexport endpoint

To configure and manage log export for your CockroachDB Dedicated cluster, use the logexport endpoint:

https://cockroachlabs.cloud/api/v1/clusters/{your_cluster_id}/logexport

The following methods are available:

Enable log export

Perform the following steps to enable log export from your CockroachDB Dedicated cluster to AWS CloudWatch.

1. Create the desired target AWS CloudWatch log group by following the Create a log group in CloudWatch logs instructions. If you already have a log group created, you may skip this step.

2. Find your CockroachDB Dedicated organization ID in the CockroachDB Cloud organization settings page.

3. Find your CockroachDB Dedicated cluster ID:

   1. Visit the CockroachDB Cloud console cluster page.
   2. Click on the name of your cluster.
   3. Find your cluster ID in the URL of the single cluster overview page: https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview.

4. Find your CockroachDB Dedicated cluster's associated AWS Account ID.

   You must find the Account ID of the AWS account that CockroachDB Dedicated will use for this purpose. To find the ID of the AWS account associated with your cluster, query the clusters endpoint of the CockroachDB Cloud API. The value is under the account_id field:

   curl --request GET \
     --url https://cockroachlabs.cloud/api/v1/clusters/{your_cluster_id} \
     --header 'Authorization: Bearer {secret_key}'
   

   See API Access for instructions on generating the {secret_key}.

5. Create a cross-account IAM role in your AWS account:

   1. In the AWS console, visit the IAM page.
   2. Select Roles and click Create role.
   3. For Trusted entity type, select AWS account.
   4. Choose Another AWS account.
      1. For Account ID, provide the CockroachDB Dedicated AWS Account ID that you found previously by querying your cluster's Cloud API.
   5. Finish creating the IAM role with a suitable name. These instructions will use the role name CockroachCloudLogExportRole. You do not need to add any permissions.
   Note:

   You will need the Amazon Resource Name (ARN) for your cross-account IAM role later in this procedure.

6. Select the new role, and create a new policy for this role. These instructions will use the policy name CockroachCloudLogExportPolicy.

7. Select the new policy, and paste the following into the Permissions tab, with the {} JSON option selected:

   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Action": [
                   "logs:CreateLogGroup",
                   "logs:CreateLogStream",
                   "logs:DescribeLogGroups",
                   "logs:DescribeLogStreams",
                   "logs:PutRetentionPolicy",
                   "logs:PutLogEvents"
               ],
               "Effect": "Allow",
               "Resource": [
                   "arn:aws:logs:*:{your_aws_acct_id}:log-group:{log_group_name}:*"
               ]
           }
       ]
   }
   

   Where:

   • {your_aws_acct_id} is the AWS Account ID of the AWS account where you created the CockroachCloudLogExportRole role, not the AWS Account ID of your CockroachDB Dedicated cluster. You can find your AWS Account ID on the AWS IAM page.
   • {log_group_name} is the target AWS CloudWatch log group you created in step 1.

   This defines the set of permissions that the CockroachDB Dedicated log export feature requires to be able to write logs to CloudWatch.

   If desired, you may also limit log export from your CockroachDB Dedicated cluster to a specific single AWS region, by providing the name of the desired region as the fourth value to the Resource entry. For example:

   "Resource": [
       "arn:aws:logs:us-east-1:{your_aws_acct_id}:log-group:{log_group_name}:*"
   ]
   

   Specifying an AWS region that you do not have a cluster in, or a region that only partially covers your cluster's nodes will result in missing logs.

8. Copy the Amazon Resource Name (ARN) of the CockroachCloudLogExportRole role found under Summary, which is needed for the next step.

9. Issue the following Cloud API command to enable log export for your CockroachDB Dedicated cluster:

   curl -X POST https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \
     --header "Authorization: Bearer {secret_key}" \
     --data '{"type": "AWS_CLOUDWATCH", "log_name": "{log_group_name}", "auth_principal": "{role_arn}"}'
   

   Where:

   • {cluster_id} is your CockroachDB Dedicated cluster ID as determined in step 3.
   • {secret_key} is your CockroachDB Dedicated API key. See API Access for instructions on generating this key.
   • {log_group_name} is the target AWS CloudWatch log group you created in step 1.
   • {role_arn} is the ARN for the CockroachCloudLogExportRole role you copied in step 8.

10. Depending on the size of your cluster and how many regions it spans, the configuration may take a moment. You can monitor the ongoing status of the configuration using the following Cloud API command:

    curl -X GET https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \
      --header "Authorization: Bearer {secret_key}"
    

    Run the command periodically until the command returns a status of ENABLED, at which point logs will begin appearing in CloudWatch under the log group you created in step 1. Since the configuration is applied to cluster nodes in a rolling fashion, you may see some logs appear even before the GET command returns an ENABLED status.

Monitor the status of a log export configuration

To check the status of an existing CockroachDB Dedicated log export configuration, use the following Cloud API command:

curl -X GET https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \
  --header "Authorization: Bearer {secret_key}"

Where:

• {cluster_id} is your CockroachDB Dedicated cluster's cluster ID, which can be found in the URL of your Cloud Console for the specific cluster you wish to configure, resembling f78b7feb-b6cf-4396-9d7f-494982d7d81e.
• {secret_key} is your CockroachDB Dedicated API key. See API Access for instructions on generating this key.

Update an existing log export configuration

To update an existing CockroachDB Dedicated log export configuration, make any necessary changes to your AWS CloudWatch configuration, then issue the same POST Cloud API command as shown in step 9 of the Enable log export instructions with the desired updated configuration. Follow the Monitor the status of a log export configuration instructions to ensure the update completes successfully.

Disable log export

To disable an existing CockroachDB Dedicated log export configuration, and stop sending logs to your AWS CloudWatch log sink, use the following Cloud API command:

curl -X DELETE https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \
  --header "Authorization: Bearer {secret_key}"

Where:

• {cluster_id} is your CockroachDB Dedicated cluster's cluster ID, which can be found in the URL of your Cloud Console for the specific cluster you wish to configure, resembling f78b7feb-b6cf-4396-9d7f-494982d7d81e.
• {secret_key} is your CockroachDB Dedicated API key. See API Access for instructions on generating this key.

Limitations

• Logs exported in this fashion retain redactable markers, but are not themselves redacted. Do not use this feature with sensitive log messages that you do not wish to export.
• Only one log export configuration is possible per cluster.
• A cluster log configuration is shared by all nodes in all regions in the cluster.
• Only the following CockroachDB log channels are supported for export in this manner: SESSIONS,OPS, HEALTH, STORAGE, SQL_SCHEMA, USER_ADMIN, PRIVILEGES, SENSITIVE_ACCESS, SQL_EXEC, and SQL_PERF. Other log channels are not exportable from CockroachDB Dedicated.
• To export the SQL Audit Log via the SENSITIVE_ACCESS log channel, you must additionally enable audit logging for the desired tables using the ALTER TABLE ...EXPERIMENTAL_AUDIT statement.

Troubleshooting

Most log export errors stem from incorrect AWS IAM configuration. Ensure you have followed steps 1 through 8 of the Enable log export instructions closely, and that you have a cross-account IAM role which trusts your CockroachDB Dedicated AWS account ID (as determined in step 4) and has permission to write to your specified log group in CloudWatch (as created in step 1).

When supplying the Amazon Resource Name (ARN) to step 9, be sure you are supplying the ARN for the CockroachCloudLogExportRole role, not the ARN for the CockroachCloudLogExportPolicy policy.

Was this helpful?