procstat 🔗

Caution

Smart Agent monitors are being deprecated. To collect metrics about processes use the OpenTelemetry Collector and the Telegraf Procstat Input plugin . See how in Monitor services with Telegraf Input plugins and OpenTelemetry.

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the procstat monitor type to collect metrics about processes.

This integration is available for Kubernetes, Linux, and Windows.

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/procstat:
    type: telegraf/procstat
    ...  # Additional config

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

service:
  pipelines:
    metrics:
      receivers: [smartagent/procstat]

Configuration settings 🔗

The following table shows the configuration options for the procstat monitor:

Option	Required	Type	Description
`exe`	No	`string`	Name of an executable to monitor. For example, `exe: "signalfx-agent*"`.
`pattern`	No	`string`	Regular expression pattern to match against.
`user`	No	`string`	Username to match against.
`pidFile`	No	`string`	Path to pid file to monitor. For example, `pidFile: "/var/run/signalfx-agent.pid"`.
`processName`	No	`string`	Use to override the process name dimension.
`prefix`	No	`string`	Prefix to add to each dimension.
`pidTag`	No	`bool`	Whether to add PID as a dimension or as part of the metric name. The default value is `false`.
`cmdLineTag`	No	`bool`	When `true`, it adds the full `cmdline` as a dimension. The default value is `false`.
`cGroup`	No	`string`	The name of the cgroup to monitor. This cgroup name is appended to the configured `sysPath`. See the agent config schema for more information about the `sysPath` agent configuration.
`WinService`	No	`string`	The name of a Windows service to report procstat information on.

On Linux hosts, this monitor relies on the /proc file system. If the underlying host’s /proc file system is mounted somewhere other than /proc, specify the path using the top-level configuration procPath.

Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

To learn more about the available in Splunk Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics in Add additional metrics

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.

This page was last updated on Dec 09, 2024.

Related Topics