Splunk® Add-on for OpenTelemetry Collector

Splunk Add-on for OpenTelemetry Collector

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Install the Splunk Add-on for OpenTelemetry Collector to multiple universal forwarder instances using the deployment server

  1. Download and unzip the installation file.
  2. In your unzipped folder, locate and unzip the .tar file to SPLUNK_HOME > etc > deployment apps. Create a new "local" folder in Splunk_TA_otel/.
  3. In Splunk_TA_otel/, open the configuration folder and copy the access_token file into your new local folder, for example, in Splunk_TA_otel/local.
  4. In the default folder find the inputs.conf file. You can inspect the defaults for the settings and update the values if necessary. Note that the values in inputs.conf must match the value in Splunk Web. For example, you would update the realm value from us0 to us1 in both inputs.conf and in Splunk Web.
    • splunk_config = the default value is $SPLUNK_OTEL_TA_HOME/configs/ta-agent-config.yaml`
    • disabled = the default value is false
    • start_by_shell = the default value is false
    • splunk_access_token_file = the default value is access_token
    • splunk_realm = default value is us0. A realm is a self-contained deployment that hosts organizations. You can find your realm name on your profile page in the user interface.
    • splunk_trace_ingest_url = the default value is https://ingest.us0.signalfx.com/v2/trace.
  5. In Splunk Observability Cloud, retrieve your access token value. If you do not have a token, contact your Splunk Observability Cloud administrator to create a token. See Create and manage authentication tokens using Splunk Observability Cloud to learn more about tokens.
  6. In Splunk_TA_otel/local, create or open the access_token file, and replace the existing contents with the token value you copied from Splunk Observability Cloud. Save the updated file.
  7. In Splunk Observability Cloud, select your name, then select the Organization tab to verify that the realm value in the realm and sapm-endpoint files in your local folder match the value shown in Splunk Observability Cloud. Save any changes you make in the local files.
  8. In Splunk Web, select Settings > Forwarder Management to access your deployment server.
  9. Create a server class:
    1. For "Edit clients", update Include to add your Universal Forwarder instance.
    2. Click Save.
    3. Click Add apps and select your new Splunk Add-on for OpenTelemetry Collector service class.
    4. Click Edit on your newly created service class and make sure the following are checked:
      • Enable App
      • Restart Splunkd
  10. Click Save.
  11. Your add-on solution is now deployed. See Quick start tutorial for Splunk Infrastructure Monitoring for more information.
  12. In Splunk Infrastructure Monitoring, navigate to the host where you deployed the Splunk Add-on for OpenTelemetry Collector and select it to explore its metrics and status. For more information, see Use navigators in Splunk Infrastructure Monitoring.
Last modified on 22 January, 2024
PREVIOUS
Best practices
  NEXT
Install the Splunk Add-on for OpenTelemetry Collector to a universal forwarder instance

This documentation applies to the following versions of Splunk® Add-on for OpenTelemetry Collector: 1.0, 1.0.1, 1.1.0, 1.2.0


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters