Create or update the Log Export configuration for a cluster

curl --request POST \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/logexport \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --json '{"auth_principal":"my-gcp-project-id","groups":[{"channels":["OPS","HEALTH"],"log_name":"devops","min_level":"WARNING"}],"log_name":"default","omitted_channels":["SESSIONS","SQL_PERF"],"redact":true,"shared_key":"shared-key","type":"GCP_CLOUD_LOGGING"}'

{ "cluster_id": "<string>", "created_at": "2023-11-07T05:31:56Z", "spec": { "auth_principal": "<string>", "aws_external_id": "<string>", "azure_shared_key": "<string>", "groups": [ { "channels": [ "<string>" ], "log_name": "<string>", "enable_sending_queue": true, "redact": true } ], "log_name": "<string>", "omitted_channels": [ "<string>" ], "redact": true, "region": "<string>" }, "updated_at": "2023-11-07T05:31:56Z", "user_message": "<string>" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id

string

required

Body

application/json

auth_principal

string

required

log_name

string

required

log_name is an identifier for the logs in the customer's log sink.

type

enum<string>

required

LogExportType encodes the cloud selection that we're exporting to along with the cloud logging platform.

Currently, each cloud has a single logging platform.

Available options:

AWS_CLOUDWATCH,

GCP_CLOUD_LOGGING,

AZURE_LOG_ANALYTICS

aws_external_id

string

aws_external_id to include when assuming the IAM role specified by role_arn. Optional. A specific value may be required by the role's trust policy. Only supported for Advanced clusters on AWS. If provided for a Standard cluster, the request is rejected.

azure_shared_key

string

The primary or the secondary connected sources client authentication key. This is used to export logs to Azure Log Analytics.

groups

object[]

groups is a collection of log group configurations that allows the customer to define collections of CRDB log channels that are aggregated separately at the target sink.

Show child attributes

omitted_channels

string[]

omitted_channels is a list of channels that the user does not want to export logs for.

redact

boolean

redact allows the customer to set a default redaction policy for logs before they are exported to the target sink. If a group config omits a redact flag and this one is set to true, then that group will receive redacted logs.

region

string

region allows the customer to override the destination region for all logs for a cluster.

Response

A successful response.

LogExportClusterInfo contains a package of information that fully describes both the intended state of the log export configuration for a specific cluster but also some metadata around its deployment status, any error messages, and some timestamps.

cluster_id

string

created_at

string<date-time>

spec

object

LogExportClusterSpecification contains all the data necessary to configure log export for an individual cluster. Users would supply this data via the API and also receive it back when inspecting the state of their log export configuration.

Show child attributes

status

enum<string>

LogExportStatus encodes the possible states that a configuration can be in as it is created, deployed, and disabled.

Available options:

DISABLED,

DISABLING,

DISABLE_FAILED,

ENABLED,

ENABLING,

ENABLE_FAILED,

CREDENTIALS_ERROR

updated_at

string<date-time>

user_message

string

Overview

Endpoints

Create or update the Log Export configuration for a cluster

Authorizations

Path Parameters

Body

Response