Use Splunk Distribution of OpenTelemetry Collector 🔗
This page provides a list of resources for using the Splunk OpenTelemetry Collector. Use your browser’s search function to quickly find what you’re looking for.
Note
This project is currently in Beta. See Beta Definition for more information.
Getting started 🔗
Refer to the following topics for an overview of the Splunk OpenTelemetry Collector:
Architecture, which describes how to deploy the Splunk OpenTelemetry Collector.
Components, which describes what collector supports.
Monitoring, which describes how to ensure that the Splunk OpenTelemetry Collector is healthy.
Security, which describes how to ensure that the Splunk OpenTelemetry Collector is secure.
Sizing, which describes how to ensure that the collecor is properly sized.
Troubleshooting, which describes how to resolve common issues with the Splunk OpenTelemetry Collector.
You need the following resources to get started using the Splunk OpenTelemetry Collector:
Confirm exposed ports to make sure your environment doesn’t have conflicts and that firewalls are configured properly. Ports can be changed in the configuration.
This distribution is supported on and packaged for a variety of platforms, including:
Linux: installer script (recommended), Ansible, Puppet, Heroku, and manual (including DEB/RPM packages, Docker, and binary).
Windows: installer script (recommended), Puppet, and manual (including MSI with GUI and PowerShell).
See examples for additional use cases.
Default 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
*.conffiles and theconf.ddirectory. Common sources, including filelog, journald, and Windows Event Viewer are included.
Custom configuration 🔗
These components can be customized to change the default behavior of the Splunk OpenTelemetry Collector.
Configuration sources: Use environment variables, etcd2, Include, Vault, and Zookeeper to retrieve data from specific configuration sources. After retrieving the data, you can then insert the data into your configuration.
SignalFx Smart Agent: Extensions, including collectd and Python, are used to implement components that can be added to the configuration, but do not require direct access to data. Receivers use the existing Smart Agent monitors as metric receivers to gather data.
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 Splunk Distribution of OpenTelemetry 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
Warning
Splunk only provides best-effort support for the upstream OpenTelemetry Collector.
Do the following to use the upstream OpenTelemetry Collector:
Use the OpenTelemetry Collector contribution. This contribution includes receivers/exporters and components that are vendor specific.
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 Splunk Distribution of OpenTelemetry Collector.