Puppet Class: collectd::plugin::dcpmm

Defined in:
manifests/plugin/dcpmm.pp

Overview

Class to manage dcpmm plugin for collectd.

The dcpmm plugin will collect Intel® Optane(TM) DC Persistent Memory related performance statistics. Plugin requires root privileges to perform the statistics collection.

Parameters:

  • ensure (Enum['present', 'absent']) (defaults to: 'present') —

    Ensure param for collectd::plugin type.

  • interval (Float) (defaults to: 10.0) —

    Sets interval (in seconds) in which the values will be collected.

  • collect_health (Boolean) (defaults to: false) —

    Collects health information. collect_health and collect_perf_metrics cannot be true at the same time.

  • collect_perf_metrics (Boolean) (defaults to: true) —

    Collects memory performance metrics. collect_health and collect_perf_metrics cannot be true at the same time.

  • enable_dispatch_all (Boolean) (defaults to: false) —

    This parameter helps to seamlessly enable simultaneous health and memory perf metrics collection in future. Unused at the moment and must always be false.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'manifests/plugin/dcpmm.pp', line 12

class collectd::plugin::dcpmm (
  Enum['present', 'absent'] $ensure               = 'present',
  Float                     $interval             = 10.0,
  Boolean                   $collect_health       = false,
  Boolean                   $collect_perf_metrics = true,
  Boolean                   $enable_dispatch_all  = false,

) {
  include collectd

  if $collect_health and $collect_perf_metrics {
    fail('collect_health and collect_perf_metrics cannot be true at the same time.')
  }

  if $enable_dispatch_all {
    fail('enable_dispatch_all is unused at the moment and must always be false.')
  }

  collectd::plugin { 'dcpmm':
    ensure  => $ensure,
    content => epp('collectd/plugin/dcpmm.conf.epp'),
  }
}