Memory usage 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the memory monitor type for the Smart Agent Receiver. This monitor type sends memory usage stats for the underlying host.

Note

This monitor is not available on Windows as collectd plugins are only supported in Linux and Kubernetes.

On Linux hosts, this monitor type relies on the /proc file system. If the underlying host’s /proc file system is mounted somewhere other than /proc, set the path using the top-level configuration procPath, as shown in the following example:

procPath: /proc
monitors:
 - type: memory

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.

monitors:
  smartagent/collectd/memory: 
    type: collectd/memory
    ... # Additional config

To complete the integration, include the monitor type in a metrics pipeline. Add the monitor type to the service/pipelines/metrics/receivers section of your configuration file. For example:

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

To collect memory utilization metrics only, use the Host metrics receiver.

Metrics 🔗

The following metrics are available for this integration:

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics configuration option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted, you can run agent-status monitors after configuring this monitor type in a running agent instance.

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