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

cgroups 🔗

Description 🔗

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

For general information on cgroups, see the Linux control groups documentation at http://man7.org/linux/man-pages/man7/cgroups.7.html.

For detailed information on cpu cgroup metrics, see Red Hat’s guide to CPU management at https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/resource_management_guide/sec-cpu. Note that the cpuacct cgroup is primarily an informational cgroup that gives detailed information on how long processes in a cgroup used the CPU.

For detailed information on memory cgroup metrics, see Red Hat’s guide to the Memory cgroup at https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/resource_management_guide/sec-memory. Also refer to the Linux Kernel’s memory cgroup document at https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt.

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/*"

Benefits 🔗

After you’ve configured the integration, you can:

  • 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 the integration:

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

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

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. The Smart Agent Receiver lets you use existing Smart Agent monitors as OpenTelemetry Collector metric receivers.

Using this monitor assumes that you have a configured environment with a functional Smart Agent release bundle on your system, which is already provided for x86_64/amd64 Splunk Distribution of OpenTelemetry Collector installation paths.

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your configuration 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/*"].

Metrics 🔗

The following metrics are available for this integration:

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud:

  • Ask questions and get answers through community support at Splunk Answers.

  • If you have a support contract, file a case using the Splunk Support Portal. See Support and Services.

  • To get professional help with optimizing your Splunk software investment, see Splunk Services.