Export Logs From a CockroachDB Dedicated Cluster

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 --request POST \
     --url 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 --request GET \
      --url 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 the configuration across all nodes is complete, and 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.

11. Once log export has been enabled, you can access logs from your CockroachDB Dedicated cluster directly in AWS CloudWatch.

Perform the following steps to enable log export from your CockroachDB Dedicated cluster to GCP Cloud Logging.

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

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

3. Find your CockroachDB Dedicated cluster's associated GCP Account ID.

   You must find the Account ID of the GCP account that CockroachDB Dedicated will use for this purpose. To find the ID of the GCP 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}.

4. Create a new role with the required permissions in your GCP project:

   1. In the GCP console, visit the IAM roles page for your project.
   2. Click + Create role.
   3. Give your role a title and ID of your choosing, then click + Add permissions.
   4. Search for logging.logEntries.create in the Filter field, check the checkbox next to the resulting match, then click Add.
   5. Click the Create button.

5. Add your CockroachDB Dedicated cluster's service account principal to the role you just created.

   1. In the GCP console, visit the IAM service accounts page for your project.
   2. Click the + Add button.

   3. In the box labeled New principals, enter the service account ID for the CockroachDB Dedicated-managed service account to which you will grant access. The service account ID takes the following format:

      crl-logging-user-{cluster_id}@{project_id}.iam.gserviceaccount.com
      

      Where:

      • {cluster_id} is the last 12 digits of your CockroachDB Dedicated cluster ID as determined in step 2.
      • {project_id} is your CockroachDB Dedicated cluster's associated GCP account_id as determined in step 3.

   4. In the Select a role dropdown, select the role you created in step 4.

   5. Click SAVE.

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

   curl --request POST \
     --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \
     --header "Authorization: Bearer {secret_key}" \
     --data '{"type": "GCP_CLOUD_LOGGING", "log_name": "{log_name}", "auth_principal": "{gcp_project_id}"}'
   

   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_name} is a string of your choosing to represent logs written from your CockroachDB Dedicated cluster. This name will appear in the name of each log written to GCP Cloud Logging.
   • {gcp_project_id} is your GCP project ID, as shown in your GCP Cloud Console Settings page.

7. 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 --request GET \
     --url 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 the configuration across all nodes is complete, and logs will begin appearing in GCP Cloud Logging. 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.

8. Once log export has been enabled, you can access logs from your CockroachDB Dedicated cluster directly in GCP Cloud Logging's Log Explorer.