Docs » Configure application receivers » Configure application exporters and receivers for monitoring » cgroups

cgroups 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the cgroups type monitor by using the SignalFx Smart Agent Receiver.

Use this integration to reports statistics about cgroups on Linux. This receiver supports cgroups version 1, not the newer cgroups version 2 unified implementation.

This monitor is available on Linux.

For general information on cgroups, see the Linux control groups documentation:

For detailed information on cpu cgroup metrics, see Red Hat’s guide to CPU management:

For detailed information on memory cgroup metrics, see Red Hat’s guide to the Memory cgroup:

Also refer to the Linux Kernel’s memory cgroup document:

Benefits 🔗

After you configure the integration, you can access these features:

  • View metrics using the built-in dashboard. 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 Metric Finder and search for metrics sent by the monitor. For information about Metric Finder, 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 🔗

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which you’ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

receivers:
  smartagent/cgroups: 
    type: cgroups
    ... # Additional config

To complete the integration, include the receiver with this monitor type in a metrics pipeline. To do this, add the receiver to the service > pipelines > metrics > receivers section of your configuration file.

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

See the configuration example for specific use cases that show how the Splunk OpenTelemetry Collector can integrate and complement existing environments.

Configuration settings 🔗

The following table shows the configuration options for this receiver:

Option

Required

Type

Description

cgroups

no

list of strings

The cgroup names to include or exclude, based on the full hierarchy path. This set can be overridden. If not provided, cgroups defaults to a list of all cgroups. For example, to monitor all Docker container cgroups, you could use a value of ["/docker/*"].

Filtering 🔗

You can limit the cgroups for which metrics are generated with the cgroups config option to the receiver.

For example, the following will only monitor Docker-generated cgroups:

monitors:
 - type: cgroups
   cgroups:
    - "/docker/*"

Metrics 🔗

The following metrics are available for this integration:

Troubleshooting 🔗

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.