Deploy the Collector for Linux with Salt đź”—
You can use a formula to install and configure the Collector to collect metrics, traces, and logs from Linux machines and send data to Splunk Observability Cloud. See the GitHub repository to download the Salt module.
Formulas are pre-written Salt States. They are as open-ended as Salt States themselves and can be used for tasks such as installing a package, configuring and starting a service, setting up users or permissions, and many other common tasks.
Prerequisites đź”—
You need the following resources to use Salt:
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.
Supported Linux versions đź”—
The following Linux distributions and versions are supported:
Amazon Linux: 2, 2023. Log collection with Fluentd isn’t supported for Amazon Linux 2023.
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
Get started đź”—
Salt uses key-value stores known as “pillars” for user-defined data to be made available to a “minion”. Salt defines a minion as a server running a Salt minion daemon which can listen to commands from a manager and run the requested tasks. Generally, minions are servers controlled using Salt.
You can configure all attributes in the splunk-otel-collector pillar. For example:
splunk-otel-collector:
splunk_access_token: "MY_ACCESS_TOKEN"
splunk_realm: "SPLUNK_REALM"
splunk_repo_base_url: https://splunk.jfrog.io/splunk
splunk_otel_collector_config: '/etc/otel/collector/agent_config.yaml'
splunk_service_user: splunk-otel-collector
splunk_service_group: splunk-otel-collector
Attributes for Linux đź”—
For Linux, the formula 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 |
|
|
Sets the Splunk HEC endpoint URL explicitly instead of the URL inferred by the |
|
|
Sets the Splunk HEC authentication token if different than |
|
|
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 |
|
|
|
1/3 of the |
|
The source path to a Collector configuration YAML file on your control host that is uploaded and set in place of |
|
|
Sets the user or group ownership for the Collector service. The user or group is created if they do not exist. |
|
|
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 |
|
|
The path to the Fluentd configuration file on the remote host. |
|
|
The source path to a Fluentd configuration file on your control host that is uploaded and set in place of the |
|
|
Destination path to the Fluentd configuration file on the node. Only applicable if |
|
Configure automatic discovery for back-end application(s) đź”—
You can automatically instrument your back-end applications along with the Collector installation. Automatic discovery removes the need to install and configure the OpenTelemetry SDKs separately. See Configure automatic discovery for back-end applications for more information.
The following table shows the variables that can be configured for this Salt module:
Name |
Description |
Default value |
|---|---|---|
|
Whether to install or manage automatic discovery for back-end applications. When set to |
|
|
Version of the |
|
|
Whether to activate and configure the automatic discovery for |
|
|
By default, the |
|
|
Path to the Splunk OpenTelemetry Java agent. The default path is provided by the |
|
|
The path to the pre-installed |
|
|
Configure the OpenTelemetry instrumentation resource attributes, for example, |
|
|
Explicitly sets the service name for all instrumented applications, for example, |
|
|
Activates or deactivates AlwaysOn CPU Profiling. |
|
|
Activates or deactivates AlwaysOn Memory Profiling. |
|
|
Activates or deactivates 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 |
|
Next steps đź”—
After you have installed the package, see: