Exec Input (deprecated) ๐
Caution
The Exec Input monitor is now deprecated and will reach of End of Support on February 3, 2025. During this period only critical security and bug fixes are provided. When End of Support is reached, the monitor will be removed and no longer be supported, and you wonโt be able to use it to send data to Splunk Observability Cloud.
To monitor your system with Telegraf Exec you can use native OpenTelemetry instead. See more at OpenTelemetry Output Plugin in GitHub.
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the Exec Input monitor type, an embedded form of the Telegraf Exec plugin, to receive metrics or logs from exec files.
Benefits ๐
After you configure the integration, you can access these features:
View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata catalog.
Installation ๐
Follow these steps to deploy this integration:
Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the integration, as described in the Configuration section.
Restart the Splunk Distribution of the OpenTelemetry Collector.
Configuration ๐
To use this integration of a Smart Agent monitor with the Collector:
Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.
Example ๐
To activate this integration, add the following to your Collector configuration:
receivers:
smartagent/exec:
type: telegraf/exec
... # Additional config
Next, include the monitor in a logs
pipeline that utilizes an
exporter that makes the event submission requests. Use a Resource
Detection processor to ensure that host identity and other useful
information is made available as event dimensions. For example:
service:
pipelines:
logs:
receivers:
- smartagent/exec
processors:
- resourcedetection
exporters:
- signalfx
Configuration settings ๐
The following tables show the configuration options for this monitor type:
Option |
Required |
Type |
Description |
---|---|---|---|
|
no |
|
|
|
no |
|
|
|
no |
|
The default value is |
|
no |
|
|
|
no |
|
|
The nested telegrafParser
configuration object has the following
fields:
Option |
Required |
Type |
Description |
---|---|---|---|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
A list of tag names to fetch from JSON data. ( |
|
no |
|
|
|
no |
|
|
|
no |
|
A gjson path for json parser. ( |
|
no |
|
The name of the timestamp key. ( |
|
no |
|
Specifies the timestamp format. ( |
|
no |
|
Separator for Graphite data. ( |
|
no |
|
A list of templates for Graphite data. ( |
|
no |
|
The path to the collectd authentication file ( |
|
no |
|
|
|
no |
|
A list of paths to collectd TypesDB files. ( |
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
A list of patterns to match. ( |
|
no |
|
A list of named grok patterns to match. ( |
|
no |
|
Custom grok patterns. ( |
|
no |
|
List of paths to custom grok pattern files. ( |
|
no |
|
|
|
no |
|
The delimiter used between fields in the csv. ( |
|
no |
|
The character used to mark rows as comments. ( |
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
|
|
no |
|
The format to use for extracting timestamps. ( |
|
no |
|
|
|
no |
|
|
|
no |
|
|
Metrics ๐
By default this monitor has no fixed metrics. Instead, it will create metrics based on your configuration. All metrics are custom.
Metrics are emitted as gauges. If you have cumulative counter metrics that you want properly typed in Splunk Observability Cloud, use one of the following options:
Set the configuration option
signalFxCumulativeCounters
to the list of metric names to be considered as counters. Note that these names are the full names that are sent to Splunk Observability Cloud (for example,<metric>.<field>
).Set a tag named
signalfx_type
on the metric emitted by the exec script tocumulative
. All other values are ignored. Note that you must allow this tag value through in your parser configuration if the parser ignores certain fields. For example, the JSON parser requires addingsignalfx_type
to theJSONTagKeys
configuration option.
Troubleshooting ๐
If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.
Available to Splunk Observability Cloud customers
Submit a case in the Splunk Support Portal .
Contact Splunk Support .
Available to prospective customers and free trial users
Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.