Deploy the Collector for Linux with Chef 🔗
Chef is a configuration management technology used to manage infrastructure on physical or virtual machines. Chef uses cookbooks to define a scenario.
Cookbooks are fundamental working units of Chef, which consists of all the details related to working units, having the capability to modify configuration and the state of any system configured as a node on Chef infrastructure. Cookbooks can run multiple tasks.
Prerequisites 🔗
You need the following resources to use Chef:
Double-check exposed ports to make sure your environment doesn’t have conflicts. You can change ports in the Collector configuration. See Exposed ports and endpoints for more information.
Linux 🔗
The following Linux distributions and versions:
Amazon Linux: 2
CentOS, Red Hat, Oracle: 7, 8, 9
Debian: 9, 10, 11
SUSE: 12, 15 (Note: Only for Collector versions 0.34.0 or higher. Log collection with Fluentd not currently supported.)
Ubuntu: 18.04, 20.04, 22.04
Install and use the Collector with Chef 🔗
Download the Chef cookbook from the Chef Supermarket , which is the site for community cookbooks.
To install the Collector, include the splunk_otel_collector::default recipe in the run_list, and set the attributes on the node’s run_state. The following is an example configuration that shows how to configure the required splunk_access_token attribute and some optional attributes:
{
"splunk-otel-collector": {
"splunk_access_token": "<SPLUNK_ACCESS_TOKEN>",
"splunk_realm": "<SPLUNK_REALM>",
}
}
Attributes for Linux 🔗
For Linux, the cookbook accepts the attributes described in the following table:
Name |
Description |
Default value |
|---|---|---|
|
Version of the Collector package to install, for example, |
None |
|
Replaces |
90% of |
|
The Splunk access token to authenticate requests. This attribute is required. |
None |
|
Which realm to send the data to, for example, |
None |
|
Sets the Splunk ingest URL explicitly instead of the URL inferred by the |
|
|
Sets the Splunk API URL explicitly instead of the URL inferred by the |
|
|
Sets the Splunk trace endpoint URL explicitly instead of the URL inferred by the |
|
|
The path to the Smart Agent bundle directory. The default path is provided by the Collector package. If the specified path is changed from the default value, the path should be an existing directory on the node. The |
|
|
The path to the collectd configuration directory for the Smart Agent bundle. The default path is provided by the Collector package. If the specified path is changed from the default value, the path should be an existing directory on the node. The |
|
|
Total memory in MIB to allocate to the Collector; automatically calculates the ballast size. The |
|
|
|
|
|
The source path to the Collector configuration YAML file. This file is copied to the |
|
|
Destination path of the Collector configuration file on the node. The |
|
|
The Collector configuration object. Everything underneath this object gets directly converted to YAML and becomes the Collector configuration file. Using this option preempts |
|
|
Sets the user or group ownership for the Collector service. The user or group is created if they do not exist. |
|
|
The Collector package repository stage to use. Can be |
|
|
Whether to install or manage Fluentd and dependencies for log collection. On Linux, the dependencies include |
|
|
Version of the td-agent (Fluentd) package to install |
|
|
Source path to the Fluentd configuration file. This file is copied to the |
|
|
Destination path to the Fluentd configuration file on the node. Only applicable if |
|
Configure automatic discovery for back-end applications (Linux only) 🔗
You can automatically instrument your back-end applications applications along with the Collector installation using automatic discovery. Automatic discovery removes the need to install and configure OpenTelemetry agents separately. See Discover telemetry sources automatically for more information. The applications to be instrumented on the node need to be started or restarted separately after installation or any configuration changes for automatic discovery to take effect.
The following table shows the variables that can be configured with this Chef cookbook:
Name |
Description |
Default value |
|---|---|---|
|
Whether to install or manage automatic discovery for back-end applications. When set to |
|
|
The automatic discovery SDKs to install and activate. Note: |
|
|
Version of the |
|
|
Whether to activate and configure the automatic discovery for |
|
|
By default, the |
|
|
Configure the OpenTelemetry instrumentation resource attributes, for example, |
|
|
Explicitly sets the service name for all instrumented applications on the node, for example, |
|
|
Activates or deactivates AlwaysOn CPU Profiling. To learn more, see Node.js settings for AlwaysOn Profiling. |
|
|
Activates or deactivates AlwaysOn Memory Profiling. To learn more, see Node.js settings for AlwaysOn Profiling. |
|
|
Activates or deactivates exporting instrumentation metrics. |
|
|
Sets the OTLP endpoint for collected metrics, traces, and logs by all activated SDKs. Only applicable if |
|
|
Sets the OTLP endpoint protocol for collected metrics, traces, and logs by all activated SDKs, for example |
|
|
Comma-separated list of exporters for collected metrics by all activated SDKs, for example |
|
|
Sets the exporter for collected logs by all activated SDKs, for example |
|
|
Path to the Splunk OpenTelemetry Java agent. The default path is provided by the |
|
|
The path to the pre-installed |
|
Next steps 🔗
After you have installed the package, see: