Docs » Get started with the Splunk Distribution of the OpenTelemetry Collector » Collector components » Collector components: Exporters » Splunk APM exporter

Splunk APM exporter 🔗

The Splunk APM (SAPM) exporter allows the OpenTelemetry Collector to send traces to Splunk Observability Cloud. The supported pipeline types are traces. See Process your data with pipelines for more information.

Get started 🔗

Note

This component is included in the default configuration of the Splunk Distribution of the OpenTelemetry Collector when deploying in host monitoring (agent) mode in the traces pipeline. See Collector deployment modes for more information.

For details about the default configuration, see Configure the Collector for Kubernetes with Helm, Collector for Linux default configuration, or Collector for Windows default configuration. You can customize your configuration any time as explained in this document.

Follow these steps to configure and activate the component:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  1. Configure the exporter as described in this doc.

  2. Restart the Collector.

Sample configuration 🔗

The following example shows a SAPM exporter instance configuration for a maximum of 100 connections and 8 workers:

exporters:
  sapm:
    access_token: <access_token>
    access_token_passthrough: true
    endpoint: https://ingest.<realm>.signalfx.com/v2/trace
    max_connections: 100
    num_workers: 8

Next, add the exporter to the services section of your configuration file:

service:
  pipelines:
    # To complete the configuration, include the exporter in a traces metrics pipeline.
    traces:
        receivers: [nop]
        processors: [nop]
        exporters: [sapm]

Configuration example with all settings 🔗

The following example shows all available settings:

exporters:
  sapm/customname:
    # Endpoint is the destination to where traces are sent in SAPM format.
    # The endpoint must be a full URL and include the scheme, port, and path.
    # For example, https://ingest.us0.signalfx.com/v2/trace
    endpoint: test-endpoint
    # Authentication token provided by Splunk Observability Cloud.
    access_token: abcd1234
    # Number of workers that should be used to export traces.
    # The exporter can make as many requests in parallel as the number of workers.
    num_workers: 3
    # Used to set a limit to the maximum idle HTTP connections the exporter can keep open.
    max_connections: 45
    access_token_passthrough: false
    # Timeout for every attempt to send data to the back end.
    # The default value is 5s.
    timeout: 10s
    sending_queue:
      enabled: true
      num_consumers: 2
      queue_size: 10
    retry_on_failure:
      enabled: true
      initial_interval: 10s
      max_interval: 60s
      max_elapsed_time: 10m

service:
  pipelines:
    traces:
        receivers: [nop]
        processors: [nop]
        exporters: [sapm]

In the endpoint URL, realm is the Splunk Observability Cloud realm, for example, us0. To find your Splunk realm, see Note about realms.

Note

To send SAPM data through a proxy, configure proxy settings as environment variables. See Configure proxy settings for the Collector for more information.

Settings 🔗

The following table shows the configuration options for the SAPM exporter:

Troubleshooting 🔗

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Available to prospective customers and free trial users

  • Ask a question and get answers through community support at Splunk Answers .

  • Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

To learn about even more support options, see Splunk Customer Success .