Skip to main content

Export Platform Metrics

Self-hosted VerteX can export a curated set of platform metrics to your existing observability stack using an OpenTelemetry collector. You configure and manage the export from the Metrics tab under Administration in the system console, without deploying a customer-managed agent.

Export is available for Helm-based self-hosted installations, and works in both connected and airgapped environments as long as the destination endpoint is reachable.

info

The export sends metrics only. It never exports logs, traces, or audit events, and VerteX adds no dashboards or alerts on top of what you export. Workload cluster observability is configured per cluster, not from the system console.

The Splunk HTTP Event Collector (HEC) is the supported export destination.

Prerequisites​

  • The observability stack must be installed before you can configure export. Set observability.enabled to true in your values.yaml file at install or upgrade time. This value is false by default.

    observability:
    enabled: true # false by default

    Until the observability stack is installed, the Metrics tab shows a Metrics observability is not installed on this cluster warning, the export control reads Export unavailable, and export settings stay read-only. Install or upgrade with the stack enabled before you configure export.

  • A reachable Splunk Cloud Platform or Splunk Enterprise HTTP Event Collector (HEC) endpoint.

  • A Splunk HEC token.

  • A metrics index and an events index that already exist in Splunk. Splunk HEC separates metric-format records from event-format records, so the export requires both a Metrics index and an Events index, and the HEC token must have access to each.

  • Access to the VerteX system console.

Configure Export to Splunk​

When you configure export to Splunk, you provide the connection details described in the following table.

FieldRequiredDescription
DestinationYesThe export target. Select Splunk to use the Splunk HEC exporter, which sends metrics to a single Splunk HEC endpoint that you provide.
HEC endpointYesThe Splunk HTTP Event Collector (HEC) URL, for example https://splunk.example.com:8088. Provide only the endpoint address, with no collector or receiver path.
Metrics indexYesThe Splunk index for metric-format records. The index must already exist in Splunk, and the HEC token must have access to it.
Events indexYesThe Splunk index for event-format records. The index must already exist in Splunk, and the HEC token must have access to it.
HEC tokenYesThe Splunk HEC authentication token. Stored encrypted and never shown again after you save.
SourceNoAn optional Splunk source value used to tag exported data.
Certificate trustNoUnder Transport. Verification is always on. Keep the default System trust store when Splunk presents a publicly trusted certificate. Pin a private CA for a self-signed or internal certificate, common on air-gapped sites.

Take the following steps to configure export to Splunk.

  1. Log in to the VerteX system console.

  2. Select Administration, and then select the Metrics tab.

  3. In the Export section, turn on the toggle. The off state reads Export is off.

  4. From the Destination drop-down menu, select Splunk.

  5. Provide the connection details described in the table above.

  6. Select Test connection to send a single test metric to Splunk, and then select Save changes.

After you save, the section header changes to Exporting to Splunk HEC with a Connected status, and metrics begin forwarding to your destination. To change the settings later, select Edit configuration.

Validate​

After you save the configuration, export starts automatically within a few seconds. No restart is required.

To confirm that the export is working, search the metrics index you configured in Splunk and verify that metric data points are arriving. On the Metrics tab, the Export section also shows a Connected status when the connection is healthy.

Pause Export​

To pause export, disable the Export toggle on the Metrics tab. Your Splunk settings are retained, so when you enable the toggle again, export resumes immediately without re-entering the connection details.

Exported Metrics​

Self-hosted VerteX collects platform metrics through OpenTelemetry receivers and exports them to your Splunk destination. The exported set comes from the following receivers. Refer to each receiver's upstream documentation for the complete list of metrics it produces.

Uninstall the Observability Stack​

To remove the observability stack, set observability.enabled to false and upgrade the environment.

observability:
enabled: false

When the observability stack is not installed, the backend APIs that support export return an error, and the Metrics tab is read-only.