v2.23 Preview Preview release - not for production v2024.1 STS Stable release with standard-term support v2.20 LTS Stable release with long-term support v2.18 STS Stable release with standard-term support v2.14 LTS Stable release with long-term support Unsupported versions

Manage export configurations EARLY ACCESS

Set up links to third-party tools

You can export universe logs to third-party tools for analysis and customization. Exporting data is a two-stage process:

  1. Create an export configuration. A configuration defines the sign in credentials and settings for the tool that you want to export to.
  2. Use the configuration to export logs from a universe. While the connection is active, logs are automatically streamed to the tool.

Currently, you can export data to the following tools:

For information on how to export logs from a universe using an export configuration, refer to Export logs.

Prerequisites

Export configuration is EA . To enable export configuration management, set the Enable DB Audit Logging Global Configuration option (config key yb.universe.audit_logging_enabled) to true. Refer to Manage runtime configuration settings. Note that only a Super Admin user can modify Global configuration settings. The flag can't be turned off if audit logging is enabled on a universe.

Best practices

  • To limit performance impact and control costs, locate export configurations in a region close to your universe(s).

Configure integrations

Create and manage export configurations on the Integrations > Log page.

The page lists the configured and available third-party integrations.

Manage integrations

You can add and delete export configurations for the following tools. You can't delete a configuration that is in use by a universe.

The Datadog export configuration requires the following:

To create an export configuration, do the following:

  1. On the Integrations page, on the Log tab, click Create Export Configuration.
  2. Enter a name for the configuration.
  3. Choose Datadog.
  4. Enter your Datadog API key.
  5. Choose the Datadog site to connect to, or choose Self-hosted and enter your URL.
  6. Click Create Configuration.

The Splunk export configuration requires the following:

  • Splunk access token
  • Endpoint URL

To create an export configuration, do the following:

  1. On the Integrations page, on the Log tab, click Create Export Configuration.
  2. Enter a name for the configuration.
  3. Choose Splunk.
  4. Enter your Splunk Access token.
  5. Enter the Endpoint URL.
  6. Optionally, enter the Source, Source Type, and Index.
  7. Click Validate and Create Configuration.

The AWS CloudWatch export configuration requires the following:

  • Access Key ID and Secret Access Key for the AWS Service Account
  • The log group and log stream
  • The AWS region where the stream is located

To create an export configuration, do the following:

  1. On the Integrations page, on the Log tab, click Create Export Configuration.
  2. Enter a name for the configuration.
  3. Choose AWS CloudWatch.
  4. Enter your access key and secret access key.
  5. Enter the Log group and Log stream.
  6. Enter the region.
  7. Optionally, provide the ARN for the role.
  8. Optionally, provide an endpoint URL.
  9. Click Validate and Create Configuration.

The GCP Cloud Logging export configuration requires the following:

  • Google Service Account with the roles/logging.logWriter role.
  • The Service Account credentials JSON key. The credentials should be scoped to the project where the log group is located.

To create an export configuration, do the following:

  1. On the Integrations page, on the Log tab, click Create Export Configuration.
  2. Enter a name for the configuration.
  3. Choose GCP Cloud Logging.
  4. Optionally, provide the project name.
  5. Upload the JSON file containing your Google Cloud credentials.
  6. Click Validate and Create Configuration.

To view configuration details, select the configuration.

To delete a configuration, click Actions and choose Delete.

You can't modify an existing configuration. If you need to change the configuration (for example, to replace or update an API key) for a particular tool, do the following:

  1. Create a new configuration for the provider with the updated information.
  2. Assign the new configuration to your universes.
  3. Unassign the old configuration from universes.
  4. Delete the old configuration.