Docs » Available host and application monitors » Configure application receivers for hosts and servers » procstat

procstat ๐Ÿ”—

Description ๐Ÿ”—

The Splunk Distribution of OpenTelemetry Collector provides this integration as the procstat monitor type for the Smart Agent Receiver.

Use this monitor 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 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 Splunk Infrastructure Monitoring navigators.

  • Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation ๐Ÿ”—

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration ๐Ÿ”—

To use this integration of a Smart Agent monitor with the Collector:

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Note

Provide a procstat monitor entry in your Collector or Smart Agent (deprecated) configuration. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector ๐Ÿ”—

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/procstat:
    type: telegraf/procstat
    ...  # Additional config

To complete the monitor activation, you must also include the smartagent/procstat receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file. For example:

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

Smart Agent ๐Ÿ”—

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
 - type: telegraf/procstat
   ...  # Additional config

See Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

The following is an exampleย procstatย Smart Agent monitor configuration:

procPath: /proc
monitors:
 - type: telegraf/procstat
   exe: "signalfx-agent*"

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.

Note

The Smart Agent supports the native pid finder only. The cgroup and systemd unit options are not supported.

Metrics ๐Ÿ”—

The following metrics are available for this integration:

Notes ๐Ÿ”—

  • Learn more about the available metric types in Observability Cloud.

  • Default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.

  • To add additional metrics, see how to configure extraMetrics using the Collector.

Get help ๐Ÿ”—

If you are not able to see your data in Splunk Observability Cloud, try these tips:

To learn about even more support options, see Splunk Customer Success.