> ## Documentation Index > Fetch the complete documentation index at: https://cockroachlabs.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Export Logs From a CockroachDB Advanced Cluster export const InternalLink = ({version, path = "", children, ...props}) => { let detectedVersion = version || "stable"; if (typeof window !== 'undefined' && !version) { const match = window.location.pathname.match(/\/docs\/([^/]+)/); if (match) { detectedVersion = match[1]; } } const normalizedPath = path.startsWith("/") ? path.slice(1) : path; return {children} ; }; export const version = "stable"; CockroachDB Advanced users can use the Cloud API to configure log export to [Amazon CloudWatch](https://aws.amazon.com/cloudwatch), [GCP Cloud Logging](https://cloud.google.com/logging), or [Azure Monitor](https://learn.microsoft.com/azure/azure-monitor/logs/data-platform-logs). Once the export is configured, logs will flow from all nodes in all regions of your CockroachDB Advanced cluster to your chosen cloud log sink. You can configure log export to redact sensitive log entries, limit log output by severity, send log entries to specific log group targets by log channel, and more. Log exports include the cluster name (`cloud_cluster_name`) in addition to the cluster ID (`cloud_cluster_id`), which makes it easier to identify logs from specific clusters. ## The `logexport` endpoint To configure and manage log export for your CockroachDB Advanced cluster, use the `logexport` endpoint: ```text theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} https://cockroachlabs.cloud/api/v1/clusters/{your_cluster_id}/logexport ``` Access to the `logexport` endpoint requires a valid CockroachDB Cloud service account assigned one of the following roles: * Organization Admin * Cluster Admin * Cluster Operator * Metrics Viewer The following methods are available for use with the `logexport` endpoint: | Method | Description | | -------- | ------------------------------------------------------------------------------------------------------ | | `GET` | Returns the current status of the log export configuration. | | `POST` | Enables log export, or updates an existing log export configuration. | | `DELETE` | Disables log export, halting all log export to Amazon CloudWatch, GCP Cloud Logging, or Azure Monitor. | ## Log name format GCP Cloud Logging and AWS CloudWatch logs have the following name format: ```text theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} {log-name}.{region}.cockroachdbcloud.{log-channel}.n{N} ``` Where: * {'{log-name}'} is a string of your choosing as you configure log export. For Amazon CloudWatch, this is the [log group](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams#Create-Log-Group) you create as part of enabling log export. For GCP Cloud Logging, this is the `log_name` you choose during configuration. Refer to the [Enable log export](#enable-log-export) instructions specific to your cloud provider for more information. * {'{region}'} is the cloud provider region where your CockroachDB Advanced cluster resides. * {'{log-channel}'} is the CockroachDB log channel, such as `HEALTH` or `OPS`. * {'{N}'} is the node number of the CockroachDB Advanced node emitting the log messages. Log messages received before a node is fully started may appear in a log named without an explicit node number, ending in just `.n`. For Azure Monitor, the logs have a different name format, refer to Enable log export - Verify instructions. ## Enable log export Perform the following steps to enable log export from your CockroachDB Advanced cluster to Amazon CloudWatch. 1. Create the desired target Amazon CloudWatch log group by following the [Create a log group in CloudWatch logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams#Create-Log-Group) instructions. If you already have a log group created, you can skip this step. To send logs to more than one target log group, refer to the custom configuration option in step 8. 2. Find your CockroachDB Advanced cluster ID: 1. Visit the CockroachDB Cloud console [cluster page](https://cockroachlabs.cloud/clusters). 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. Determine your CockroachDB Advanced cluster's associated AWS Account ID. This command uses the third-party JSON parsing tool [`jq`](https://stedolan.github.io/jq/download) to isolate just the needed `account_id` field from the results: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} curl --request GET \ --url https://cockroachlabs.cloud/api/v1/clusters/{your_cluster_id} \ --header "Authorization: Bearer {secret_key}" | jq .account_id ``` Refer to API Access for instructions on generating the {'{secret_key}'}. 4. Create a cross-account IAM role in your AWS account: 1. In the AWS console, visit the [IAM page](https://console.aws.amazon.com/iam). 2. Select **Roles** and click **Create role**. 3. For **Trusted entity type**, select **AWS account**. 4. Choose **Another AWS account**. 5. For **Account ID**, provide the CockroachDB Advanced AWS Account ID from step 3. 6. 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. You will need the Amazon Resource Name (ARN) for your cross-account IAM role later in this procedure. 5. Select the new role, and create a new policy for this role. These instructions will use the policy name `CockroachCloudLogExportPolicy`. 6. Select the new policy, and paste the following into the **Permissions** tab, with the **\{} JSON** option selected: ```text theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} { "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 Advanced cluster. You can find your AWS Account ID on the AWS [IAM page](https://console.aws.amazon.com/iam). * {'{log_group_name}'} is the target Amazon CloudWatch log group you created in step 1. This defines the set of permissions that the CockroachDB Advanced log export feature requires to be able to write logs to CloudWatch. If desired, you may also limit log export from your CockroachDB Advanced 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: ```text theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} "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. 7. Copy the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces) of the `CockroachCloudLogExportRole` role found under **Summary**, which is needed for the next step. 8. Use one of the following Cloud API commands to enable log export for your CockroachDB Advanced cluster. The first presents a basic configuration, where all logs are sent to Amazon CloudWatch using the default settings. The second allows for more detailed customization of the logging configuration, such as the ability to send certain log channels to specific target log groups, or the ability to redact sensitive log entries. 1. To enable log export for your CockroachDB Advanced cluster with **default** logging configuration, issue the following Cloud API command: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} 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 Advanced cluster ID as determined in step 2. * {'{secret_key}'} is your CockroachDB Advanced API key. Refer to API Access for instructions on generating this key. * {'{log_group_name}'} is the target Amazon CloudWatch log group you created in step 1. * {'{role_arn}'} is the ARN for the `CockroachCloudLogExportRole` role you copied in step 7. 2. To enable log export for your CockroachDB Advanced cluster with **custom** logging configuration: 1. Consult the log export entry on the CockroachDB Cloud API Reference and select the **Schema** tab to view the supported log configuration options, and determine the customized logging configuration you would like to use. For example, consider the following configuration: ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} { "type": "AWS_CLOUDWATCH", "log_name": "default", "auth_principal": "{role_arn}", "redact": true, "region": "", "omitted_channels": [ "SESSIONS", "SQL_PERF"], "groups": [ { "log_name": "sql", "channels": ["SQL_SCHEMA", "SQL_EXEC"], "redact": false }, { "log_name": "devops", "channels": ["OPS", "HEALTH", "STORAGE"], "min_level": "WARNING" } ] } ``` This configuration: * Enables redaction globally for all log entries emitted to Amazon CloudWatch. * Does not send log entries in the `SESSIONS` and `SQL_PERF` logging channels. * Sends log entries in the `SQL_SCHEMA` and `SQL_EXEC` logging channels to a Amazon CloudWatch log group named `sql`, and overrides (disables) the global redaction configuration for just these two log channels only. * Sends log entries in the `OPS`, `HEALTH`, and `STORAGE` logging channels to an Amazon CloudWatch log group named `devops`, but only for those entries that are of log severity level `WARNING` or higher. * Sends log entries in all other [logging channels](#what-log-channels-are-supported) to the `default` Amazon CloudWatch log group. 2. Once you have determined the configuration you'd like to use, edit the configuration to be a single line, the required form for passing to the configuration command in the next step. To accomplish this easily, use a third-party minifier, such as [json minifier](https://jsonformatter.org/json-minify). The preceding configuration becomes the following single line: ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} {"type":"AWS_CLOUDWATCH","log_name":"default","auth_principal":"{role_arn}","redact":true,"region":"","omitted_channels":["SESSIONS","SQL_PERF"],"groups":[{"log_name":"sql","channels":["SQL_SCHEMA","SQL_EXEC"],"redact":false},{"log_name":"devops","channels":["OPS","HEALTH","STORAGE"],"min_level":"WARNING"}]} ``` 3. To enable log export for your CockroachDB Advanced cluster with the preceding example configuration, issue the following Cloud API command: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} curl --request POST \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \ --header "Authorization: Bearer {secret_key}" \ --data '{"type":"AWS_CLOUDWATCH","log_name":"default","auth_principal":"{role_arn}","redact":true,"region":"","omitted_channels":["SESSIONS","SQL_PERF"],"groups":[{"log_name":"sql","channels":["SQL_SCHEMA","SQL_EXEC"],"redact":false},{"log_name":"devops","channels":["OPS","HEALTH","STORAGE"],"min_level":"WARNING"}]}' ``` Where: * {'{cluster_id}'} is your CockroachDB Advanced cluster ID as determined in step 2. * {'{secret_key}'} is your CockroachDB Advanced API key. Refer to API Access for instructions on generating this key. * {'{role_arn}'} is the ARN for the `CockroachCloudLogExportRole` role you copied in step 7. 9. 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: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} 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. 10. Once log export has been enabled, you can access logs from your CockroachDB Advanced cluster directly in [Amazon CloudWatch](https://console.aws.amazon.com/cloudwatch/home). Perform the following steps to enable log export from your CockroachDB Advanced cluster to GCP Cloud Logging. 1. Find your CockroachDB Advanced organization ID in the CockroachDB Cloud [organization information page](https://cockroachlabs.cloud/information). 2. Find your CockroachDB Advanced cluster ID: 1. Visit the CockroachDB Cloud console [cluster page](https://cockroachlabs.cloud/clusters). 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. Determine the GCP principal to grant permission to from your account. This principal is already created for you by Cockroach Labs; this step merely determines its account name. This command uses the third-party JSON parsing tool [`jq`](https://stedolan.github.io/jq/download) to isolate just the needed `id` (GCP cluster ID) and `account_id` (GCP account ID) fields, and combines them for you in the required form: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} curl --request GET \ --url https://cockroachlabs.cloud/api/v1/clusters/{your_cluster_id} \ --header "Authorization: Bearer {secret_key}" | jq '("crl-logging-user-" + (.id | split("-"))[4] + "@" + .account_id + ".iam.gserviceaccount.com")' ``` Where: * {'{your_cluster_id}'} is the cluster ID of your CockroachDB Advanced cluster as determined in step 2. * {'{secret_key}'} is your API access key. Refer to API Access for more details. The resulting GCP principal should resemble the following example: ```text theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} crl-logging-user-a1c42be2e53b@crl-prod-abc.iam.gserviceaccount.com ``` This GCP principal refers to a resource that is owned by Cockroach Labs and is created automatically along with your cluster. You **do not** need to create this account in GCP; it is already present for use by your cluster. 4. Create a new role with the required permissions in your GCP project: 1. In the GCP console, visit the [IAM roles page](https://console.cloud.google.com/iam-admin/roles) 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 cluster's GCP principal to the role you just created. 1. In the GCP console, visit the [IAM admin page](https://console.cloud.google.com/iam-admin) for your project. 2. Click the **+ Grant Access** button. 3. In the box labeled **New principals**, enter the name of your cluster's GCP principal you determined in step 3. 4. In the **Select a role** dropdown, select the role you created in step 4. 5. Click **SAVE**. 6. Use one of the following Cloud API commands to enable log export for your CockroachDB Advanced cluster. The first presents a basic configuration, where all logs are sent to GCP Cloud Logging using the default settings. The second allows for more detailed customization of the logging configuration, such as the ability to send certain log channels to specific target log groups, or the ability to redact sensitive log entries. 1. To enable log export for your CockroachDB Advanced cluster with **default** logging configuration, issue the following Cloud API command: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} 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 Advanced cluster ID as determined in step 3. * {'{secret_key}'} is your CockroachDB Advanced API key. Refer to API Access for instructions on generating this key. * {'{log_name}'} is a string of your choosing to represent logs written from your CockroachDB Advanced 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](https://console.cloud.google.com/iam-admin/settings). 2. To enable log export for your CockroachDB Advanced cluster with **custom** logging configuration: 1. Consult the log export entry on the CockroachDB Cloud API Reference and select the **Schema** tab to view the supported log configuration options, and determine the customized logging configuration you would like to use. For example, consider the following configuration: ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} { "type": "GCP_CLOUD_LOGGING", "log_name": "default", "auth_principal": "{gcp_project_id}", "redact": true, "region": "", "omitted_channels": [ "SESSIONS", "SQL_PERF"], "groups": [ { "log_name": "sql", "channels": ["SQL_SCHEMA", "SQL_EXEC"], "redact": false }, { "log_name": "devops", "channels": ["OPS", "HEALTH", "STORAGE"], "min_level": "WARNING" } ] } ``` This configuration: * Enables redaction globally for all log entries emitted to GCP Cloud Logging. * Does not send log entries in the `SESSIONS` and `SQL_PERF` logging channels. * Sends log entries in the `SQL_SCHEMA` and `SQL_EXEC` logging channels to a GCP Cloud Logging log group named `sql`, and overrides (disables) the global redaction configuration for just these two log channels only. * Sends log entries in the `OPS`, `HEALTH`, and `STORAGE` logging channels to a GCP Cloud Logging log group named `devops`, but only for those entries that are of log severity level `WARNING` or higher. * Sends log entries in all other [logging channels](#what-log-channels-are-supported) to the `default` GCP Cloud Logging log group. 2. Once you have determined the configuration you'd like to use, edit the configuration to be a single line, the required form for passing to the configuration command in the next step. To accomplish this easily, use a third-party minifier, such as [json minifier](https://jsonformatter.org/json-minify). The preceding configuration becomes the following single line: ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} {"type":"GCP_CLOUD_LOGGING","log_name":"default","auth_principal":"{gcp_project_id}","redact":true,"region":"","omitted_channels":["SESSIONS","SQL_PERF"],"groups":[{"log_name":"sql","channels":["SQL_SCHEMA","SQL_EXEC"],"redact":false},{"log_name":"devops","channels":["OPS","HEALTH","STORAGE"],"min_level":"WARNING"}]} ``` 3. To enable log export for your CockroachDB Advanced cluster with the preceding configuration, issue the following Cloud API command: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} 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":"default","auth_principal":"{gcp_project_id}","redact":true,"region":"","omitted_channels":["SESSIONS","SQL_PERF"],"groups":[{"log_name":"sql","channels":["SQL_SCHEMA","SQL_EXEC"],"redact":false},{"log_name":"devops","channels":["OPS","HEALTH","STORAGE"],"min_level":"WARNING"}]}' ``` Where: * {'{cluster_id}'} is your CockroachDB Advanced cluster ID as determined in step 2. * {'{secret_key}'} is your CockroachDB Advanced API key. Refer to API Access for instructions on generating this key. * {'{gcp_project_id}'} is your GCP project ID, as shown in your GCP Cloud Console [Settings page](https://console.cloud.google.com/iam-admin/settings). 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: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} 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 Advanced cluster directly in GCP Cloud Logging's [Log Explorer](https://console.cloud.google.com/logs/query). Exporting Logs to Azure Monitor from a CockroachDB Advanced cluster is in **limited access** and is only available to enrolled organizations. To enroll your organization, contact your Cockroach Labs account team. This feature is subject to change. Perform the following steps to enable log export from your CockroachDB Advanced cluster to Azure Monitor. 1. Find your CockroachDB Advanced cluster ID: 1. Visit the CockroachDB Cloud console [cluster page](https://cockroachlabs.cloud/clusters). 2. Click on the name of your cluster. 3. Find your cluster ID in the URL of the single cluster overview page and note the value: `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`. 2. [Create a Log Analytics workspace in Azure Portal](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/quick-create-workspace?tabs=azure-portal). 1. Navigate to the Log Analytics workspace. Under **Settings**, click **Agents**. 2. Click **Log Analytics agent instructions** section header. 3. In that section, note the values for the **Workspace ID** and **Primary key** (or **Secondary key** ) 3. Use one of the following Cloud API commands to enable log export for your CockroachDB Advanced cluster. * The first presents a basic configuration, where all logs are sent to Azure Monitor using the [default](#default) settings. * The second allows for more detailed [customization](#custom) of the logging configuration, such as the ability to send certain log channels to specific target log tables, or the ability to redact sensitive log entries. ### Default To enable log export for your CockroachDB Advanced cluster with default logging configuration, issue the following Cloud API command: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} curl --request POST \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \ --header "Authorization: Bearer {secret_key}" \ --data '{"type": "AZURE_LOG_ANALYTICS", "log_name": "{log_prefix}", "auth_principal": "{workspace_id}", "azure_shared_key": "{primary_or_secondary_key}"}' ``` Where: * {'{cluster_id}'} is your CockroachDB Advanced cluster ID. * {'{secret_key}'} is your CockroachDB Advanced API key. Refer to API Access for instructions on generating this key. * {'{log_prefix}'} is a user-specified prefix for the table that will be created in the Log Analytics workspace. * {'{auth_principal}'} is the ID for the Log Analytics workspace, **Workspace ID**. * {'{azure_shared_key}'} is the **Primary key** or **Secondary key**. ### Custom To enable log export for your CockroachDB Advanced cluster with custom logging configuration: 1. Consult the log export entry on the CockroachDB Cloud API Reference to determine the customized logging configuration you would like to use. Under the **REQUEST** section, select the **SCHEMA** tab to view the supported log configuration options. For example, consider the following configuration: ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} { "type": "AZURE_LOG_ANALYTICS", "log_name": "default", "auth_principal": "{workspace_id}", "azure_shared_key": "{primary_or_secondary_key}", "redact": true, "region": "", "omitted_channels": [ "SESSIONS", "SQL_PERF"], "groups": [ { "log_name": "sql", "channels": ["SQL_SCHEMA", "SQL_EXEC"], "redact": false }, { "log_name": "devops", "channels": ["OPS", "HEALTH", "STORAGE"], "min_level": "WARNING" } ] } ``` This configuration: * Enables redaction globally for all log entries emitted to Azure Monitor. * Does not send log entries in the `SESSIONS` and `SQL_PERF` logging channels. * Sends log entries in the `SQL_SCHEMA` and `SQL_EXEC` logging channels to an Azure Monitor log table prefixed with `sql`, and overrides (disables) the global redaction configuration for only these two log channels. * Sends log entries in the `OPS`, `HEALTH`, and `STORAGE` logging channels to an Azure Monitor log table prefixed with `devops`, but only for those entries that are of log severity level `WARNING` or higher. * Sends log entries in all other [logging channels](#what-log-channels-are-supported) to the Azure Monitor log table prefixed with `default`. 2. Once you have determined the configuration you'd like to use, edit the configuration to be a single line, the required form for passing to the configuration command in the next step. To accomplish this, use a third-party minifier, such as [json minifier](https://jsonformatter.org/json-minify). The preceding example configuration becomes the following single line, suitable for the next step's `POST` command: ```json theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} {"type":"AZURE_LOG_ANALYTICS","log_name":"default","auth_principal":"{workspace_id}","azure_shared_key":"{primary_or_secondary_key}","redact":true,"region":"","omitted_channels":["SESSIONS","SQL_PERF"],"groups":[{"log_name":"sql","channels":["SQL_SCHEMA","SQL_EXEC"],"redact":false},{"log_name":"devops","channels":["OPS","HEALTH","STORAGE"],"min_level":"WARNING"}]} ``` 3. To enable log export for your CockroachDB Advanced cluster with the example custom logging configuration, issue the following Cloud API command: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} curl --request POST \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \ --header "Authorization: Bearer {secret_key}" \ --data '{"type":"AZURE_LOG_ANALYTICS","log_name":"default","auth_principal":"{workspace_id}","azure_shared_key":"{primary_or_secondary_key}","redact":true,"region":"","omitted_channels":["SESSIONS","SQL_PERF"],"groups":[{"log_name":"sql","channels":["SQL_SCHEMA","SQL_EXEC"],"redact":false},{"log_name":"devops","channels":["OPS","HEALTH","STORAGE"],"min_level":"WARNING"}]}' ``` Where: * {'{cluster_id}'} is your CockroachDB Advanced cluster ID. * {'{secret_key}'} is your CockroachDB Advanced API key. Refer to API Access for instructions on generating this key. * {'{auth_principal}'} is the ID for the Log Analytics workspace, **Workspace ID**. * {'{azure_shared_key}'} is the **Primary key** or **Secondary key**. ### Verify 1. 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: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} curl --request GET \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \ --header "Authorization: Bearer {secret_key}" ``` When the command returns a status of `ENABLED`, the configuration has been applied to all nodes, and logs will begin appearing in Azure Monitor. Since the configuration is applied to cluster nodes one at a time, logs may begin to appear even before the status is `ENABLED`. 2. Once log export has been enabled, you can access logs from your CockroachDB Advanced cluster directly in [Azure Portal](https://portal.azure.com/#home). 1. Navigate to the Log Analytics workspace created previously. 2. In the left menu, under **Settings**, click **Tables**. In the **Table names** column, there should be a table name with the following pattern: `{log_prefix}_{region}_CL`. For example, `crdb_eastus_CL` where {'{log_prefix}'} is the string passed to `log_name` in the Cloud API command ( `crdb` in this case), {'{region}'} is the region of your cluster ( `eastus` in this case), and `CL` is the suffix for a classic custom table. 3. To view the logs in this table, in the left menu, click **Logs**. In a **New Query** window, enter the table name and click **Run**. Once log export has been enabled, logs generated going forward are sent to the specified cloud sink. Logs are not back-filled to the specified cloud sink. ## Send logs over a private cloud connection You can send logs to Amazon CloudWatch from private egress endpoints on your CockroachDB Cloud clusters to ensure they are sent over private connections within the cloud service. To learn more, read the egress private endpoints documentation. ## Monitor the status of a log export configuration To check the status of an existing CockroachDB Advanced log export configuration, use the following Cloud API command: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} curl --request GET \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \ --header "Authorization: Bearer {secret_key}" ``` Where: * {'{cluster_id}'} is your CockroachDB Advanced cluster's cluster ID, which can be found in the URL of your [Cloud Console](https://cockroachlabs.cloud/clusters) for the specific cluster you wish to configure, resembling `f78b7feb-b6cf-4396-9d7f-494982d7d81e`. * {'{secret_key}'} is your CockroachDB Advanced API key. Refer to API Access for instructions on generating this key. ## Update an existing log export configuration To update an existing CockroachDB Advanced log export configuration, make any necessary changes to your cloud provider configuration (e.g., Amazon CloudWatch or GCP Cloud Logging), then issue the same `POST` Cloud API command as shown in the [Enable log export](#enable-log-export) instructions for your cloud provider with the desired updated configuration. Follow the [Monitor the status of a log export configuration](#monitor-the-status-of-a-log-export-configuration) instructions to ensure the update completes successfully. ## Disable log export To disable an existing CockroachDB Advanced log export configuration, and stop sending logs to a cloud log sink, use the following Cloud API command: ```shell theme={"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}} curl --request DELETE \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \ --header "Authorization: Bearer {secret_key}" ``` Where: * {'{cluster_id}'} is your CockroachDB Advanced cluster's cluster ID, which can be found in the URL of your [Cloud Console](https://cockroachlabs.cloud/clusters) for the specific cluster you wish to configure, resembling `f78b7feb-b6cf-4396-9d7f-494982d7d81e`. * {'{secret_key}'} is your CockroachDB Advanced API key. Refer to API Access for instructions on generating this key. ## Limitations * CockroachDB Advanced clusters hosted on AWS can only export logs to Amazon CloudWatch. Similarly, CockroachDB Advanced clusters hosted on GCP can only export logs to GCP Cloud Logging, and CockroachDB Advanced clusters hosted on Azure can only export logs to Azure Monitor. * The log export feature does not guarantee 100% log delivery or at-least-once delivery. ## CockroachDB Advanced log export Frequently Asked Questions (FAQ) Yes, use the `redact: true` log configuration option. Refer to Redact logs for more information. Yes, use the custom log configuration step for your cloud provider, and specify multiple `groups`, each with a unique `log_name` value, in your configuration. No, if your CockroachDB Advanced cluster resides on AWS, you can only export your logs to Amazon CloudWatch. Similarly, if your CockroachDB Advanced cluster resides on GCP, you can only export your logs to GCP Cloud Logging, and if your CockroachDB Advanced cluster resides on Azure, you can only export your logs to Azure Monitor. No, logs for each region in your cluster are exported to the corresponding cloud log sink region configured for your account. For AWS, ensure that the target Amazon CloudWatch log group is configured with the same name in all target regions, and that the [IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles) you are using has permission to access each regional log group. For GCP, you can configure [Log Buckets](https://cloud.google.com/logging/docs/buckets) to collect logs from different regions, as well as assign individual retention policies by region if desired. By default, all logs written to GCP Cloud Logging are written to a `_Default` bucket, in the "global" region. You can export the following CockroachDB log channels: `SESSIONS`, `OPS`, `HEALTH`, `STORAGE`, `SQL_SCHEMA`, `USER_ADMIN`, `PRIVILEGES`, `SENSITIVE_ACCESS`, `SQL_EXEC`, `SQL_PERF`, and `CHANGEFEED`. Log channels, such as `DEV`, `KV_DISTRIBUTION`, `SQL_INTERNAL_PERF`, and `TELEMETRY`, cannot be exported from CockroachDB Advanced. These are for Cockroach Labs internal use cases and are not meant for external use. If you need access to additional logs, contact [Support](https://support.cockroachlabs.com/hc). Yes, the SQL Audit Log is exported via the `SENSITIVE_ACCESS` log channel by default, as long as you have previously enabled audit logging on desired tables using the `ALTER TABLE...EXPERIMENTAL_AUDIT` statement. No, the CockroachDB Advanced log export feature does not support use of an AWS External ID. You must configure a cross-account IAM Role as described in the [Enable log export](#enable-log-export) instructions. No, log export configuration uses the CockroachDB Cloud API syntax. For example, log export uses `min_level` to define log severity levels, while CockroachDB uses `filter`. Log messages received from CockroachDB Advanced nodes that are not yet fully started may arrive without a node number appended to the log name, in the format `{logname}.n`. Node-specific log messages, as they are received, are written to node-specific logs in the format `{logname}.n1`, `{logname}.n2`, etc., where the number following the `n` characters is the node ID. Refer to [Log Name Format](#log-name-format). ## Troubleshooting ### Amazon CloudWatch Most log export errors stem from incorrect AWS IAM configuration. Ensure you have followed steps 1 through 6 of the [Enable log export](#enable-log-export) instructions closely, and that you have a **cross-account** IAM role which trusts your CockroachDB Advanced AWS account ID (as determined in step 3) and has permission to write to your specified log group in CloudWatch (as created in step 1). When supplying the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces) to step 8, be sure you are supplying the ARN for the `CockroachCloudLogExportRole` role, **not** the ARN for the `CockroachCloudLogExportPolicy` policy. Whether you are using the default logging configuration or the custom configuration: be sure to supply this ARN to the `auth_principal` parameter, in the `--data` payload. ### GCP Cloud Logging When supplying the GCP project ID in step 6a or 6b, be sure you use the **Project ID**, and not the **Project Name**. Both are shown on the Google Cloud Console [Settings page](https://console.cloud.google.com/iam-admin/settings). You do not need to create a GCP service account to enable or manage log export. The GCP principal mentioned in step 3 and used in step 5c is already created for you. These steps simply determine the account name of this principal, which is specific to your cluster.