Integrate with third-party tools in YugabyteDB Anywhere

You can export universe metrics and logs to third-party tools for analysis and customization.

To export either metrics or logs from a universe:

1. Create an export configuration for the integration you want to use. A configuration defines the sign in credentials and settings for the tool that you want to export to.

2. Using the configuration you created, connect your cluster.

   • Export metrics
   • Export logs

   While the connection is active, metrics or logs are automatically streamed to the tool.

To be able to export logs from Kubernetes universes, ensure the OpenTelemetry Operator is installed. Refer to OpenTelemetry Operator for Kubernetes in the OpenTelemetry documentation. Metrics export is not supported on Kubernetes.

Available integrations

Currently, you can export data to the following tools:

Integration	Log export	Metric export
Datadog	Database audit logs	Yes
Splunk	Database audit logs
AWS CloudWatch	Database audit logs
Google Cloud Logging	Database audit logs
Dynatrace		Yes

Best practices

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

Manage integrations

Create and manage export configurations on the Integrations > Logs and Metrics Export page.

The page lists the configured third-party integrations.

To view details for a configuration, select it in the list.

To delete a configuration, click the three dots, and choose Delete configuration. You can't delete a configuration that is assigned to a universe.

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

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

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

Datadog

The Datadog export configuration requires the following:

• Datadog account
• Datadog API key

To create an export configuration, do the following:

1. On the Integrations page, on the Log & Metrics Export tab, click Add 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.

Splunk

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 & Metrics Export tab, click Add 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.

AWS

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 & Metrics Export tab, click Add 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.

Google Cloud Logging

The Google 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 & Metrics Export tab, click Add 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.

Dynatrace

The Dynatrace integration requires the following:

• Publically-accessible OTLP endpoint URL of your Dynatrace instance. The endpoint URL is the URL of your Dynatrace instance. For example:

  https://{your-environment-id}.live.dynatrace.com/api/v2/otlp

  Note that if you copy your Dynatrace environment ID from the browser address bar, make sure to remove .apps.

• Dynatrace Access Token. The access token needs to have ingest metrics, ingest logs, ingest OpenTelemetry traces, and read API tokens scope.

To create an export configuration, do the following:

1. On the Integrations page, on the Log & Metrics Export tab, click Add Configuration.
2. Enter a name for the configuration.
3. Choose Dynatrace.
4. Enter the Dynatrace Endpoint URL.
5. Enter your Dynatrace Access Token.
6. Click Validate and Create Configuration.

Next steps

• Export metrics from a universe
• Export logs from a universe