Skip to content

hugepages plugin

Plugin name hugepages
Type read
Callbacks config, read
Status supported
Since 5.7
Copyright 2016 Intel Corporation
Configuration collectd.conf(5)

The purpose of hugepages plugin is to report the number of free and used huge pages on a system for intelligent workload placement. Huge pages can be used by applications to improve performance such as the memory backing for virtual machines. They are allocated per socket across a platform through configuration files or systemctl. Huge pages help improve the performance of applications by reducing the TLB lookups as the page size is increased from 4KB to 2MB or 1GB. Please note, 1GB huge pages must be configured through grub so they are allocated at boot up time. To collect hugepages information, the following directories are read:

  • /sys/devices/system/node/*/hugepages
  • /sys/kernel/mm/hugepages

The plugin reads the free_hugepages, surplus and nr_hugepages files under the directories listed above, determines the used pages (nr_hugepages + surplus pages - free_hugepages) and reports the free and used huge pages on a per node level or what’s available across the system (per hugepage size), results are available in terms of:

  • The number
  • The size in bytes
  • The percentage

For a full description of available options please refer to the collectd.conf(5) manual page.

Synopsis

  <Plugin hugepages>
    ReportPerNodeHP  true
    ReportRootHP     true
    ValuesPages      true
    ValuesBytes      false
    ValuesPercentage false
  </Plugin>

Example Graph

None yet. Add one now!

Dependencies

-

See also

Configuration

Configuration options · from collectd.conf(5)

See this section in the full configuration reference

To collect hugepages information, collectd reads directories "/sys/devices/system/node/*/hugepages" and "/sys/kernel/mm/hugepages". Reading of these directories can be disabled by the following options (default is enabled).

ReportPerNodeHP true|false
If enabled, information will be collected from the hugepage counters in "/sys/devices/system/node/*/hugepages". This is used to check the per-node hugepage statistics on a NUMA system.
ReportRootHP true|false
If enabled, information will be collected from the hugepage counters in "/sys/kernel/mm/hugepages". This can be used on both NUMA and non-NUMA systems to check the overall hugepage statistics.
ValuesPages true|false
Whether to report hugepages metrics in number of pages. Defaults to true.
ValuesBytes false|true
Whether to report hugepages metrics in bytes. Defaults to false.
ValuesPercentage false|true
Whether to report hugepages metrics as percentage. Defaults to false.