Overview of the Splunk Distribution of OpenTelemetry Collector 🔗
This page provides an overview of the resources available for using the Splunk Distribution of OpenTelemetry Collector. To learn more, see Scenario: Kai monitors infrastructure and apps in a cloud environment using the Splunk OTel Collector.
Get started 🔗
The following table describes everything you need to start using the Collector:
Resource |
Description |
|---|---|
Access token |
Use an access token to track and manage your resource usage. Where you see |
Realm |
A realm is a self-contained deployment that hosts organizations. You can find your realm name on your profile page in the user interface. Where you see |
Agent or Gateway mode |
In Agent mode, the Collector runs with the application or on the same host as the application. In Gateway mode, one or more collectors run a standalone service, for example, a container or deployment. See Collector deployment modes. |
Ports and endpoints |
Check exposed ports to make sure your environment doesn’t have conflicts and that firewalls are configured. You can change the ports in the Collector configuration. See Exposed ports and endpoints. |
See also Collector requirements.
Install and configure the Collector 🔗
Learn how to install, deploy, upgrade or uninstall the Collector in Install and deploy the Collector.
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), Ansible, Puppet, and manual (including MSI with GUI and PowerShell).
After you’ve installed the Collector, see Configure the Collector and Other configuration sources (Alpha).
Monitor the Collector 🔗
The default configuration automatically scrapes the Collector’s own metrics and sends the data using the signalfx exporter. A built-in dashboard provides information about the health and status of Collector instances. In addition, logs are automatically collected for the Collector and Journald processes.
The Collector also offers a zPages extension, which provides live data about the Collector. zPages are useful for in-process diagnostics without having to depend on any back end to examine traces or metrics.
Troubleshooting 🔗
See Troubleshooting to resolve common issues using the OpenTelemetry Collector and the Splunk Distribution of OpenTelemetry Collector.