Docs » Install and configure the Splunk Distribution of OpenTelemetry Collector » Use the Splunk Distribution of OpenTelemetry Collector

Use the Splunk Distribution of OpenTelemetry Collector 🔗

This page provides a list of resources for using the Splunk Distribution of OpenTelemetry Collector.

Note

This project is currently in Beta. See Beta Definition for more information.

Overview 🔗

Refer to the following topics for an overview of the Collector:

  • Architecture, which describes how to deploy the Collector.

  • Components, which describes what the Collector supports.

  • Monitoring, which describes how to ensure that the Collector is healthy.

  • Security, which describes how to ensure that the Collector is secure.

  • Sizing, which describes how to ensure that the collecor is properly sized.

  • Troubleshoot the Collector, which describes how to resolve common issues with the Collector.

Getting started 🔗

You need the following resources to get started using the Collector:

This distribution is supported on and packaged for a variety of platforms, including:

See examples for additional use cases.

Configuration 🔗

The following is a list of default configuration files. These files contain standard specifications and settings.

  • signalfx/splunk-otel-collector. full_config_linux.yaml includes comments and links to documentation. agent_config_linux.yaml is the recommended starting configuration for most environments.

  • Fluentd, which is only applicable to Helm or installer script installations. See the *.conf files and the conf.d directory. Common sources, including filelog, journald, and Windows Event Viewer are included.

Custom configuration 🔗

Read our docs on how to configure the Collector, including our advanced settings and other configuration sources.

Note

SignalFx Smart Agent is deprecated. For details, see the Deprecation Notice. See Migrating from the SignalFx Smart Agent for resources and best practices to start using the Collector, which is the replacement for the Smart Agent.

Upstream OpenTelemetry Collector 🔗

It is possible to use the upstream OpenTelemetry Collector instead of this Splunk Distribution of OpenTelemetry Collector. The following features are not available upstream at this time:

  • Packaging, including installer scripts for Linux and Windows, and configuration management using Ansible or Puppet

  • Configuration sources

  • Several Smart Agent capabilities

Caution

Splunk officially supports the Splunk Distribution of OpenTelemetry Collector. Splunk only provides best-effort support for the upstream OpenTelemetry Collector.

Do the following to use the upstream OpenTelemetry Collector:

  1. Use the OpenTelemetry Collector contribution. This contribution includes receivers/exporters and components that are vendor specific.

  2. Configure the upstream OpenTelemetry Collector.

See upstream_agent_config.yaml for an example configuration for the upstream OpenTelemetry Collector. This configuration includes the recommended settings to ensure infrastructure correlation.

Troubleshooting 🔗

See Troubleshooting to resolve common issues using the OpenTelemetry Collector and the Splunk Distribution of OpenTelemetry Collector.