Docs » Get started with the Splunk Distribution of the OpenTelemetry Collector » Splunk Add-On for the OpenTelemetry Collector » Install the Technical Add-on for the Splunk OpenTelemetry Collector

Install the Technical Add-on for the Splunk OpenTelemetry Collector đź”—

You can download the Splunk Add-on for the OpenTelemetry Collector from Splunkbase and install it to a single or to multiple universal forwarder instances.

The following applies:

  • The Splunk Add-on for the OpenTelemetry Collector installer comes packaged with a number of agent bundle libraries. Do not delete these files, even if you do not plan on incorporating an agent bundle.

  • To save space you can remove the folder for the binaries you are not using. For example, if you are installing on Linux you can delete the Windows folder.

  • If your configuration uses more than one collector, see Manage multiple Collectors.

Install the Splunk Add-on for the OpenTelemetry Collector to a universal forwarder instance đź”—

Follow these steps to install the Splunk Add-on for OpenTelemetry Collector to a universal forwarder instance:

  1. Download and unzip the installation file to the machine running universal forwarder. In your unzipped folder, locate and unzip the .tar file to SPLUNK_HOME > etc > deployment apps.

  2. Create a new “local” folder in Splunk_TA_otel/. Open the configuration folder and copy the access_token file into your new local folder.

  3. 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 those in Splunk Web.

  • splunk_config. $SPLUNK_OTEL_TA_HOME/configs/ta-agent-config.yaml by default.

  • disabled. false by default.

  • start_by_shell. false by default.

  • splunk_access_token_file. access_token by default.

  • splunk_realm. us0 by default. 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.

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

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

  3. 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 reflect the value shown in Splunk Observability Cloud. Save any changes you make in the local files.

  4. Restart Splunkd. Your Add-on solution is now deployed.

  5. In Splunk Infrastructure Monitoring, navigate to the host where you deployed the Splunk Add-on for the OpenTelemetry Collector and select it to explore its metrics and status. For more information, see Use navigators in Splunk Infrastructure Monitoring.

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

Follow these steps to install the Splunk Add-on for the OpenTelemetry Collector to multiple universal forwarder instances using the deployment server:

  1. Download and unzip the installation file to the machine running your deployment server. In your unzipped folder, locate and unzip the .tar file to SPLUNK_HOME > etc > deployment apps.

  2. Create a new “local” folder in Splunk_TA_otel/. Open the configuration folder and copy the access_token file into your new local folder.

  3. 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 those in Splunk Web.

  • splunk_config. $SPLUNK_OTEL_TA_HOME/configs/ta-agent-config.yaml by default.

  • disabled. false by default.

  • start_by_shell. false by default.

  • splunk_access_token_file. access_token by default.

  • splunk_realm. us0 by default. 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.

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

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

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

  4. In Splunk Web, select Settings > Forwarder Management to access your deployment server.

  5. Create a server class:

    1. For “Edit clients”, update Include to add your Universal Forwarder instance and save.

    2. Go to Add apps and select your new Splunk Add-on for the OpenTelemetry Collector service class.

    3. Select Edit on your newly created service class and make sure the following are checked:

      • Enable App

      • Restart Splunkd

  6. Save. Your Add-on solution is now deployed.

  7. In Splunk Infrastructure Monitoring, navigate to the host where you deployed the Splunk Add-on for the OpenTelemetry Collector and select it to explore its metrics and status. For more information, see Use navigators in Splunk Infrastructure Monitoring.

This page was last updated on Nov 07, 2024.