Manage export configurations

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:

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 > Log & 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.

Loki

Grafana Loki is a log aggregation system designed to store and query logs. YugabyteDB Anywhere can export database audit logs to a Loki-compatible endpoint (including self-hosted Loki and Grafana Cloud).

Prerequisites

• Enable the Loki sink by setting the Allow Loki Exporter in Telemetry Provider Global Configuration option (config key yb.telemetry.allow_loki) to true.

  Refer to Manage runtime configuration settings.

  The flag is enforced when you create or delete a Loki telemetry provider.

• A reachable Loki endpoint.

Create a Loki export configuration

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 Loki.
4. Fill in the Loki-specific fields:
   • Enter the Loki endpoint URL. For example, http://<loki-url>:<loki-port>.
   • Organization / Tenant ID (optional). Organization ID is required when multi-tenancy is set up in Loki. Optional for Grafana Cloud, as the authentication reroutes requests according to scope.
   • Authentication Type: Basic Auth or No Auth. If you choose Basic Auth, enter a Username and Password.
5. Click Validate and Create Configuration.

OTLP

YugabyteDB Anywhere supports OTLP (OpenTelemetry Protocol) as a generic telemetry provider sink. An OTLP telemetry provider lets a universe stream database audit logs, and database metrics to any OTLP-compatible receiver using the standard OpenTelemetry wire format.

The OTLP sink is vendor-agnostic and works with any backend that speaks OTLP, including (but not limited to) Cribl, Grafana Cloud, New Relic, Prometheus (3.0+), VictoriaMetrics, and Sumo Logic.

You can reuse the same OTLP telemetry provider for database audit logging, database metrics export, or both. OTLP uses the same OpenTelemetry Collector and universe export workflows as other telemetry providers.

Prerequisites

• Enable the OTLP integration by setting the OTLP Exporter for Telemetry Provider Global Configuration option (config key yb.telemetry.allow_otlp) to true. Refer to Manage runtime configuration settings.

  If the flag is false, any REST API create and delete requests for OTLP telemetry providers return HTTP 400 with:

  OTLP Exporter for Telemetry Provider is not enabled. Please set the runtime flag 'yb.telemetry.allow_otlp' to true.

• A reachable OTLP-compatible receiver and credentials if required (Basic Auth username and password, or a bearer token).

Create an OTLP export configuration

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 OTLP.
4. Fill in the OTLP-specific fields:
   • Enter the OTLP receiver Endpoint URL.
   • Protocol: gRPC (default) or HTTP.
   • Authentication Type:
     • No Auth (default): no credentials.
     • Basic Auth: username and password.
     • Bearer Token
   • Logs Endpoint (HTTP only, optional): override URL for logs (for example, https://example.com:4318/v1/logs).
   • Metrics Endpoint (HTTP only, optional): override URL for metrics (for example, https://example.com:4318/v1/metrics).
   • Timeout (seconds): default is 5.
5. Click Validate and Create Configuration.

Concrete endpoint URLs and auth schemes vary by OTLP backend; consult your receiver vendor's documentation or Integrations in YugabyteDB Aeon for the correct OTLP address.

Unsupported scenarios

• Per-signal endpoint overrides (logsEndpoint, metricsEndpoint) are allowed only when Protocol is HTTP. A gRPC provider that sets either field is rejected.
• For the HTTP protocol, when log export is enabled the OpenTelemetry Collector appends /v1/logs to the configured endpoint. Configure the endpoint without that suffix unless you use the explicit Logs Endpoint override.
• Kubernetes support follows the same rules as the rest of YugabyteDB Anywhere OpenTelemetry export: metrics export is not supported on Kubernetes; log export on Kubernetes requires the OpenTelemetry Operator on the cluster.

REST API configuration

The full OTLP request body for the REST API is documented in the YugabyteDB Anywhere OpenAPI specification under the TelemetryProvider model and the OTLPConfig schema (POST /api/v1/customers/{cUUID}/telemetry_provider with config.type = "OTLP"). Refer to the YugabyteDB Anywhere REST API.

Be careful when using collection_level=ALL in the API, as it can lead to performance overhead on the database nodes.

The following OTLPConfig fields are accepted by the REST API but are not exposed in the UI:

Additional configuration

Next steps

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