cgroups 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the cgroups type monitor for the 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:

http://man7.org/linux/man-pages/man7/cgroups.7.html.

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

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 the Red Hat guide to the Memory cgroup:

https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/resource_management_guide/sec-memory.

Also refer to the Linux Kernel memory cgroup document:

https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt.

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:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this Smart Agent monitor with the Collector, include the smartagent receiver and service pipeline in your configuration file. The Smart Agent receiver is fully supported only on x86_64/amd64 platforms.

Read more in Use Smart Agent monitors with the Collector.
Learn about config options in Collector default configuration.

See the examples below for more details.

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 Distribution of 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:

Get help 🔗

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

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

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

Related Topics