# Reference ## Table of Contents ### Classes #### Public Classes * [`collectd`](#collectd): installs and configures collectd * [`collectd::config`](#collectd--config): private * [`collectd::params`](#collectd--params) * [`collectd::plugin::aggregation`](#collectd--plugin--aggregation): collectd::plugin::aggregation * [`collectd::plugin::amqp`](#collectd--plugin--amqp): https://collectd.org/wiki/index.php/Plugin:AMQP * [`collectd::plugin::amqp1`](#collectd--plugin--amqp1): == Class: collectd::plugin::amqp1 Class to manage amqp1 write plugin for collectd Documentation: https://collectd.org/documentation/manpa * [`collectd::plugin::apache`](#collectd--plugin--apache): https://collectd.org/wiki/index.php/Plugin:Apache * [`collectd::plugin::battery`](#collectd--plugin--battery): == Class: collectd::plugin::battery Class to manage battery write plugin for collectd Documentation: https://collectd.org/documentation/m * [`collectd::plugin::bind`](#collectd--plugin--bind): https://collectd.org/wiki/index.php/Plugin:BIND * [`collectd::plugin::ceph`](#collectd--plugin--ceph): == Class: collectd::plugin::ceph Class to manage ceph plugin for collectd === Parameters [*ensure*] ensure param for collectd::plugin type * [`collectd::plugin::cgroups`](#collectd--plugin--cgroups): https://collectd.org/wiki/index.php/Plugin:cgroups * [`collectd::plugin::chain`](#collectd--plugin--chain) * [`collectd::plugin::connectivity`](#collectd--plugin--connectivity): == Class: collectd::plugin::connectivity Class to manage connectivity plugin for collectd Documentation: https://collectd.org/documentati * [`collectd::plugin::conntrack`](#collectd--plugin--conntrack): https://collectd.org/wiki/index.php/Plugin:ConnTrack * [`collectd::plugin::contextswitch`](#collectd--plugin--contextswitch): https://collectd.org/wiki/index.php/Plugin:ContextSwitch * [`collectd::plugin::cpu`](#collectd--plugin--cpu): https://collectd.org/wiki/index.php/Plugin:CPU * [`collectd::plugin::cpufreq`](#collectd--plugin--cpufreq): https://collectd.org/wiki/index.php/Plugin:CPUFreq * [`collectd::plugin::csv`](#collectd--plugin--csv): https://collectd.org/wiki/index.php/Plugin:CSV * [`collectd::plugin::cuda`](#collectd--plugin--cuda): Class: collectd::plugin::cuda * [`collectd::plugin::curl`](#collectd--plugin--curl) * [`collectd::plugin::dbi`](#collectd--plugin--dbi): https://collectd.org/wiki/index.php/Plugin:DBI * [`collectd::plugin::dcpmm`](#collectd--plugin--dcpmm): Class to manage dcpmm plugin for collectd. The dcpmm plugin will collect Intel(R) Optane(TM) DC Persistent Memory related performance statis * [`collectd::plugin::df`](#collectd--plugin--df): https://collectd.org/wiki/index.php/Plugin:DF * [`collectd::plugin::disk`](#collectd--plugin--disk): https://collectd.org/wiki/index.php/Plugin:Disk * [`collectd::plugin::dns`](#collectd--plugin--dns): Class: collectd::plugin::dns * [`collectd::plugin::dpdk_telemetry`](#collectd--plugin--dpdk_telemetry): Class to manage dpdk_telemetry plugin for collectd. The dpdk_telemetry plugin collects DPDK ethernet device metrics via dpdk_telemetry libra * [`collectd::plugin::entropy`](#collectd--plugin--entropy): https://collectd.org/wiki/index.php/Plugin:Entropy * [`collectd::plugin::ethstat`](#collectd--plugin--ethstat): https://collectd.org/wiki/index.php/Plugin:Ethstat * [`collectd::plugin::exec`](#collectd--plugin--exec): See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_exec * [`collectd::plugin::fhcount`](#collectd--plugin--fhcount): https://collectd.org/wiki/index.php/Plugin:Fhcount * [`collectd::plugin::filecount`](#collectd--plugin--filecount): https://collectd.org/wiki/index.php/Plugin:FileCount * [`collectd::plugin::filter`](#collectd--plugin--filter): https://collectd.org/wiki/index.php/Chains * [`collectd::plugin::fscache`](#collectd--plugin--fscache): https://collectd.org/wiki/index.php/Plugin:FSCache * [`collectd::plugin::genericjmx`](#collectd--plugin--genericjmx): https://collectd.org/wiki/index.php/Plugin:GenericJMX * [`collectd::plugin::hddtemp`](#collectd--plugin--hddtemp): https://collectd.org/wiki/index.php/Plugin:HDDTemp * [`collectd::plugin::hugepages`](#collectd--plugin--hugepages): == Class: collectd::plugin::hugepages Class to manage hugepages write plugin for collectd Documentation: https://collectd.org/documentati * [`collectd::plugin::intel_pmu`](#collectd--plugin--intel_pmu): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_intel_pmu * [`collectd::plugin::intel_rdt`](#collectd--plugin--intel_rdt): == Class: collectd::plugin::intel_rdt Class to manage intel_rdt write plugin for collectd Documentation: https://collectd.org/documentati * [`collectd::plugin::interface`](#collectd--plugin--interface): https://collectd.org/wiki/index.php/Plugin:Interface * [`collectd::plugin::ipc`](#collectd--plugin--ipc): == Class: collectd::plugin::ipc Class to manage ipc write plugin for collectd Documentation: https://collectd.org/documentation/manpages/ * [`collectd::plugin::ipmi`](#collectd--plugin--ipmi): https://collectd.org/wiki/index.php/Plugin:IPMI * [`collectd::plugin::iptables`](#collectd--plugin--iptables): https://collectd.org/wiki/index.php/Plugin:IPTables * [`collectd::plugin::irq`](#collectd--plugin--irq): https://collectd.org/wiki/index.php/Plugin:IRQ * [`collectd::plugin::iscdhcp`](#collectd--plugin--iscdhcp): Class: collectd::plugin::iscdhcp * [`collectd::plugin::java`](#collectd--plugin--java): https://collectd.org/wiki/index.php/Plugin:Java * [`collectd::plugin::load`](#collectd--plugin--load): https://collectd.org/wiki/index.php/Plugin:Load * [`collectd::plugin::logfile`](#collectd--plugin--logfile): https://collectd.org/wiki/index.php/Plugin:LogFile * [`collectd::plugin::logparser`](#collectd--plugin--logparser): https://wiki.opnfv.org/display/fastpath/Logparser+plugin+HLD * [`collectd::plugin::lvm`](#collectd--plugin--lvm): https://collectd.org/wiki/index.php/Plugin:LVM * [`collectd::plugin::mcelog`](#collectd--plugin--mcelog): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_mcelog * [`collectd::plugin::memcached`](#collectd--plugin--memcached): https://collectd.org/wiki/index.php/Plugin:memcached * [`collectd::plugin::memory`](#collectd--plugin--memory): https://collectd.org/wiki/index.php/Plugin:Memory * [`collectd::plugin::modbus`](#collectd--plugin--modbus): Install and configure the modbus plugin * [`collectd::plugin::mongodb`](#collectd--plugin--mongodb): Class: collectd::plugin::mongodb * [`collectd::plugin::mysql`](#collectd--plugin--mysql): MySQL plugin https://collectd.org/wiki/index.php/Plugin:MySQL * [`collectd::plugin::netlink`](#collectd--plugin--netlink): https://collectd.org/wiki/index.php/Plugin:Netlink * [`collectd::plugin::network`](#collectd--plugin--network): https://collectd.org/wiki/index.php/Plugin:Network * [`collectd::plugin::nfs`](#collectd--plugin--nfs): https://collectd.org/wiki/index.php/Plugin:NFS * [`collectd::plugin::nginx`](#collectd--plugin--nginx): https://collectd.org/wiki/index.php/Plugin:nginx * [`collectd::plugin::ntpd`](#collectd--plugin--ntpd): https://collectd.org/wiki/index.php/Plugin:NTPd * [`collectd::plugin::numa`](#collectd--plugin--numa): == Class: collectd::plugin::numa Class to manage numa write plugin for collectd Documentation: https://collectd.org/documentation/manpage * [`collectd::plugin::nut`](#collectd--plugin--nut): https://collectd.org/wiki/index.php/Plugin:Nut * [`collectd::plugin::openldap`](#collectd--plugin--openldap): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_openldap * [`collectd::plugin::openvpn`](#collectd--plugin--openvpn): https://collectd.org/wiki/index.php/Plugin:OpenVPN * [`collectd::plugin::oracle`](#collectd--plugin--oracle): Oracle plugin https://collectd.org/wiki/index.php/Plugin:Oracle * [`collectd::plugin::ovs_events`](#collectd--plugin--ovs_events): == Class: collectd::plugin::ovs_events Class to manage ovs_events plugin for collectd Documentation: https://collectd.org/documentation/m * [`collectd::plugin::ovs_stats`](#collectd--plugin--ovs_stats): == Class: collectd::plugin::ovs_stats Class to manage ovs_stats plugin for collectd Documentation: https://collectd.org/documentation/man * [`collectd::plugin::pcie_errors`](#collectd--plugin--pcie_errors): Class to manage pcie_errors plugin for collectd * [`collectd::plugin::perl`](#collectd--plugin--perl): See http://collectd.org/documentation/manpages/collectd-perl.5.shtml * [`collectd::plugin::ping`](#collectd--plugin--ping): See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ping * [`collectd::plugin::postgresql`](#collectd--plugin--postgresql): https://collectd.org/wiki/index.php/Plugin:PostgreSQL * [`collectd::plugin::powerdns`](#collectd--plugin--powerdns): See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_powerdns * [`collectd::plugin::processes`](#collectd--plugin--processes): See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_processes * [`collectd::plugin::procevent`](#collectd--plugin--procevent): == Class: collectd::plugin::procevent Class to manage procevent plugin for collectd Documentation: https://collectd.org/documentation/man * [`collectd::plugin::protocols`](#collectd--plugin--protocols): See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_protocols * [`collectd::plugin::python`](#collectd--plugin--python): See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_python * [`collectd::plugin::rabbitmq`](#collectd--plugin--rabbitmq): rabbitmq plugin https://pypi.python.org/pypi/collectd-rabbitmq == Class collectd::plugin::rabbitmq Configures rabbitmq metrics collection. * [`collectd::plugin::redis`](#collectd--plugin--redis): https://collectd.org/wiki/index.php/Plugin:Redis * [`collectd::plugin::rrdcached`](#collectd--plugin--rrdcached): https://collectd.org/wiki/index.php/Rrdcached * [`collectd::plugin::rrdtool`](#collectd--plugin--rrdtool): https://collectd.org/wiki/index.php/Plugin:RRDtool * [`collectd::plugin::sensors`](#collectd--plugin--sensors): https://collectd.org/wiki/index.php/Plugin:Sensors * [`collectd::plugin::smart`](#collectd--plugin--smart): https://collectd.org/wiki/index.php/Plugin:SMART * [`collectd::plugin::snmp`](#collectd--plugin--snmp): https://collectd.org/wiki/index.php/Plugin:SNMP * [`collectd::plugin::snmp_agent`](#collectd--plugin--snmp_agent): Class: collectd::plugin::snmp_agent * [`collectd::plugin::statsd`](#collectd--plugin--statsd): https://collectd.org/wiki/index.php/Plugin:StatsD * [`collectd::plugin::swap`](#collectd--plugin--swap): https://collectd.org/wiki/index.php/Plugin:Swap * [`collectd::plugin::sysevent`](#collectd--plugin--sysevent): == Class: collectd::plugin::sysevent Class to manage sysevent plugin for collectd Documentation: https://collectd.org/documentation/manpa * [`collectd::plugin::syslog`](#collectd--plugin--syslog): https://collectd.org/wiki/index.php/Plugin:SysLog * [`collectd::plugin::table`](#collectd--plugin--table): Load and configure the table plugin * [`collectd::plugin::tail`](#collectd--plugin--tail): Tail plugin https://collectd.org/wiki/index.php/Plugin:Tail * [`collectd::plugin::tail_csv`](#collectd--plugin--tail_csv): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_tail_csv * [`collectd::plugin::target_v5upgrade`](#collectd--plugin--target_v5upgrade): https://collectd.org/wiki/index.php/Target:v5_upgrade * [`collectd::plugin::tcpconns`](#collectd--plugin--tcpconns): https://collectd.org/wiki/index.php/Plugin:TCPConns * [`collectd::plugin::thermal`](#collectd--plugin--thermal): https://collectd.org/wiki/index.php/Plugin:thermal * [`collectd::plugin::threshold`](#collectd--plugin--threshold): http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_threshold * [`collectd::plugin::turbostat`](#collectd--plugin--turbostat): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_turbostat * [`collectd::plugin::unixsock`](#collectd--plugin--unixsock): https://collectd.org/wiki/index.php/Plugin:UnixSock * [`collectd::plugin::uptime`](#collectd--plugin--uptime): https://collectd.org/wiki/index.php/Plugin:Uptime * [`collectd::plugin::users`](#collectd--plugin--users): https://collectd.org/wiki/index.php/Plugin:Users * [`collectd::plugin::uuid`](#collectd--plugin--uuid): https://collectd.org/wiki/index.php/Plugin:UUID * [`collectd::plugin::varnish`](#collectd--plugin--varnish): https://collectd.org/wiki/index.php/Plugin:Varnish * [`collectd::plugin::virt`](#collectd--plugin--virt): https://collectd.org/wiki/index.php/Plugin:virt * [`collectd::plugin::vmem`](#collectd--plugin--vmem): https://collectd.org/wiki/index.php/Plugin:vmem * [`collectd::plugin::write_graphite`](#collectd--plugin--write_graphite): https://collectd.org/wiki/index.php/Graphite * [`collectd::plugin::write_http`](#collectd--plugin--write_http): Enable write_http plugin * [`collectd::plugin::write_kafka`](#collectd--plugin--write_kafka) * [`collectd::plugin::write_log`](#collectd--plugin--write_log) * [`collectd::plugin::write_network`](#collectd--plugin--write_network): A define to make a generic network output for collectd * [`collectd::plugin::write_prometheus`](#collectd--plugin--write_prometheus): Configures write_prometheus plugin. * [`collectd::plugin::write_riemann`](#collectd--plugin--write_riemann): https://collectd.org/wiki/index.php/Plugin:Write_Riemann * [`collectd::plugin::write_sensu`](#collectd--plugin--write_sensu): https://collectd.org/wiki/index.php/Plugin:Write_Sensu * [`collectd::plugin::write_tsdb`](#collectd--plugin--write_tsdb): https://collectd.org/wiki/index.php/Plugin:Write_TSDB * [`collectd::plugin::zfs_arc`](#collectd--plugin--zfs_arc): https://collectd.org/wiki/index.php/Plugin:ZFS_ARC * [`collectd::plugin::zookeeper`](#collectd--plugin--zookeeper) * [`collectd::repo`](#collectd--repo): collectd::repo Handle package repo configuration * [`collectd::repo::debian`](#collectd--repo--debian) * [`collectd::repo::redhat`](#collectd--repo--redhat) * [`collectd::service`](#collectd--service) #### Private Classes * `collectd::install`: installs collectd ### Defined types * [`collectd::plugin`](#collectd--plugin) * [`collectd::plugin::aggregation::aggregator`](#collectd--plugin--aggregation--aggregator) * [`collectd::plugin::apache::instance`](#collectd--plugin--apache--instance): https://collectd.org/wiki/index.php/Plugin:Apache * [`collectd::plugin::curl::page`](#collectd--plugin--curl--page) * [`collectd::plugin::curl_json`](#collectd--plugin--curl_json): See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_curl_json * [`collectd::plugin::dbi::database`](#collectd--plugin--dbi--database): database allows you to create blocks with the same name of database, * [`collectd::plugin::dbi::query`](#collectd--plugin--dbi--query) * [`collectd::plugin::exec::cmd`](#collectd--plugin--exec--cmd) * [`collectd::plugin::filecount::directory`](#collectd--plugin--filecount--directory): https://collectd.org/wiki/index.php/Plugin:FileCount * [`collectd::plugin::filter::chain`](#collectd--plugin--filter--chain): https://collectd.org/wiki/index.php/Chains * [`collectd::plugin::filter::match`](#collectd--plugin--filter--match): https://collectd.org/wiki/index.php/Chains * [`collectd::plugin::filter::rule`](#collectd--plugin--filter--rule): https://collectd.org/wiki/index.php/Chains * [`collectd::plugin::filter::target`](#collectd--plugin--filter--target): https://collectd.org/wiki/index.php/Chains * [`collectd::plugin::genericjmx::connection`](#collectd--plugin--genericjmx--connection): https://collectd.org/wiki/index.php/Plugin:GenericJMX * [`collectd::plugin::genericjmx::mbean`](#collectd--plugin--genericjmx--mbean): https://collectd.org/wiki/index.php/Plugin:GenericJMX * [`collectd::plugin::mysql::database`](#collectd--plugin--mysql--database) * [`collectd::plugin::network::listener`](#collectd--plugin--network--listener) * [`collectd::plugin::network::server`](#collectd--plugin--network--server) * [`collectd::plugin::nut::ups`](#collectd--plugin--nut--ups) * [`collectd::plugin::oracle::database`](#collectd--plugin--oracle--database): https://collectd.org/wiki/index.php/Plugin:Oracle * [`collectd::plugin::oracle::query`](#collectd--plugin--oracle--query): https://collectd.org/wiki/index.php/Plugin:Oracle * [`collectd::plugin::perl::plugin`](#collectd--plugin--perl--plugin) * [`collectd::plugin::postgresql::database`](#collectd--plugin--postgresql--database): databasename allows you to create blocks with the same name of database, useful if you have multiple instances of different versio * [`collectd::plugin::postgresql::query`](#collectd--plugin--postgresql--query) * [`collectd::plugin::postgresql::writer`](#collectd--plugin--postgresql--writer) * [`collectd::plugin::powerdns::recursor`](#collectd--plugin--powerdns--recursor) * [`collectd::plugin::powerdns::server`](#collectd--plugin--powerdns--server) * [`collectd::plugin::processes::process`](#collectd--plugin--processes--process) * [`collectd::plugin::processes::processmatch`](#collectd--plugin--processes--processmatch) * [`collectd::plugin::python::module`](#collectd--plugin--python--module): Single module definition * [`collectd::plugin::snmp::data`](#collectd--plugin--snmp--data): https://collectd.org/wiki/index.php/Plugin:SNMP * [`collectd::plugin::snmp::host`](#collectd--plugin--snmp--host): https://collectd.org/wiki/index.php/Plugin:SNMP * [`collectd::plugin::table::table`](#collectd--plugin--table--table): table definition for table plugin * [`collectd::plugin::tail::file`](#collectd--plugin--tail--file) * [`collectd::plugin::write_graphite::carbon`](#collectd--plugin--write_graphite--carbon): a single graphite backend * [`collectd::type`](#collectd--type) * [`collectd::typesdb`](#collectd--typesdb): This define initialize a collectd typesdb file ### Functions * [`collectd::indent`](#collectd--indent) * [`collectd_convert_processes`](#collectd_convert_processes): Converts the array from the old style to define process or processmatch in the processes plugin into a create_resources compatible hash which ### Data types * [`Collectd::Amqp::Format`](#Collectd--Amqp--Format): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_amqp * [`Collectd::Bind::View`](#Collectd--Bind--View): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_bind * [`Collectd::Filter::Builtintarget`](#Collectd--Filter--Builtintarget): https://collectd.org/wiki/index.php/Chains#Built-in_targets * [`Collectd::Filter::Match`](#Collectd--Filter--Match): https://collectd.org/wiki/index.php/Table_of_Matches * [`Collectd::Filter::Plugintarget`](#Collectd--Filter--Plugintarget): https://collectd.org/wiki/index.php/Table_of_Targets * [`Collectd::Filter::Target`](#Collectd--Filter--Target): https://collectd.org/wiki/index.php/Chains * [`Collectd::LOGPARSER::Logfile`](#Collectd--LOGPARSER--Logfile): https://wiki.opnfv.org/display/fastpath/Logparser+plugin+HLD * [`Collectd::LOGPARSER::Match`](#Collectd--LOGPARSER--Match): https://wiki.opnfv.org/display/fastpath/Logparser+plugin+HLD * [`Collectd::LOGPARSER::Message`](#Collectd--LOGPARSER--Message): https://wiki.opnfv.org/display/fastpath/Logparser+plugin+HLD * [`Collectd::MCELOG::Memory`](#Collectd--MCELOG--Memory): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_mcelog * [`Collectd::Manifests::Init`](#Collectd--Manifests--Init) * [`Collectd::Modbus::Data`](#Collectd--Modbus--Data): represents a modbus data entry * [`Collectd::Modbus::Host`](#Collectd--Modbus--Host): represents a modbus host entry * [`Collectd::Modbus::Slave`](#Collectd--Modbus--Slave): Represents a modbus host's slave entry * [`Collectd::Network::SecurityLevel`](#Collectd--Network--SecurityLevel) * [`Collectd::Redis::Node`](#Collectd--Redis--Node) * [`Collectd::SNMP::AuthProtocol`](#Collectd--SNMP--AuthProtocol) * [`Collectd::SNMP::Data`](#Collectd--SNMP--Data) * [`Collectd::SNMP::Host`](#Collectd--SNMP--Host) * [`Collectd::SNMP::Host::V2`](#Collectd--SNMP--Host--V2) * [`Collectd::SNMP::Host::V3`](#Collectd--SNMP--Host--V3) * [`Collectd::SNMP::PrivacyProtocol`](#Collectd--SNMP--PrivacyProtocol) * [`Collectd::SNMP::SecurityLevel`](#Collectd--SNMP--SecurityLevel) * [`Collectd::SNMP::Version`](#Collectd--SNMP--Version) * [`Collectd::SNMP::Version::V2`](#Collectd--SNMP--Version--V2) * [`Collectd::SNMP::Version::V3`](#Collectd--SNMP--Version--V3) * [`Collectd::SNMP_AGENT::Data`](#Collectd--SNMP_AGENT--Data): https://wiki.opnfv.org/display/fastpath/SNMP+Agent+HLD * [`Collectd::SNMP_AGENT::IndexKey`](#Collectd--SNMP_AGENT--IndexKey): https://wiki.opnfv.org/display/fastpath/SNMP+Agent+HLD * [`Collectd::SNMP_AGENT::Table`](#Collectd--SNMP_AGENT--Table): https://wiki.opnfv.org/display/fastpath/SNMP+Agent+HLD * [`Collectd::Table::Result`](#Collectd--Table--Result): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_table * [`Collectd::Table::Table`](#Collectd--Table--Table): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_table * [`Collectd::Tail_Csv::File`](#Collectd--Tail_Csv--File): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_tail_csv * [`Collectd::Tail_Csv::Metric`](#Collectd--Tail_Csv--Metric): https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_tail_csv * [`Collectd::Threshold::Host`](#Collectd--Threshold--Host) * [`Collectd::Threshold::Plugin`](#Collectd--Threshold--Plugin) * [`Collectd::Threshold::Type`](#Collectd--Threshold--Type) * [`Collectd::Write_riemann::Node`](#Collectd--Write_riemann--Node) ### Tasks * [`getval`](#getval): Get a particular metric for a host * [`listval`](#listval): Lists all available collectd metrics ## Classes ### `collectd` installs and configures collectd #### Examples ##### Install collectd utilities ```puppet class{'collectd': utils => true, } ``` #### Parameters The following parameters are available in the `collectd` class: * [`utils`](#-collectd--utils) * [`autoloadplugin`](#-collectd--autoloadplugin) * [`collectd_hostname`](#-collectd--collectd_hostname) * [`conf_content`](#-collectd--conf_content) * [`config_file`](#-collectd--config_file) * [`fqdnlookup`](#-collectd--fqdnlookup) * [`has_wordexp`](#-collectd--has_wordexp) * [`include`](#-collectd--include) * [`interval`](#-collectd--interval) * [`internal_stats`](#-collectd--internal_stats) * [`manage_package`](#-collectd--manage_package) * [`manage_repo`](#-collectd--manage_repo) * [`ci_package_repo`](#-collectd--ci_package_repo) * [`manage_service`](#-collectd--manage_service) * [`minimum_version`](#-collectd--minimum_version) * [`package_ensure`](#-collectd--package_ensure) * [`package_install_options`](#-collectd--package_install_options) * [`package_keyserver`](#-collectd--package_keyserver) * [`package_name`](#-collectd--package_name) * [`package_provider`](#-collectd--package_provider) * [`plugin_conf_dir`](#-collectd--plugin_conf_dir) * [`plugin_conf_dir_mode`](#-collectd--plugin_conf_dir_mode) * [`purge`](#-collectd--purge) * [`purge_config`](#-collectd--purge_config) * [`read_threads`](#-collectd--read_threads) * [`recurse`](#-collectd--recurse) * [`config_group`](#-collectd--config_group) * [`config_mode`](#-collectd--config_mode) * [`config_owner`](#-collectd--config_owner) * [`service_enable`](#-collectd--service_enable) * [`service_ensure`](#-collectd--service_ensure) * [`service_name`](#-collectd--service_name) * [`timeout`](#-collectd--timeout) * [`typesdb`](#-collectd--typesdb) * [`write_queue_limit_high`](#-collectd--write_queue_limit_high) * [`write_queue_limit_low`](#-collectd--write_queue_limit_low) * [`write_threads`](#-collectd--write_threads) ##### `utils` Data type: `Boolean` Install collectd utilities package containing collectdctl, collectd-nagios Default value: `$collectd::params::utils` ##### `autoloadplugin` Data type: `Boolean` Default value: `$collectd::params::autoloadplugin` ##### `collectd_hostname` Data type: `String` Default value: `$collectd::params::collectd_hostname` ##### `conf_content` Data type: `Optional[String]` Default value: `$collectd::params::conf_content` ##### `config_file` Data type: `String` Default value: `$collectd::params::config_file` ##### `fqdnlookup` Data type: `Boolean` Default value: `$collectd::params::fqdnlookup` ##### `has_wordexp` Data type: `Boolean` Default value: `$collectd::params::has_wordexp` ##### `include` Data type: `Array` Default value: `$collectd::params::include` ##### `interval` Data type: `Integer[1]` Default value: `$collectd::params::interval` ##### `internal_stats` Data type: `Boolean` Default value: `$collectd::params::internal_stats` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::params::manage_package` ##### `manage_repo` Data type: `Boolean` Default value: `$collectd::params::manage_repo` ##### `ci_package_repo` Data type: `Optional[Collectd::Manifests::Init]` Default value: `$collectd::params::ci_package_repo` ##### `manage_service` Data type: `Boolean` Default value: `$collectd::params::manage_service` ##### `minimum_version` Data type: `String` Default value: `$collectd::params::minimum_version` ##### `package_ensure` Data type: `String` Default value: `$collectd::params::package_ensure` ##### `package_install_options` Data type: `Optional[Array]` Default value: `$collectd::params::package_install_options` ##### `package_keyserver` Data type: `Stdlib::Fqdn` Default value: `$collectd::params::package_keyserver` ##### `package_name` Data type: `Variant[String[1],Array[String[1]]]` Default value: `$collectd::params::package_name` ##### `package_provider` Data type: `Optional[String]` Default value: `$collectd::params::package_provider` ##### `plugin_conf_dir` Data type: `Stdlib::Absolutepath` Default value: `$collectd::params::plugin_conf_dir` ##### `plugin_conf_dir_mode` Data type: `String` Default value: `$collectd::params::plugin_conf_dir_mode` ##### `purge` Data type: `Boolean` Default value: `$collectd::params::purge` ##### `purge_config` Data type: `Boolean` Default value: `$collectd::params::purge_config` ##### `read_threads` Data type: `Integer[1]` Default value: `$collectd::params::read_threads` ##### `recurse` Data type: `Boolean` Default value: `$collectd::params::recurse` ##### `config_group` Data type: `String` Default value: `$collectd::params::config_group` ##### `config_mode` Data type: `String` Default value: `$collectd::params::config_mode` ##### `config_owner` Data type: `String` Default value: `$collectd::params::config_owner` ##### `service_enable` Data type: `Boolean` Default value: `$collectd::params::service_enable` ##### `service_ensure` Data type: `String` Default value: `$collectd::params::service_ensure` ##### `service_name` Data type: `String` Default value: `$collectd::params::service_name` ##### `timeout` Data type: `Integer[1]` Default value: `$collectd::params::timeout` ##### `typesdb` Data type: `Array` Default value: `$collectd::params::typesdb` ##### `write_queue_limit_high` Data type: `Optional[Integer]` Default value: `$collectd::params::write_queue_limit_high` ##### `write_queue_limit_low` Data type: `Optional[Integer]` Default value: `$collectd::params::write_queue_limit_low` ##### `write_threads` Data type: `Integer[1]` Default value: `$collectd::params::write_threads` ### `collectd::config` private ### `collectd::params` The collectd::params class. ### `collectd::plugin::aggregation` collectd::plugin::aggregation #### Parameters The following parameters are available in the `collectd::plugin::aggregation` class: * [`ensure`](#-collectd--plugin--aggregation--ensure) * [`interval`](#-collectd--plugin--aggregation--interval) * [`aggregators`](#-collectd--plugin--aggregation--aggregators) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ##### `aggregators` Data type: `Hash` Default value: `{}` ### `collectd::plugin::amqp` https://collectd.org/wiki/index.php/Plugin:AMQP #### Parameters The following parameters are available in the `collectd::plugin::amqp` class: * [`ensure`](#-collectd--plugin--amqp--ensure) * [`manage_package`](#-collectd--plugin--amqp--manage_package) * [`amqphost`](#-collectd--plugin--amqp--amqphost) * [`amqpport`](#-collectd--plugin--amqp--amqpport) * [`amqpvhost`](#-collectd--plugin--amqp--amqpvhost) * [`amqpuser`](#-collectd--plugin--amqp--amqpuser) * [`amqppass`](#-collectd--plugin--amqp--amqppass) * [`amqpformat`](#-collectd--plugin--amqp--amqpformat) * [`amqpstorerates`](#-collectd--plugin--amqp--amqpstorerates) * [`amqpexchange`](#-collectd--plugin--amqp--amqpexchange) * [`amqppersistent`](#-collectd--plugin--amqp--amqppersistent) * [`amqproutingkey`](#-collectd--plugin--amqp--amqproutingkey) * [`graphiteprefix`](#-collectd--plugin--amqp--graphiteprefix) * [`escapecharacter`](#-collectd--plugin--amqp--escapecharacter) * [`interval`](#-collectd--plugin--amqp--interval) * [`graphiteseparateinstances`](#-collectd--plugin--amqp--graphiteseparateinstances) * [`graphitealwaysappendds`](#-collectd--plugin--amqp--graphitealwaysappendds) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `amqphost` Data type: `Stdlib::Host` Default value: `'localhost'` ##### `amqpport` Data type: `Stdlib::Port` Default value: `5672` ##### `amqpvhost` Data type: `String` Default value: `'graphite'` ##### `amqpuser` Data type: `String` Default value: `'graphite'` ##### `amqppass` Data type: `String` Default value: `'graphite'` ##### `amqpformat` Data type: `Collectd::Amqp::Format` Default value: `'Graphite'` ##### `amqpstorerates` Data type: `Boolean` Default value: `false` ##### `amqpexchange` Data type: `String` Default value: `'metrics'` ##### `amqppersistent` Data type: `Boolean` Default value: `true` ##### `amqproutingkey` Data type: `String` Default value: `'collectd'` ##### `graphiteprefix` Data type: `String` Default value: `'collectd.'` ##### `escapecharacter` Data type: `String[1]` Default value: `'_'` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ##### `graphiteseparateinstances` Data type: `Boolean` Default value: `false` ##### `graphitealwaysappendds` Data type: `Boolean` Default value: `false` ### `collectd::plugin::amqp1` == Class: collectd::plugin::amqp1 Class to manage amqp1 write plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_amqp1 === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' [*manage_package*] Set to true if Puppet should manage plugin package installation. Defaults to $collectd::manage_package [*transport*] Name of the transport. Default to 'metrics' [*host*] Hostname or IP address of the AMQP 1.0 intermediary. Defaults to the 'localhost' [*port*] Service name or port number on which the AMQP 1.0 intermediary accepts connections. This argument must be a string, even if the numeric form is used. Defaults to 5672 [*user*] User part of credentials used to authenticate to the AMQP 1.0 intermediary. Defaults to 'guest' [*password*] Password part of credentials used to authenticate to the AMQP 1.0 intermediary. Defaults to 'guest' [*address*] This option specifies the prefix for the send-to value in the message. Defaults to 'collectd' [*retry_delay*] When the AMQP1 connection is lost, defines the time in seconds to wait before attempting to reconnect. Defaults to 1 [*send_queue_limit*] Limits the SentQueue to a defined value, helps to keep memory usage low when the write target does not respond. [*interval*] Interval setting for the plugin Defaults to undef [*instances*] Hash of Hashes representing Instance blocks in plugin configuration file. Key of outter hash represents instance name. The 'address' value concatenated with the 'name' given will be used as the send-to address for communications over the messaging link. Only following keys on inner hashes are taken into account: - format (string): 'Command'|'JSON'|'Graphite'; defines format in which messages are sent to the intermediary - presettle (bool): If set to false (the default), the plugin will wait for a message acknowledgement from the messaging bus before sending the next message. Otherwise the plugin will not wait for a message acknowledgement. - notify (bool): If set to false (the default), the plugin will service the instance write call back as a value list. If set to true the plugin will service the instance as a write notification callback for alert formatting. - store_rates (bool): Determines whether or not COUNTER, DERIVE and ABSOLUTE data sources are converted to a rate (GAUGE value). If set to false (the default), no conversion is performed. Otherwise the conversion is performed using the internal value cache. Please note that currently this option is only used if the 'format' option has been set to 'JSON'. - graphite_prefix (string): A prefix can be added in the metric name when outputting in the 'Graphite' format. It's added before the host name. - graphite_postfix (string): A postfix can be added in the metric name when outputting in the 'Graphite' format. It's added after the host name. - graphite_escape_char (string): Specify a character to replace dots in the host part of the metric name. In 'Graphite' metric name, dots are used as separators between different metric parts (host, plugin, type). Default is '_'. - graphite_separate_instances (bool): If set to true, the plugin instance and type instance will be in their own path component, for example 'host.cpu.0.cpu.idle'. If set to false (the default), the plugin and plugin instance (and likewise the type and type instance) are put into one component, for example 'host.cpu-0.cpu-idle'. - graphite_always_append_ds (bool): If set to true, append the name of the data Source> (DS) to the 'metric' identifier. If set to false (the default), this is only done when there is more than one DS. - graphite_preserve_separator (bool): If set to false (the default) the dot character is replaced with GraphiteEscapeChar. Otherwise, if set to true, the dot character is preserved, i.e. passed through. #### Parameters The following parameters are available in the `collectd::plugin::amqp1` class: * [`ensure`](#-collectd--plugin--amqp1--ensure) * [`manage_package`](#-collectd--plugin--amqp1--manage_package) * [`transport`](#-collectd--plugin--amqp1--transport) * [`host`](#-collectd--plugin--amqp1--host) * [`port`](#-collectd--plugin--amqp1--port) * [`user`](#-collectd--plugin--amqp1--user) * [`password`](#-collectd--plugin--amqp1--password) * [`address`](#-collectd--plugin--amqp1--address) * [`instances`](#-collectd--plugin--amqp1--instances) * [`retry_delay`](#-collectd--plugin--amqp1--retry_delay) * [`send_queue_limit`](#-collectd--plugin--amqp1--send_queue_limit) * [`interval`](#-collectd--plugin--amqp1--interval) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `transport` Data type: `String` Default value: `'metrics'` ##### `host` Data type: `Stdlib::Host` Default value: `'localhost'` ##### `port` Data type: `Stdlib::Port` Default value: `5672` ##### `user` Data type: `String` Default value: `'guest'` ##### `password` Data type: `String` Default value: `'guest'` ##### `address` Data type: `String` Default value: `'collectd'` ##### `instances` Data type: `Hash` Default value: `{}` ##### `retry_delay` Data type: `Optional[Integer]` Default value: `undef` ##### `send_queue_limit` Data type: `Optional[Integer[0]]` Default value: `undef` ##### `interval` Data type: `Optional[Integer]` Default value: `undef` ### `collectd::plugin::apache` https://collectd.org/wiki/index.php/Plugin:Apache #### Parameters The following parameters are available in the `collectd::plugin::apache` class: * [`ensure`](#-collectd--plugin--apache--ensure) * [`manage_package`](#-collectd--plugin--apache--manage_package) * [`instances`](#-collectd--plugin--apache--instances) * [`interval`](#-collectd--plugin--apache--interval) * [`package_install_options`](#-collectd--plugin--apache--package_install_options) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `instances` Data type: `Hash` Default value: `{ 'localhost' => { 'url' => 'http://localhost/mod_status?auto' } }` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ##### `package_install_options` Data type: `Optional[Array]` Default value: `$collectd::package_install_options` ### `collectd::plugin::battery` == Class: collectd::plugin::battery Class to manage battery write plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_battery === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' [*interval*] Interval setting for the plugin Defaults to undef [*values_percentage*] When enabled, remaining capacity is reported as a percentage instead of raw data (most likely in "Wh") Defaults to false [*report_degraded*] When set to true, the battery plugin will report three values: charged (remaining capacity), discharged (difference between "last full capacity" and "remaining capacity") and degraded (difference between "design capacity" and "last full capacity"). Otherwise only the remaining capacity is reported. Defaults to false [*query_state_fs*] When set to true, the battery plugin will only read statistics related to battery performance as exposed by StateFS at /run/state. Defaults to false #### Parameters The following parameters are available in the `collectd::plugin::battery` class: * [`ensure`](#-collectd--plugin--battery--ensure) * [`interval`](#-collectd--plugin--battery--interval) * [`values_percentage`](#-collectd--plugin--battery--values_percentage) * [`report_degraded`](#-collectd--plugin--battery--report_degraded) * [`query_state_fs`](#-collectd--plugin--battery--query_state_fs) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Integer]` Default value: `undef` ##### `values_percentage` Data type: `Boolean` Default value: `false` ##### `report_degraded` Data type: `Boolean` Default value: `false` ##### `query_state_fs` Data type: `Boolean` Default value: `false` ### `collectd::plugin::bind` https://collectd.org/wiki/index.php/Plugin:BIND #### Parameters The following parameters are available in the `collectd::plugin::bind` class: * [`url`](#-collectd--plugin--bind--url) * [`ensure`](#-collectd--plugin--bind--ensure) * [`manage_package`](#-collectd--plugin--bind--manage_package) * [`memorystats`](#-collectd--plugin--bind--memorystats) * [`opcodes`](#-collectd--plugin--bind--opcodes) * [`parsetime`](#-collectd--plugin--bind--parsetime) * [`qtypes`](#-collectd--plugin--bind--qtypes) * [`resolverstats`](#-collectd--plugin--bind--resolverstats) * [`serverstats`](#-collectd--plugin--bind--serverstats) * [`zonemaintstats`](#-collectd--plugin--bind--zonemaintstats) * [`views`](#-collectd--plugin--bind--views) * [`interval`](#-collectd--plugin--bind--interval) ##### `url` Data type: `Stdlib::Httpurl` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `memorystats` Data type: `Boolean` Default value: `true` ##### `opcodes` Data type: `Boolean` Default value: `true` ##### `parsetime` Data type: `Boolean` Default value: `false` ##### `qtypes` Data type: `Boolean` Default value: `true` ##### `resolverstats` Data type: `Boolean` Default value: `false` ##### `serverstats` Data type: `Boolean` Default value: `true` ##### `zonemaintstats` Data type: `Boolean` Default value: `true` ##### `views` Data type: `Array[Collectd::Bind::View]` Default value: `[]` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ### `collectd::plugin::ceph` == Class: collectd::plugin::ceph Class to manage ceph plugin for collectd === Parameters [*ensure*] ensure param for collectd::plugin type [*daemons*] array of ceph daemons to create config for (replace clustername, hostname as appropriate) example: [ '[clustername]-osd.1', '[clustername]-osd.2', '[clustername]-osd.3', '[clustername]-mon.[hostname].asok' ] [*longrunavglatency*] If enabled, latency values(sum,count pairs) are calculated as the long run average - average since the ceph daemon was started = (sum / count). i When disabled, latency values are calculated as the average since the last collection = (sum_now - sum_last) / (count_now - count_last). [*convertspecialmetrictypes*} If enabled, special metrics (metrics that differ in type from similar counters) are converted to the type of those similar counters. This currently only applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The ceph schema reports this metric type as a sum,count pair i while similar counters are treated as derive types. When converted, the sum is used as the counter value and is treated as a derive type. When disabled, all metrics are treated as the types received from the ceph schema. [*manage_package*] If enabled, manages separate package for plugin [*package_name*] to be used with manage_package; if manage_package is true, this gives the name of the package to manage. Defaults to 'collectd-ceph' [*ceph_fsid*] The Ceph cluster FSID. Must be a UUID. #### Parameters The following parameters are available in the `collectd::plugin::ceph` class: * [`daemons`](#-collectd--plugin--ceph--daemons) * [`ensure`](#-collectd--plugin--ceph--ensure) * [`longrunavglatency`](#-collectd--plugin--ceph--longrunavglatency) * [`convertspecialmetrictypes`](#-collectd--plugin--ceph--convertspecialmetrictypes) * [`manage_package`](#-collectd--plugin--ceph--manage_package) * [`package_name`](#-collectd--plugin--ceph--package_name) * [`ceph_fsid`](#-collectd--plugin--ceph--ceph_fsid) ##### `daemons` Data type: `Array` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `longrunavglatency` Data type: `Boolean` Default value: `false` ##### `convertspecialmetrictypes` Data type: `Boolean` Default value: `true` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `package_name` Data type: `String` Default value: `'collectd-ceph'` ##### `ceph_fsid` Data type: `Optional[String]` Default value: `undef` ### `collectd::plugin::cgroups` https://collectd.org/wiki/index.php/Plugin:cgroups #### Parameters The following parameters are available in the `collectd::plugin::cgroups` class: * [`cgroups`](#-collectd--plugin--cgroups--cgroups) * [`ensure`](#-collectd--plugin--cgroups--ensure) * [`ignore_selected`](#-collectd--plugin--cgroups--ignore_selected) * [`interval`](#-collectd--plugin--cgroups--interval) ##### `cgroups` Data type: `Array` Default value: `[]` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `ignore_selected` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ### `collectd::plugin::chain` The collectd::plugin::chain class. #### Parameters The following parameters are available in the `collectd::plugin::chain` class: * [`chainname`](#-collectd--plugin--chain--chainname) * [`ensure`](#-collectd--plugin--chain--ensure) * [`defaulttarget`](#-collectd--plugin--chain--defaulttarget) * [`rules`](#-collectd--plugin--chain--rules) ##### `chainname` Data type: `String` Default value: `'Main'` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `defaulttarget` Data type: `Collectd::Filter::Target` Default value: `'write'` ##### `rules` Data type: `Array` Default value: `[]` ### `collectd::plugin::connectivity` == Class: collectd::plugin::connectivity Class to manage connectivity plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_connectivity === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' [*manage_package*] Set to true if Puppet should manage plugin package installation. Defaults to $collectd::manage_package [*interfaces*] Array of interface(s) to monitor connect to. Empty arrayf means all interfaces Defaults to [] #### Parameters The following parameters are available in the `collectd::plugin::connectivity` class: * [`ensure`](#-collectd--plugin--connectivity--ensure) * [`manage_package`](#-collectd--plugin--connectivity--manage_package) * [`interfaces`](#-collectd--plugin--connectivity--interfaces) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `interfaces` Data type: `Array[String[1]]` Default value: `[]` ### `collectd::plugin::conntrack` https://collectd.org/wiki/index.php/Plugin:ConnTrack #### Parameters The following parameters are available in the `collectd::plugin::conntrack` class: * [`ensure`](#-collectd--plugin--conntrack--ensure) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ### `collectd::plugin::contextswitch` https://collectd.org/wiki/index.php/Plugin:ContextSwitch #### Parameters The following parameters are available in the `collectd::plugin::contextswitch` class: * [`ensure`](#-collectd--plugin--contextswitch--ensure) * [`interval`](#-collectd--plugin--contextswitch--interval) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ### `collectd::plugin::cpu` https://collectd.org/wiki/index.php/Plugin:CPU #### Parameters The following parameters are available in the `collectd::plugin::cpu` class: * [`ensure`](#-collectd--plugin--cpu--ensure) * [`reportbystate`](#-collectd--plugin--cpu--reportbystate) * [`reportbycpu`](#-collectd--plugin--cpu--reportbycpu) * [`valuespercentage`](#-collectd--plugin--cpu--valuespercentage) * [`reportnumcpu`](#-collectd--plugin--cpu--reportnumcpu) * [`reportgueststate`](#-collectd--plugin--cpu--reportgueststate) * [`subtractgueststate`](#-collectd--plugin--cpu--subtractgueststate) * [`interval`](#-collectd--plugin--cpu--interval) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `reportbystate` Data type: `Boolean` Default value: `true` ##### `reportbycpu` Data type: `Boolean` Default value: `true` ##### `valuespercentage` Data type: `Boolean` Default value: `false` ##### `reportnumcpu` Data type: `Boolean` Default value: `false` ##### `reportgueststate` Data type: `Boolean` Default value: `false` ##### `subtractgueststate` Data type: `Boolean` Default value: `true` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ### `collectd::plugin::cpufreq` https://collectd.org/wiki/index.php/Plugin:CPUFreq #### Parameters The following parameters are available in the `collectd::plugin::cpufreq` class: * [`ensure`](#-collectd--plugin--cpufreq--ensure) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ### `collectd::plugin::csv` https://collectd.org/wiki/index.php/Plugin:CSV #### Parameters The following parameters are available in the `collectd::plugin::csv` class: * [`ensure`](#-collectd--plugin--csv--ensure) * [`datadir`](#-collectd--plugin--csv--datadir) * [`interval`](#-collectd--plugin--csv--interval) * [`storerates`](#-collectd--plugin--csv--storerates) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `datadir` Data type: `Any` Default value: `'/etc/collectd/var/lib/collectd/csv'` ##### `interval` Data type: `Any` Default value: `undef` ##### `storerates` Data type: `Any` Default value: `false` ### `collectd::plugin::cuda` Class: collectd::plugin::cuda * **See also** * https://pypi.python.org/pypi/collectd-cuda * Configures cuda metrics collection. Optionally installs the plugin Note, it is up to you to support package installation and sources #### Parameters The following parameters are available in the `collectd::plugin::cuda` class: * [`ensure`](#-collectd--plugin--cuda--ensure) * [`manage_package`](#-collectd--plugin--cuda--manage_package) * [`package_name`](#-collectd--plugin--cuda--package_name) * [`package_provider`](#-collectd--plugin--cuda--package_provider) * [`provider_proxy`](#-collectd--plugin--cuda--provider_proxy) ##### `ensure` Data type: `Enum['present', 'absent']` Passed to package and collectd::plugin resources (both) Default value: `'present'` ##### `manage_package` Data type: `Optional[Boolean]` Toggles installation of plugin Default value: `undef` ##### `package_name` Data type: `String[1]` Name of plugin package to install Default value: `'collectd-cuda'` ##### `package_provider` Data type: `Optional[String[1]]` Passed to package resource Default value: `undef` ##### `provider_proxy` Data type: `Optional[String[1]]` Proxy for provider Default value: `undef` ### `collectd::plugin::curl` The collectd::plugin::curl class. #### Parameters The following parameters are available in the `collectd::plugin::curl` class: * [`ensure`](#-collectd--plugin--curl--ensure) * [`manage_package`](#-collectd--plugin--curl--manage_package) * [`interval`](#-collectd--plugin--curl--interval) * [`pages`](#-collectd--plugin--curl--pages) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `pages` Data type: `Any` Default value: `{}` ### `collectd::plugin::dbi` https://collectd.org/wiki/index.php/Plugin:DBI #### Parameters The following parameters are available in the `collectd::plugin::dbi` class: * [`ensure`](#-collectd--plugin--dbi--ensure) * [`databases`](#-collectd--plugin--dbi--databases) * [`queries`](#-collectd--plugin--dbi--queries) * [`packages`](#-collectd--plugin--dbi--packages) * [`interval`](#-collectd--plugin--dbi--interval) * [`manage_package`](#-collectd--plugin--dbi--manage_package) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `databases` Data type: `Any` Default value: `{}` ##### `queries` Data type: `Any` Default value: `{}` ##### `packages` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `manage_package` Data type: `Any` Default value: `undef` ### `collectd::plugin::dcpmm` Class to manage dcpmm plugin for collectd. The dcpmm plugin will collect Intel(R) Optane(TM) DC Persistent Memory related performance statistics. Plugin requires root privileges to perform the statistics collection. #### Parameters The following parameters are available in the `collectd::plugin::dcpmm` class: * [`ensure`](#-collectd--plugin--dcpmm--ensure) * [`interval`](#-collectd--plugin--dcpmm--interval) * [`collect_health`](#-collectd--plugin--dcpmm--collect_health) * [`collect_perf_metrics`](#-collectd--plugin--dcpmm--collect_perf_metrics) * [`enable_dispatch_all`](#-collectd--plugin--dcpmm--enable_dispatch_all) ##### `ensure` Data type: `Enum['present', 'absent']` Ensure param for collectd::plugin type. Default value: `'present'` ##### `interval` Data type: `Float` Sets interval (in seconds) in which the values will be collected. Default value: `10.0` ##### `collect_health` Data type: `Boolean` Collects health information. collect_health and collect_perf_metrics cannot be true at the same time. Default value: `false` ##### `collect_perf_metrics` Data type: `Boolean` Collects memory performance metrics. collect_health and collect_perf_metrics cannot be true at the same time. Default value: `true` ##### `enable_dispatch_all` Data type: `Boolean` This parameter helps to seamlessly enable simultaneous health and memory perf metrics collection in future. Unused at the moment and must always be false. Default value: `false` ### `collectd::plugin::df` https://collectd.org/wiki/index.php/Plugin:DF #### Parameters The following parameters are available in the `collectd::plugin::df` class: * [`ensure`](#-collectd--plugin--df--ensure) * [`devices`](#-collectd--plugin--df--devices) * [`fstypes`](#-collectd--plugin--df--fstypes) * [`ignoreselected`](#-collectd--plugin--df--ignoreselected) * [`interval`](#-collectd--plugin--df--interval) * [`mountpoints`](#-collectd--plugin--df--mountpoints) * [`reportbydevice`](#-collectd--plugin--df--reportbydevice) * [`reportinodes`](#-collectd--plugin--df--reportinodes) * [`reportreserved`](#-collectd--plugin--df--reportreserved) * [`valuesabsolute`](#-collectd--plugin--df--valuesabsolute) * [`valuespercentage`](#-collectd--plugin--df--valuespercentage) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `devices` Data type: `Array` Default value: `[]` ##### `fstypes` Data type: `Array` Default value: `[]` ##### `ignoreselected` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ##### `mountpoints` Data type: `Array` Default value: `[]` ##### `reportbydevice` Data type: `Boolean` Default value: `false` ##### `reportinodes` Data type: `Boolean` Default value: `true` ##### `reportreserved` Data type: `Boolean` Default value: `true` ##### `valuesabsolute` Data type: `Boolean` Default value: `true` ##### `valuespercentage` Data type: `Boolean` Default value: `false` ### `collectd::plugin::disk` https://collectd.org/wiki/index.php/Plugin:Disk #### Parameters The following parameters are available in the `collectd::plugin::disk` class: * [`disks`](#-collectd--plugin--disk--disks) * [`ensure`](#-collectd--plugin--disk--ensure) * [`ignoreselected`](#-collectd--plugin--disk--ignoreselected) * [`interval`](#-collectd--plugin--disk--interval) * [`manage_package`](#-collectd--plugin--disk--manage_package) * [`package_name`](#-collectd--plugin--disk--package_name) * [`udevnameattr`](#-collectd--plugin--disk--udevnameattr) * [`package_install_options`](#-collectd--plugin--disk--package_install_options) ##### `disks` Data type: `Array` Default value: `[]` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `ignoreselected` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `package_name` Data type: `Any` Default value: `'collectd-disk'` ##### `udevnameattr` Data type: `Any` Default value: `undef` ##### `package_install_options` Data type: `Optional[Array[String]]` Default value: `undef` ### `collectd::plugin::dns` Class: collectd::plugin::dns #### Parameters The following parameters are available in the `collectd::plugin::dns` class: * [`ensure`](#-collectd--plugin--dns--ensure) * [`ignoresource`](#-collectd--plugin--dns--ignoresource) * [`interface`](#-collectd--plugin--dns--interface) * [`interval`](#-collectd--plugin--dns--interval) * [`manage_package`](#-collectd--plugin--dns--manage_package) * [`package_name`](#-collectd--plugin--dns--package_name) * [`selectnumericquerytypes`](#-collectd--plugin--dns--selectnumericquerytypes) ##### `ensure` Data type: `Enum['present','absent']` Default value: `'present'` ##### `ignoresource` Data type: `Optional[Stdlib::IP::Address]` Default value: `undef` ##### `interface` Data type: `String` Default value: `'any'` ##### `interval` Data type: `Optional[String]` Default value: `undef` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `package_name` Data type: `Any` Default value: `'collectd-dns'` ##### `selectnumericquerytypes` Data type: `Variant[String,Boolean]` Default value: `true` ### `collectd::plugin::dpdk_telemetry` Class to manage dpdk_telemetry plugin for collectd. The dpdk_telemetry plugin collects DPDK ethernet device metrics via dpdk_telemetry library. Plugin retrieves metrics from a DPDK packet forwarding application by sending the JSON formatted message via a UNIX domain socket. DPDK telemetry component will respond with a JSON formatted reply delivering the requested metrics. Plugin parses the JSON data and publishes the metric values to collectd for further use. #### Parameters The following parameters are available in the `collectd::plugin::dpdk_telemetry` class: * [`ensure`](#-collectd--plugin--dpdk_telemetry--ensure) * [`client_socket_path`](#-collectd--plugin--dpdk_telemetry--client_socket_path) * [`dpdk_socket_path`](#-collectd--plugin--dpdk_telemetry--dpdk_socket_path) ##### `ensure` Data type: `Enum['present', 'absent']` Ensure param for collectd::plugin type. Default value: `'present'` ##### `client_socket_path` Data type: `Stdlib::Absolutepath` UNIX domain client socket to receive messages from DPDK telemetry library. Default value: `'/var/run/.client'` ##### `dpdk_socket_path` Data type: `Stdlib::Absolutepath` UNIX domain DPDK telemetry socket to be connected to send messages. Default value: `'/var/run/dpdk/rte/telemetry'` ### `collectd::plugin::entropy` https://collectd.org/wiki/index.php/Plugin:Entropy #### Parameters The following parameters are available in the `collectd::plugin::entropy` class: * [`ensure`](#-collectd--plugin--entropy--ensure) * [`interval`](#-collectd--plugin--entropy--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::ethstat` https://collectd.org/wiki/index.php/Plugin:Ethstat #### Parameters The following parameters are available in the `collectd::plugin::ethstat` class: * [`ensure`](#-collectd--plugin--ethstat--ensure) * [`interfaces`](#-collectd--plugin--ethstat--interfaces) * [`maps`](#-collectd--plugin--ethstat--maps) * [`mappedonly`](#-collectd--plugin--ethstat--mappedonly) * [`interval`](#-collectd--plugin--ethstat--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interfaces` Data type: `Array` Default value: `[]` ##### `maps` Data type: `Array` Default value: `[]` ##### `mappedonly` Data type: `Any` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::exec` See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_exec #### Parameters The following parameters are available in the `collectd::plugin::exec` class: * [`commands`](#-collectd--plugin--exec--commands) * [`commands_defaults`](#-collectd--plugin--exec--commands_defaults) * [`interval`](#-collectd--plugin--exec--interval) * [`ensure`](#-collectd--plugin--exec--ensure) * [`globals`](#-collectd--plugin--exec--globals) ##### `commands` Data type: `Hash` Default value: `{}` ##### `commands_defaults` Data type: `Hash` Default value: `{}` ##### `interval` Data type: `Any` Default value: `undef` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `globals` Data type: `Boolean` Default value: `false` ### `collectd::plugin::fhcount` https://collectd.org/wiki/index.php/Plugin:Fhcount #### Parameters The following parameters are available in the `collectd::plugin::fhcount` class: * [`ensure`](#-collectd--plugin--fhcount--ensure) * [`valuesabsolute`](#-collectd--plugin--fhcount--valuesabsolute) * [`valuespercentage`](#-collectd--plugin--fhcount--valuespercentage) * [`interval`](#-collectd--plugin--fhcount--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `valuesabsolute` Data type: `Boolean` Default value: `true` ##### `valuespercentage` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::filecount` https://collectd.org/wiki/index.php/Plugin:FileCount #### Parameters The following parameters are available in the `collectd::plugin::filecount` class: * [`ensure`](#-collectd--plugin--filecount--ensure) * [`directories`](#-collectd--plugin--filecount--directories) * [`interval`](#-collectd--plugin--filecount--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `directories` Data type: `Hash` Default value: `{}` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::filter` https://collectd.org/wiki/index.php/Chains #### Parameters The following parameters are available in the `collectd::plugin::filter` class: * [`ensure`](#-collectd--plugin--filter--ensure) * [`precachechain`](#-collectd--plugin--filter--precachechain) * [`postcachechain`](#-collectd--plugin--filter--postcachechain) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `precachechain` Data type: `Any` Default value: `'PreChain'` ##### `postcachechain` Data type: `Any` Default value: `'PostChain'` ### `collectd::plugin::fscache` https://collectd.org/wiki/index.php/Plugin:FSCache #### Parameters The following parameters are available in the `collectd::plugin::fscache` class: * [`ensure`](#-collectd--plugin--fscache--ensure) ##### `ensure` Data type: `Any` Default value: `'present'` ### `collectd::plugin::genericjmx` https://collectd.org/wiki/index.php/Plugin:GenericJMX #### Parameters The following parameters are available in the `collectd::plugin::genericjmx` class: * [`ensure`](#-collectd--plugin--genericjmx--ensure) * [`jvmarg`](#-collectd--plugin--genericjmx--jvmarg) * [`manage_package`](#-collectd--plugin--genericjmx--manage_package) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `jvmarg` Data type: `Any` Default value: `[]` ##### `manage_package` Data type: `Any` Default value: `undef` ### `collectd::plugin::hddtemp` https://collectd.org/wiki/index.php/Plugin:HDDTemp #### Parameters The following parameters are available in the `collectd::plugin::hddtemp` class: * [`host`](#-collectd--plugin--hddtemp--host) * [`port`](#-collectd--plugin--hddtemp--port) * [`ensure`](#-collectd--plugin--hddtemp--ensure) * [`interval`](#-collectd--plugin--hddtemp--interval) ##### `host` Data type: `Stdlib::Host` Default value: `'127.0.0.1'` ##### `port` Data type: `Stdlib::Port` Default value: `7634` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::hugepages` == Class: collectd::plugin::hugepages Class to manage hugepages write plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_hugepages === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' [*interval*] Interval setting for the plugin Defaults to undef [*report_per_node_hp*] 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. Defaults to true [*report_root_hp*] 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. Defaults to true [*values_pages*] Whether to report hugepages metrics in number of pages Defaults to true [*values_bytes*] Whether to report hugepages metrics in bytes Defaults to false [*values_percentage*] Whether to report hugepages metrics in percentage Defaults to false #### Parameters The following parameters are available in the `collectd::plugin::hugepages` class: * [`ensure`](#-collectd--plugin--hugepages--ensure) * [`interval`](#-collectd--plugin--hugepages--interval) * [`report_per_node_hp`](#-collectd--plugin--hugepages--report_per_node_hp) * [`report_root_hp`](#-collectd--plugin--hugepages--report_root_hp) * [`values_pages`](#-collectd--plugin--hugepages--values_pages) * [`values_bytes`](#-collectd--plugin--hugepages--values_bytes) * [`values_percentage`](#-collectd--plugin--hugepages--values_percentage) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Integer]` Default value: `undef` ##### `report_per_node_hp` Data type: `Boolean` Default value: `true` ##### `report_root_hp` Data type: `Boolean` Default value: `true` ##### `values_pages` Data type: `Boolean` Default value: `true` ##### `values_bytes` Data type: `Boolean` Default value: `false` ##### `values_percentage` Data type: `Boolean` Default value: `false` ### `collectd::plugin::intel_pmu` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_intel_pmu #### Parameters The following parameters are available in the `collectd::plugin::intel_pmu` class: * [`ensure`](#-collectd--plugin--intel_pmu--ensure) * [`report_hardware_cache_events`](#-collectd--plugin--intel_pmu--report_hardware_cache_events) * [`report_kernel_pmu_events`](#-collectd--plugin--intel_pmu--report_kernel_pmu_events) * [`report_software_events`](#-collectd--plugin--intel_pmu--report_software_events) * [`event_list`](#-collectd--plugin--intel_pmu--event_list) * [`hardware_events`](#-collectd--plugin--intel_pmu--hardware_events) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `report_hardware_cache_events` Data type: `Boolean` Default value: `false` ##### `report_kernel_pmu_events` Data type: `Boolean` Default value: `false` ##### `report_software_events` Data type: `Boolean` Default value: `false` ##### `event_list` Data type: `Optional[String]` Default value: `undef` ##### `hardware_events` Data type: `Optional[Array[String]]` Default value: `undef` ### `collectd::plugin::intel_rdt` == Class: collectd::plugin::intel_rdt Class to manage intel_rdt write plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_intel_rdt === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' [*interval*] Interval setting for the plugin Defaults to undef [*cores*] All events are reported on a per core basis. Monitoring of the events can be configured for group of cores (aggregated statistics). This field defines groups of cores on which to monitor supported events. The field is represented as list of strings with core group values. Each string represents a list of cores in a group. Allowed formats are: 0,1,2,3 0-10,20-18 1,3,5-8,10,0x10-12 If an empty string is provided as value for this field default cores configuration is applied - a separate group is created for each core. Defaults to "" #### Parameters The following parameters are available in the `collectd::plugin::intel_rdt` class: * [`ensure`](#-collectd--plugin--intel_rdt--ensure) * [`interval`](#-collectd--plugin--intel_rdt--interval) * [`cores`](#-collectd--plugin--intel_rdt--cores) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Integer]` Default value: `undef` ##### `cores` Data type: `Array[String[1]]` Default value: `[]` ### `collectd::plugin::interface` https://collectd.org/wiki/index.php/Plugin:Interface #### Parameters The following parameters are available in the `collectd::plugin::interface` class: * [`ensure`](#-collectd--plugin--interface--ensure) * [`interfaces`](#-collectd--plugin--interface--interfaces) * [`ignoreselected`](#-collectd--plugin--interface--ignoreselected) * [`reportinactive`](#-collectd--plugin--interface--reportinactive) * [`interval`](#-collectd--plugin--interface--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interfaces` Data type: `Array` Default value: `[]` ##### `ignoreselected` Data type: `Boolean` Default value: `false` ##### `reportinactive` Data type: `Boolean` Default value: `true` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::ipc` == Class: collectd::plugin::ipc Class to manage ipc write plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ipc === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' #### Parameters The following parameters are available in the `collectd::plugin::ipc` class: * [`ensure`](#-collectd--plugin--ipc--ensure) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ### `collectd::plugin::ipmi` https://collectd.org/wiki/index.php/Plugin:IPMI #### Parameters The following parameters are available in the `collectd::plugin::ipmi` class: * [`ensure`](#-collectd--plugin--ipmi--ensure) * [`ensure_package`](#-collectd--plugin--ipmi--ensure_package) * [`ignore_selected`](#-collectd--plugin--ipmi--ignore_selected) * [`interval`](#-collectd--plugin--ipmi--interval) * [`manage_package`](#-collectd--plugin--ipmi--manage_package) * [`notify_sensor_add`](#-collectd--plugin--ipmi--notify_sensor_add) * [`notify_sensor_remove`](#-collectd--plugin--ipmi--notify_sensor_remove) * [`notify_sensor_not_present`](#-collectd--plugin--ipmi--notify_sensor_not_present) * [`sensors`](#-collectd--plugin--ipmi--sensors) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `ensure_package` Data type: `Any` Default value: `'present'` ##### `ignore_selected` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `notify_sensor_add` Data type: `Boolean` Default value: `false` ##### `notify_sensor_remove` Data type: `Boolean` Default value: `true` ##### `notify_sensor_not_present` Data type: `Boolean` Default value: `false` ##### `sensors` Data type: `Array` Default value: `[]` ### `collectd::plugin::iptables` https://collectd.org/wiki/index.php/Plugin:IPTables #### Parameters The following parameters are available in the `collectd::plugin::iptables` class: * [`ensure`](#-collectd--plugin--iptables--ensure) * [`ensure_package`](#-collectd--plugin--iptables--ensure_package) * [`manage_package`](#-collectd--plugin--iptables--manage_package) * [`chains`](#-collectd--plugin--iptables--chains) * [`chains6`](#-collectd--plugin--iptables--chains6) * [`interval`](#-collectd--plugin--iptables--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `ensure_package` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `chains` Data type: `Hash` Default value: `{}` ##### `chains6` Data type: `Hash` Default value: `{}` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::irq` https://collectd.org/wiki/index.php/Plugin:IRQ #### Parameters The following parameters are available in the `collectd::plugin::irq` class: * [`ensure`](#-collectd--plugin--irq--ensure) * [`irqs`](#-collectd--plugin--irq--irqs) * [`ignoreselected`](#-collectd--plugin--irq--ignoreselected) * [`interval`](#-collectd--plugin--irq--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `irqs` Data type: `Array` Default value: `[]` ##### `ignoreselected` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::iscdhcp` Class: collectd::plugin::iscdhcp * **See also** * https://pypi.python.org/pypi/collectd-iscdhcp * Configures iscdhcp metrics collection. Optionally installs the required plugin packages #### Parameters The following parameters are available in the `collectd::plugin::iscdhcp` class: * [`ensure`](#-collectd--plugin--iscdhcp--ensure) * [`manage_package`](#-collectd--plugin--iscdhcp--manage_package) * [`package_name`](#-collectd--plugin--iscdhcp--package_name) * [`package_provider`](#-collectd--plugin--iscdhcp--package_provider) * [`provider_proxy`](#-collectd--plugin--iscdhcp--provider_proxy) ##### `ensure` Data type: `Enum['present', 'absent']` Passed to package and collectd::plugin resources (both) Default value: `'present'` ##### `manage_package` Data type: `Optional[Boolean]` Toggles installation of plugin Default value: `undef` ##### `package_name` Data type: `String[1]` Name of plugin package to install Default value: `'collectd-iscdhcp'` ##### `package_provider` Data type: `Optional[String[1]]` Passed to package resource Default value: `undef` ##### `provider_proxy` Data type: `Optional[String[1]]` Proxy for provider Default value: `undef` ### `collectd::plugin::java` https://collectd.org/wiki/index.php/Plugin:Java #### Parameters The following parameters are available in the `collectd::plugin::java` class: * [`ensure`](#-collectd--plugin--java--ensure) * [`jvmarg`](#-collectd--plugin--java--jvmarg) * [`loadplugin`](#-collectd--plugin--java--loadplugin) * [`interval`](#-collectd--plugin--java--interval) * [`manage_package`](#-collectd--plugin--java--manage_package) * [`java_home`](#-collectd--plugin--java--java_home) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `jvmarg` Data type: `Any` Default value: `[]` ##### `loadplugin` Data type: `Any` Default value: `{}` ##### `interval` Data type: `Any` Default value: `undef` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `java_home` Data type: `Optional[Stdlib::Absolutepath]` Default value: `undef` ### `collectd::plugin::load` https://collectd.org/wiki/index.php/Plugin:Load #### Parameters The following parameters are available in the `collectd::plugin::load` class: * [`ensure`](#-collectd--plugin--load--ensure) * [`interval`](#-collectd--plugin--load--interval) * [`report_relative`](#-collectd--plugin--load--report_relative) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ##### `report_relative` Data type: `Any` Default value: `false` ### `collectd::plugin::logfile` https://collectd.org/wiki/index.php/Plugin:LogFile #### Parameters The following parameters are available in the `collectd::plugin::logfile` class: * [`ensure`](#-collectd--plugin--logfile--ensure) * [`interval`](#-collectd--plugin--logfile--interval) * [`log_level`](#-collectd--plugin--logfile--log_level) * [`log_file`](#-collectd--plugin--logfile--log_file) * [`log_timestamp`](#-collectd--plugin--logfile--log_timestamp) * [`print_severity`](#-collectd--plugin--logfile--print_severity) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ##### `log_level` Data type: `Any` Default value: `'info'` ##### `log_file` Data type: `Any` Default value: `'/var/log/collectd.log'` ##### `log_timestamp` Data type: `Any` Default value: `true` ##### `print_severity` Data type: `Any` Default value: `false` ### `collectd::plugin::logparser` https://wiki.opnfv.org/display/fastpath/Logparser+plugin+HLD #### Parameters The following parameters are available in the `collectd::plugin::logparser` class: * [`ensure`](#-collectd--plugin--logparser--ensure) * [`logfile`](#-collectd--plugin--logparser--logfile) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `logfile` Data type: `Array[Hash[String[1],Collectd::LOGPARSER::Logfile]]` Default value: ```puppet [{ '/var/log/syslog' => { 'firstfullread' => false, 'message' => [ 'pcie_errors' => { 'defaulttype' => 'pcie_error', 'defaultseverity' => 'warning', 'match' => [{ 'aer error' => { 'regex' => 'AER:.*error received', 'submatchidx' => -1, }, 'incident time' => { 'regex' => '(... .. ..:..:..) .* pcieport.*AER', 'submatchidx' => 1, 'ismandatory' => false, }, 'root port' => { 'regex' => 'pcieport (.*): AER:', 'submatchidx' => 1, 'ismandatory' => true, }, 'device' => { 'plugininstance' => true, 'regex' => ' ([0-9a-fA-F:\\.]*): PCIe Bus Error', 'submatchidx' => 1, 'ismandatory' => false, }, 'severity_mandatory' => { 'regex' => 'severity=', 'submatchidx' => -1, }, 'nonfatal' => { 'regex' => 'severity=.*\\([nN]on-[fF]atal', 'typeinstance' => 'non_fatal', 'ismandatory' => false, }, 'fatal' => { 'regex' => 'severity=.*\\([fF]atal', 'severity' => 'failure', 'typeinstance' => 'fatal', 'ismandatory' => false, }, 'corrected' => { 'regex' => 'severity=Corrected', 'typeinstance' => 'correctable', 'ismandatory' => false, }, 'error type' => { 'regex' => 'type=(.*),', 'submatchidx' => 1, 'ismandatory' => false, }, 'id' => { 'regex' => ', id=(.*)', 'submatchidx' => 1, }, }], }, ], } }] ``` ### `collectd::plugin::lvm` https://collectd.org/wiki/index.php/Plugin:LVM #### Parameters The following parameters are available in the `collectd::plugin::lvm` class: * [`ensure`](#-collectd--plugin--lvm--ensure) * [`manage_package`](#-collectd--plugin--lvm--manage_package) * [`interval`](#-collectd--plugin--lvm--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::mcelog` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_mcelog #### Parameters The following parameters are available in the `collectd::plugin::mcelog` class: * [`ensure`](#-collectd--plugin--mcelog--ensure) * [`manage_package`](#-collectd--plugin--mcelog--manage_package) * [`package_install_options`](#-collectd--plugin--mcelog--package_install_options) * [`mceloglogfile`](#-collectd--plugin--mcelog--mceloglogfile) * [`memory`](#-collectd--plugin--mcelog--memory) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Optional[Boolean]` Default value: `undef` ##### `package_install_options` Data type: `Optional[Array]` Default value: `$collectd::package_install_options` ##### `mceloglogfile` Data type: `Optional[String]` Default value: `undef` ##### `memory` Data type: `Collectd::MCELOG::Memory` Default value: ```puppet { 'mcelogclientsocket' => '/var/run/mcelog-client', 'persistentnotification' => false, } ``` ### `collectd::plugin::memcached` https://collectd.org/wiki/index.php/Plugin:memcached #### Parameters The following parameters are available in the `collectd::plugin::memcached` class: * [`ensure`](#-collectd--plugin--memcached--ensure) * [`instances`](#-collectd--plugin--memcached--instances) * [`interval`](#-collectd--plugin--memcached--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `instances` Data type: `Hash` Default value: ```puppet { 'default' => { 'host' => 'localhost', 'address' => '127.0.0.1', 'port' => 11211, }, } ``` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::memory` https://collectd.org/wiki/index.php/Plugin:Memory #### Parameters The following parameters are available in the `collectd::plugin::memory` class: * [`ensure`](#-collectd--plugin--memory--ensure) * [`valuesabsolute`](#-collectd--plugin--memory--valuesabsolute) * [`valuespercentage`](#-collectd--plugin--memory--valuespercentage) * [`interval`](#-collectd--plugin--memory--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `valuesabsolute` Data type: `Boolean` Default value: `true` ##### `valuespercentage` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::modbus` Install and configure the modbus plugin * **See also** * https://collectd.org/wiki/index.php/Plugin:Modbus #### Parameters The following parameters are available in the `collectd::plugin::modbus` class: * [`ensure`](#-collectd--plugin--modbus--ensure) * [`manage_package`](#-collectd--plugin--modbus--manage_package) * [`data`](#-collectd--plugin--modbus--data) * [`hosts`](#-collectd--plugin--modbus--hosts) ##### `ensure` Data type: `Enum['present', 'absent']` Enable/Disable modbus support Default value: `'present'` ##### `manage_package` Data type: `Optional[Boolean]` Install collectd-modbus package? Currently supports RedHat and Debian os family. Default value: `undef` ##### `data` Data type: `Hash[String[1], Collectd::Modbus::Data]` modbus data entries Default value: `{}` ##### `hosts` Data type: `Hash[String[1], Collectd::Modbus::Host]` modbus host entries Default value: `{}` ### `collectd::plugin::mongodb` Class: collectd::plugin::mongodb #### Parameters The following parameters are available in the `collectd::plugin::mongodb` class: * [`db_user`](#-collectd--plugin--mongodb--db_user) * [`db_pass`](#-collectd--plugin--mongodb--db_pass) * [`ensure`](#-collectd--plugin--mongodb--ensure) * [`interval`](#-collectd--plugin--mongodb--interval) * [`db_host`](#-collectd--plugin--mongodb--db_host) * [`db_port`](#-collectd--plugin--mongodb--db_port) * [`configured_dbs`](#-collectd--plugin--mongodb--configured_dbs) * [`collectd_dir`](#-collectd--plugin--mongodb--collectd_dir) ##### `db_user` Data type: `String` ##### `db_pass` Data type: `String` ##### `ensure` Data type: `Enum['absent','present']` Default value: `'present'` ##### `interval` Data type: `Optional[Variant[String,Float]]` Default value: `undef` ##### `db_host` Data type: `Stdlib::Host` Default value: `'127.0.0.1'` ##### `db_port` Data type: `Optional[Stdlib::Port]` Default value: `undef` ##### `configured_dbs` Data type: `Optional[Array]` Default value: `undef` ##### `collectd_dir` Data type: `Any` Default value: `'/usr/lib/collectd'` ### `collectd::plugin::mysql` MySQL plugin https://collectd.org/wiki/index.php/Plugin:MySQL #### Parameters The following parameters are available in the `collectd::plugin::mysql` class: * [`ensure`](#-collectd--plugin--mysql--ensure) * [`manage_package`](#-collectd--plugin--mysql--manage_package) * [`interval`](#-collectd--plugin--mysql--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::netlink` https://collectd.org/wiki/index.php/Plugin:Netlink #### Parameters The following parameters are available in the `collectd::plugin::netlink` class: * [`ensure`](#-collectd--plugin--netlink--ensure) * [`manage_package`](#-collectd--plugin--netlink--manage_package) * [`interfaces`](#-collectd--plugin--netlink--interfaces) * [`verboseinterfaces`](#-collectd--plugin--netlink--verboseinterfaces) * [`qdiscs`](#-collectd--plugin--netlink--qdiscs) * [`classes`](#-collectd--plugin--netlink--classes) * [`filters`](#-collectd--plugin--netlink--filters) * [`ignoreselected`](#-collectd--plugin--netlink--ignoreselected) * [`interval`](#-collectd--plugin--netlink--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `interfaces` Data type: `Array` Default value: `[]` ##### `verboseinterfaces` Data type: `Array` Default value: `[]` ##### `qdiscs` Data type: `Array` Default value: `[]` ##### `classes` Data type: `Array` Default value: `[]` ##### `filters` Data type: `Array` Default value: `[]` ##### `ignoreselected` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::network` https://collectd.org/wiki/index.php/Plugin:Network #### Parameters The following parameters are available in the `collectd::plugin::network` class: * [`ensure`](#-collectd--plugin--network--ensure) * [`timetolive`](#-collectd--plugin--network--timetolive) * [`maxpacketsize`](#-collectd--plugin--network--maxpacketsize) * [`forward`](#-collectd--plugin--network--forward) * [`interval`](#-collectd--plugin--network--interval) * [`reportstats`](#-collectd--plugin--network--reportstats) * [`listeners`](#-collectd--plugin--network--listeners) * [`servers`](#-collectd--plugin--network--servers) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `timetolive` Data type: `Optional[Pattern[/[0-9]+/]]` Default value: `undef` ##### `maxpacketsize` Data type: `Optional[Pattern[/[0-9]+/]]` Default value: `undef` ##### `forward` Data type: `Optional[Boolean]` Default value: `undef` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ##### `reportstats` Data type: `Optional[Boolean]` Default value: `undef` ##### `listeners` Data type: `Hash` Default value: `{}` ##### `servers` Data type: `Hash` Default value: `{}` ### `collectd::plugin::nfs` https://collectd.org/wiki/index.php/Plugin:NFS #### Parameters The following parameters are available in the `collectd::plugin::nfs` class: * [`ensure`](#-collectd--plugin--nfs--ensure) * [`interval`](#-collectd--plugin--nfs--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::nginx` https://collectd.org/wiki/index.php/Plugin:nginx #### Parameters The following parameters are available in the `collectd::plugin::nginx` class: * [`url`](#-collectd--plugin--nginx--url) * [`manage_package`](#-collectd--plugin--nginx--manage_package) * [`ensure`](#-collectd--plugin--nginx--ensure) * [`user`](#-collectd--plugin--nginx--user) * [`password`](#-collectd--plugin--nginx--password) * [`verifypeer`](#-collectd--plugin--nginx--verifypeer) * [`verifyhost`](#-collectd--plugin--nginx--verifyhost) * [`cacert`](#-collectd--plugin--nginx--cacert) * [`interval`](#-collectd--plugin--nginx--interval) ##### `url` Data type: `Any` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `user` Data type: `Any` Default value: `undef` ##### `password` Data type: `Any` Default value: `undef` ##### `verifypeer` Data type: `Any` Default value: `undef` ##### `verifyhost` Data type: `Any` Default value: `undef` ##### `cacert` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::ntpd` https://collectd.org/wiki/index.php/Plugin:NTPd #### Parameters The following parameters are available in the `collectd::plugin::ntpd` class: * [`ensure`](#-collectd--plugin--ntpd--ensure) * [`host`](#-collectd--plugin--ntpd--host) * [`port`](#-collectd--plugin--ntpd--port) * [`reverselookups`](#-collectd--plugin--ntpd--reverselookups) * [`includeunitid`](#-collectd--plugin--ntpd--includeunitid) * [`interval`](#-collectd--plugin--ntpd--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `host` Data type: `Stdlib::Host` Default value: `'localhost'` ##### `port` Data type: `Stdlib::Port` Default value: `123` ##### `reverselookups` Data type: `Any` Default value: `false` ##### `includeunitid` Data type: `Any` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::numa` == Class: collectd::plugin::numa Class to manage numa write plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_numa === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' #### Parameters The following parameters are available in the `collectd::plugin::numa` class: * [`ensure`](#-collectd--plugin--numa--ensure) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ### `collectd::plugin::nut` https://collectd.org/wiki/index.php/Plugin:Nut #### Parameters The following parameters are available in the `collectd::plugin::nut` class: * [`ensure`](#-collectd--plugin--nut--ensure) * [`upss`](#-collectd--plugin--nut--upss) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `upss` Data type: `Any` Default value: `{}` ### `collectd::plugin::openldap` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_openldap #### Parameters The following parameters are available in the `collectd::plugin::openldap` class: * [`ensure`](#-collectd--plugin--openldap--ensure) * [`instances`](#-collectd--plugin--openldap--instances) * [`interval`](#-collectd--plugin--openldap--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `instances` Data type: `Hash` Default value: `{ 'localhost' => { 'url' => 'ldap://localhost/' } }` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::openvpn` https://collectd.org/wiki/index.php/Plugin:OpenVPN #### Parameters The following parameters are available in the `collectd::plugin::openvpn` class: * [`ensure`](#-collectd--plugin--openvpn--ensure) * [`statusfile`](#-collectd--plugin--openvpn--statusfile) * [`improvednamingschema`](#-collectd--plugin--openvpn--improvednamingschema) * [`collectcompression`](#-collectd--plugin--openvpn--collectcompression) * [`collectindividualusers`](#-collectd--plugin--openvpn--collectindividualusers) * [`collectusercount`](#-collectd--plugin--openvpn--collectusercount) * [`interval`](#-collectd--plugin--openvpn--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `statusfile` Data type: `Variant[Array[Stdlib::Absolutepath], Stdlib::Absolutepath]` Default value: `'/etc/openvpn/openvpn-status.log'` ##### `improvednamingschema` Data type: `Boolean` Default value: `false` ##### `collectcompression` Data type: `Boolean` Default value: `true` ##### `collectindividualusers` Data type: `Boolean` Default value: `true` ##### `collectusercount` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::oracle` Oracle plugin https://collectd.org/wiki/index.php/Plugin:Oracle #### Parameters The following parameters are available in the `collectd::plugin::oracle` class: * [`ensure`](#-collectd--plugin--oracle--ensure) * [`manage_package`](#-collectd--plugin--oracle--manage_package) * [`interval`](#-collectd--plugin--oracle--interval) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Optional[Integer[1]]` Default value: `undef` ### `collectd::plugin::ovs_events` == Class: collectd::plugin::ovs_events Class to manage ovs_events plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ovs_events === Parameters [* address *] The address of the OVS DB server JSON-RPC interface used by the plugin. [*dispatch*] Dispatch the OVS DB interface link status value with configured plugin interval. [*ensure*] ensure param for collectd::plugin type. Defaults to 'ensure' [* interfaces *] List of interface names to be monitored by this plugin. If this option is not specified or is empty then all OVS connected interfaces on all bridges are monitored. [*manage_package*] If enabled, manages separate package for plugin Defaults to true [*send_notification*] If set to true, OVS link notifications (interface status and OVS DB connection terminate) are sent to collectd. [*package_name*] If manage_package is true, this gives the name of the package to manage. Defaults to 'collectd-ovs_stats' [*port*] TCP-port to connect to. [*socket*] The UNIX domain socket path of OVS DB server JSON-RPC interface used by the plugin #### Parameters The following parameters are available in the `collectd::plugin::ovs_events` class: * [`address`](#-collectd--plugin--ovs_events--address) * [`dispatch`](#-collectd--plugin--ovs_events--dispatch) * [`ensure`](#-collectd--plugin--ovs_events--ensure) * [`interfaces`](#-collectd--plugin--ovs_events--interfaces) * [`manage_package`](#-collectd--plugin--ovs_events--manage_package) * [`send_notification`](#-collectd--plugin--ovs_events--send_notification) * [`package_name`](#-collectd--plugin--ovs_events--package_name) * [`port`](#-collectd--plugin--ovs_events--port) * [`socket`](#-collectd--plugin--ovs_events--socket) ##### `address` Data type: `Optional[Stdlib::Host]` Default value: `undef` ##### `dispatch` Data type: `Optional[Boolean]` Default value: `undef` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interfaces` Data type: `Array` Default value: `[]` ##### `manage_package` Data type: `Boolean` Default value: `true` ##### `send_notification` Data type: `Optional[Boolean]` Default value: `undef` ##### `package_name` Data type: `String[1]` Default value: `'collectd-ovs-events'` ##### `port` Data type: `Optional[Stdlib::Port]` Default value: `undef` ##### `socket` Data type: `Optional[String[1]]` Default value: `undef` ### `collectd::plugin::ovs_stats` == Class: collectd::plugin::ovs_stats Class to manage ovs_stats plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ovs_stats === Parameters [* address *] The address of the OVS DB server JSON-RPC interface used by the plugin. [* bridges *] List of OVS bridge names to be monitored by this plugin. If this option is omitted or is empty then all OVS bridges will be monitored [*ensure*] ensure param for collectd::plugin type. Defaults to 'ensure' [*manage_package*] If enabled, manages separate package for plugin Defaults to true [*package_name*] If manage_package is true, this gives the name of the package to manage. Defaults to 'collectd-ovs_stats' [*port*] TCP-port to connect to. [*socket*] The UNIX domain socket path of OVS DB server JSON-RPC interface used by the plugin #### Parameters The following parameters are available in the `collectd::plugin::ovs_stats` class: * [`address`](#-collectd--plugin--ovs_stats--address) * [`bridges`](#-collectd--plugin--ovs_stats--bridges) * [`ensure`](#-collectd--plugin--ovs_stats--ensure) * [`manage_package`](#-collectd--plugin--ovs_stats--manage_package) * [`package_name`](#-collectd--plugin--ovs_stats--package_name) * [`port`](#-collectd--plugin--ovs_stats--port) * [`socket`](#-collectd--plugin--ovs_stats--socket) ##### `address` Data type: `Optional[String]` Default value: `undef` ##### `bridges` Data type: `Optional[Array]` Default value: `undef` ##### `ensure` Data type: `String` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `true` ##### `package_name` Data type: `String` Default value: `'collectd-ovs-stats'` ##### `port` Data type: `Optional[Stdlib::Port]` Default value: `undef` ##### `socket` Data type: `Optional[String]` Default value: `undef` ### `collectd::plugin::pcie_errors` Class to manage pcie_errors plugin for collectd #### Parameters The following parameters are available in the `collectd::plugin::pcie_errors` class: * [`ensure`](#-collectd--plugin--pcie_errors--ensure) * [`source`](#-collectd--plugin--pcie_errors--source) * [`access_dir`](#-collectd--plugin--pcie_errors--access_dir) * [`report_masked`](#-collectd--plugin--pcie_errors--report_masked) * [`persistent_notifications`](#-collectd--plugin--pcie_errors--persistent_notifications) ##### `ensure` Data type: `Enum['present', 'absent']` Ensure param for collectd::plugin type. Default value: `'present'` ##### `source` Data type: `Enum['sysfs', 'proc']` Use sysfs or proc to read data from /sysfs or /proc. Default value: `'sysfs'` ##### `access_dir` Data type: `Optional[String]` Directory used to access device config space. Default value: `undef` ##### `report_masked` Data type: `Boolean` If true plugin will notify about errors that are set to masked in Error Mask register. Default value: `false` ##### `persistent_notifications` Data type: `Boolean` If false plugin will dispatch notification only on set/clear of error. Default value: `false` ### `collectd::plugin::perl` See http://collectd.org/documentation/manpages/collectd-perl.5.shtml #### Parameters The following parameters are available in the `collectd::plugin::perl` class: * [`ensure`](#-collectd--plugin--perl--ensure) * [`manage_package`](#-collectd--plugin--perl--manage_package) * [`interval`](#-collectd--plugin--perl--interval) * [`order`](#-collectd--plugin--perl--order) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `order` Data type: `Any` Default value: `20` ### `collectd::plugin::ping` See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_ping #### Parameters The following parameters are available in the `collectd::plugin::ping` class: * [`hosts`](#-collectd--plugin--ping--hosts) * [`ensure`](#-collectd--plugin--ping--ensure) * [`manage_package`](#-collectd--plugin--ping--manage_package) * [`interval`](#-collectd--plugin--ping--interval) * [`timeout`](#-collectd--plugin--ping--timeout) * [`ttl`](#-collectd--plugin--ping--ttl) * [`source_address`](#-collectd--plugin--ping--source_address) * [`device`](#-collectd--plugin--ping--device) * [`max_missed`](#-collectd--plugin--ping--max_missed) * [`size`](#-collectd--plugin--ping--size) ##### `hosts` Data type: `Array` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Optional[Boolean]` Default value: `undef` ##### `interval` Data type: `Optional[Numeric]` Default value: `undef` ##### `timeout` Data type: `Optional[Numeric]` Default value: `undef` ##### `ttl` Data type: `Optional[Integer[0,255]]` Default value: `undef` ##### `source_address` Data type: `Optional[String]` Default value: `undef` ##### `device` Data type: `Optional[String]` Default value: `undef` ##### `max_missed` Data type: `Optional[Integer[-1]]` Default value: `undef` ##### `size` Data type: `Optional[Integer[0]]` Default value: `undef` ### `collectd::plugin::postgresql` https://collectd.org/wiki/index.php/Plugin:PostgreSQL #### Parameters The following parameters are available in the `collectd::plugin::postgresql` class: * [`ensure`](#-collectd--plugin--postgresql--ensure) * [`manage_package`](#-collectd--plugin--postgresql--manage_package) * [`databases`](#-collectd--plugin--postgresql--databases) * [`interval`](#-collectd--plugin--postgresql--interval) * [`queries`](#-collectd--plugin--postgresql--queries) * [`writers`](#-collectd--plugin--postgresql--writers) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `databases` Data type: `Any` Default value: `{}` ##### `interval` Data type: `Any` Default value: `undef` ##### `queries` Data type: `Any` Default value: `{}` ##### `writers` Data type: `Any` Default value: `{}` ### `collectd::plugin::powerdns` See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_powerdns #### Parameters The following parameters are available in the `collectd::plugin::powerdns` class: * [`ensure`](#-collectd--plugin--powerdns--ensure) * [`order`](#-collectd--plugin--powerdns--order) * [`interval`](#-collectd--plugin--powerdns--interval) * [`servers`](#-collectd--plugin--powerdns--servers) * [`recursors`](#-collectd--plugin--powerdns--recursors) * [`local_socket`](#-collectd--plugin--powerdns--local_socket) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `order` Data type: `Integer` Default value: `10` ##### `interval` Data type: `Optional[Numeric]` Default value: `undef` ##### `servers` Data type: `Hash[String, Hash]` Default value: `{}` ##### `recursors` Data type: `Hash[String, Hash]` Default value: `{}` ##### `local_socket` Data type: `Optional[String[1]]` Default value: `undef` ### `collectd::plugin::processes` See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_processes #### Parameters The following parameters are available in the `collectd::plugin::processes` class: * [`ensure`](#-collectd--plugin--processes--ensure) * [`order`](#-collectd--plugin--processes--order) * [`interval`](#-collectd--plugin--processes--interval) * [`processes`](#-collectd--plugin--processes--processes) * [`process_matches`](#-collectd--plugin--processes--process_matches) * [`collect_context_switch`](#-collectd--plugin--processes--collect_context_switch) * [`collect_file_descriptor`](#-collectd--plugin--processes--collect_file_descriptor) * [`collect_memory_maps`](#-collectd--plugin--processes--collect_memory_maps) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `order` Data type: `Integer` Default value: `10` ##### `interval` Data type: `Optional[Numeric]` Default value: `undef` ##### `processes` Data type: `Optional[Array]` Default value: `undef` ##### `process_matches` Data type: `Optional[Array]` Default value: `undef` ##### `collect_context_switch` Data type: `Optional[Boolean]` Default value: `undef` ##### `collect_file_descriptor` Data type: `Optional[Boolean]` Default value: `undef` ##### `collect_memory_maps` Data type: `Optional[Boolean]` Default value: `undef` ### `collectd::plugin::procevent` == Class: collectd::plugin::procevent Class to manage procevent plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_procevent === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' [*manage_package*] Set to true if Puppet should manage plugin package installation. Defaults to $collectd::manage_package [*process*] Enumerate a process name to monitor. All processes that match this exact name will be monitored for EXECs and EXITs. Defaults to undef [*process_regex*] Enumerate a process pattern to monitor. All processes that match this regular expression will be monitored for EXECs and EXITs. Defaults to undef [*buffer_length*] Maximum number of rsyslog events that can be stored in plugin's ring buffer. Once an event has been read, its location becomes available for storing a new event. Defaults to undef #### Parameters The following parameters are available in the `collectd::plugin::procevent` class: * [`ensure`](#-collectd--plugin--procevent--ensure) * [`manage_package`](#-collectd--plugin--procevent--manage_package) * [`process`](#-collectd--plugin--procevent--process) * [`process_regex`](#-collectd--plugin--procevent--process_regex) * [`buffer_length`](#-collectd--plugin--procevent--buffer_length) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `process` Data type: `Optional[String[1]]` Default value: `undef` ##### `process_regex` Data type: `Optional[String[1]]` Default value: `undef` ##### `buffer_length` Data type: `Optional[Integer[1, default]]` Default value: `undef` ### `collectd::plugin::protocols` See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_protocols #### Parameters The following parameters are available in the `collectd::plugin::protocols` class: * [`ensure`](#-collectd--plugin--protocols--ensure) * [`ignoreselected`](#-collectd--plugin--protocols--ignoreselected) * [`values`](#-collectd--plugin--protocols--values) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `ignoreselected` Data type: `Optional[Boolean]` Default value: `undef` ##### `values` Data type: `Array` Default value: `[]` ### `collectd::plugin::python` See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_python #### Parameters The following parameters are available in the `collectd::plugin::python` class: * [`encoding`](#-collectd--plugin--python--encoding) * [`ensure`](#-collectd--plugin--python--ensure) * [`globals`](#-collectd--plugin--python--globals) * [`interactive`](#-collectd--plugin--python--interactive) * [`interval`](#-collectd--plugin--python--interval) * [`logtraces`](#-collectd--plugin--python--logtraces) * [`manage_package`](#-collectd--plugin--python--manage_package) * [`modulepaths`](#-collectd--plugin--python--modulepaths) * [`modules`](#-collectd--plugin--python--modules) * [`order`](#-collectd--plugin--python--order) * [`conf_name`](#-collectd--plugin--python--conf_name) ##### `encoding` Data type: `Any` Default value: `undef` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `globals` Data type: `Boolean` Default value: `true` ##### `interactive` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ##### `logtraces` Data type: `Boolean` Default value: `false` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `modulepaths` Data type: `Array` Default value: `[]` ##### `modules` Data type: `Hash` Default value: `{}` ##### `order` Data type: `Any` Default value: `'10'` ##### `conf_name` Data type: `Any` Default value: `'python-config.conf'` ### `collectd::plugin::rabbitmq` rabbitmq plugin https://pypi.python.org/pypi/collectd-rabbitmq == Class collectd::plugin::rabbitmq Configures rabbitmq metrics collection. Optionally installs the plugin Note, it is up to you to support package installation and sources === Parameters: [*ensure*] String Passed to package and collectd::plugin resources ( both ) Default: present [*interval*] Integer Interval setting for the plugin Default: undef [*manage_package*] Boolean Toggles installation of plugin. Please reference https://collectd-rabbitmq.readthedocs.org/en/latest/installation.html Default: undef [*package_provider*] String Passed to package resource Default: pip [*config*] Hash Contains key/value passed to the python module to configure the plugin Note we have had issues with the Realm value and quoting, seems to be an issue with quoting. Multi-word values need to be wrapped in '"xxxx"' Default: { 'Username' => 'guest', 'Password' => 'guest_pass', 'Scheme' => 'http', 'Port' => '15672', 'Host' => $facts['fqdn'], 'Realm' => '"RabbitMQ Management"', } #### Parameters The following parameters are available in the `collectd::plugin::rabbitmq` class: * [`config`](#-collectd--plugin--rabbitmq--config) * [`ensure`](#-collectd--plugin--rabbitmq--ensure) * [`interval`](#-collectd--plugin--rabbitmq--interval) * [`manage_package`](#-collectd--plugin--rabbitmq--manage_package) * [`package_name`](#-collectd--plugin--rabbitmq--package_name) * [`package_provider`](#-collectd--plugin--rabbitmq--package_provider) * [`provider_proxy`](#-collectd--plugin--rabbitmq--provider_proxy) * [`custom_types_db`](#-collectd--plugin--rabbitmq--custom_types_db) ##### `config` Data type: `Hash` Default value: ```puppet { 'Username' => 'guest', 'Password' => 'guest', 'Scheme' => 'http', 'Port' => '15672', 'Host' => $facts['networking']['fqdn'], 'Realm' => '"RabbitMQ Management"', } ``` ##### `ensure` Data type: `String` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `package_name` Data type: `Any` Default value: `'collectd-rabbitmq'` ##### `package_provider` Data type: `Any` Default value: `'pip'` ##### `provider_proxy` Data type: `Any` Default value: `undef` ##### `custom_types_db` Data type: `Any` Default value: `undef` ### `collectd::plugin::redis` https://collectd.org/wiki/index.php/Plugin:Redis #### Parameters The following parameters are available in the `collectd::plugin::redis` class: * [`ensure`](#-collectd--plugin--redis--ensure) * [`interval`](#-collectd--plugin--redis--interval) * [`manage_package`](#-collectd--plugin--redis--manage_package) * [`nodes`](#-collectd--plugin--redis--nodes) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Integer[0]]` Default value: `undef` ##### `manage_package` Data type: `Optional[Boolean]` Default value: `undef` ##### `nodes` Data type: `Hash[String[1], Collectd::Redis::Node]` Default value: ```puppet { 'redis' => { 'host' => 'localhost', 'port' => 6379, 'timeout' => 2000, 'queries' => { 'dbsize' => { 'type' => 'count', 'query' => 'DBSIZE', }, }, }, } ``` ### `collectd::plugin::rrdcached` https://collectd.org/wiki/index.php/Rrdcached #### Parameters The following parameters are available in the `collectd::plugin::rrdcached` class: * [`ensure`](#-collectd--plugin--rrdcached--ensure) * [`daemonaddress`](#-collectd--plugin--rrdcached--daemonaddress) * [`datadir`](#-collectd--plugin--rrdcached--datadir) * [`createfiles`](#-collectd--plugin--rrdcached--createfiles) * [`createfilesasync`](#-collectd--plugin--rrdcached--createfilesasync) * [`stepsize`](#-collectd--plugin--rrdcached--stepsize) * [`heartbeat`](#-collectd--plugin--rrdcached--heartbeat) * [`interval`](#-collectd--plugin--rrdcached--interval) * [`rrarows`](#-collectd--plugin--rrdcached--rrarows) * [`rratimespan`](#-collectd--plugin--rrdcached--rratimespan) * [`xff`](#-collectd--plugin--rrdcached--xff) * [`collectstatistics`](#-collectd--plugin--rrdcached--collectstatistics) * [`manage_package`](#-collectd--plugin--rrdcached--manage_package) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `daemonaddress` Data type: `Any` Default value: `'unix:/tmp/rrdcached.sock'` ##### `datadir` Data type: `Any` Default value: `'/var/lib/rrdcached/db/collectd'` ##### `createfiles` Data type: `Boolean` Default value: `true` ##### `createfilesasync` Data type: `Boolean` Default value: `false` ##### `stepsize` Data type: `Any` Default value: `undef` ##### `heartbeat` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `rrarows` Data type: `Any` Default value: `undef` ##### `rratimespan` Data type: `Array` Default value: `[]` ##### `xff` Data type: `Any` Default value: `undef` ##### `collectstatistics` Data type: `Any` Default value: `undef` ##### `manage_package` Data type: `Any` Default value: `undef` ### `collectd::plugin::rrdtool` https://collectd.org/wiki/index.php/Plugin:RRDtool #### Parameters The following parameters are available in the `collectd::plugin::rrdtool` class: * [`ensure`](#-collectd--plugin--rrdtool--ensure) * [`manage_package`](#-collectd--plugin--rrdtool--manage_package) * [`datadir`](#-collectd--plugin--rrdtool--datadir) * [`createfilesasync`](#-collectd--plugin--rrdtool--createfilesasync) * [`interval`](#-collectd--plugin--rrdtool--interval) * [`rrarows`](#-collectd--plugin--rrdtool--rrarows) * [`rratimespan`](#-collectd--plugin--rrdtool--rratimespan) * [`xff`](#-collectd--plugin--rrdtool--xff) * [`cacheflush`](#-collectd--plugin--rrdtool--cacheflush) * [`cachetimeout`](#-collectd--plugin--rrdtool--cachetimeout) * [`writespersecond`](#-collectd--plugin--rrdtool--writespersecond) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `datadir` Data type: `Stdlib::Absolutepath` Default value: `'/var/lib/collectd/rrd'` ##### `createfilesasync` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ##### `rrarows` Data type: `Integer` Default value: `1200` ##### `rratimespan` Data type: `Array[Integer]` Default value: `[3600, 86400, 604800, 2678400, 31622400]` ##### `xff` Data type: `Float` Default value: `0.1` ##### `cacheflush` Data type: `Integer` Default value: `900` ##### `cachetimeout` Data type: `Integer` Default value: `120` ##### `writespersecond` Data type: `Integer` Default value: `50` ### `collectd::plugin::sensors` https://collectd.org/wiki/index.php/Plugin:Sensors #### Parameters The following parameters are available in the `collectd::plugin::sensors` class: * [`ensure`](#-collectd--plugin--sensors--ensure) * [`manage_package`](#-collectd--plugin--sensors--manage_package) * [`sensorconfigfile`](#-collectd--plugin--sensors--sensorconfigfile) * [`sensors`](#-collectd--plugin--sensors--sensors) * [`ignoreselected`](#-collectd--plugin--sensors--ignoreselected) * [`interval`](#-collectd--plugin--sensors--interval) * [`package_install_options`](#-collectd--plugin--sensors--package_install_options) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `sensorconfigfile` Data type: `Any` Default value: `undef` ##### `sensors` Data type: `Any` Default value: `undef` ##### `ignoreselected` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `package_install_options` Data type: `Optional[Array[String]]` Default value: `undef` ### `collectd::plugin::smart` https://collectd.org/wiki/index.php/Plugin:SMART #### Parameters The following parameters are available in the `collectd::plugin::smart` class: * [`disks`](#-collectd--plugin--smart--disks) * [`ensure`](#-collectd--plugin--smart--ensure) * [`ignoreselected`](#-collectd--plugin--smart--ignoreselected) * [`interval`](#-collectd--plugin--smart--interval) * [`manage_package`](#-collectd--plugin--smart--manage_package) * [`package_name`](#-collectd--plugin--smart--package_name) ##### `disks` Data type: `Array` Default value: `[]` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `ignoreselected` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `package_name` Data type: `Any` Default value: `'collectd-smart'` ### `collectd::plugin::snmp` https://collectd.org/wiki/index.php/Plugin:SNMP #### Parameters The following parameters are available in the `collectd::plugin::snmp` class: * [`ensure`](#-collectd--plugin--snmp--ensure) * [`manage_package`](#-collectd--plugin--snmp--manage_package) * [`data`](#-collectd--plugin--snmp--data) * [`hosts`](#-collectd--plugin--snmp--hosts) * [`interval`](#-collectd--plugin--snmp--interval) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Optional[Boolean]` Default value: `undef` ##### `data` Data type: `Hash[String[1], Collectd::SNMP::Data]` Default value: `{}` ##### `hosts` Data type: `Hash[String[1], Collectd::SNMP::Host]` Default value: `{}` ##### `interval` Data type: `Optional[Integer[0]]` Default value: `undef` ### `collectd::plugin::snmp_agent` Class: collectd::plugin::snmp_agent * **See also** * https://wiki.opnfv.org/display/fastpath/SNMP+Agent+HLD * Configues snmp agent plugin. #### Parameters The following parameters are available in the `collectd::plugin::snmp_agent` class: * [`ensure`](#-collectd--plugin--snmp_agent--ensure) * [`data`](#-collectd--plugin--snmp_agent--data) * [`table`](#-collectd--plugin--snmp_agent--table) ##### `ensure` Data type: `Enum['present', 'absent']` Passed to package and collectd::plugin resources (both) Default value: `'present'` ##### `data` Data type: `Hash[String[1],Collectd::SNMP_AGENT::Data]` Defines scalar field, must be put outside Table block. Default value: ```puppet { 'memAvailReal' => { 'oids' => '1.3.6.1.4.1.2021.4.6.0', 'plugin' => 'memory', 'type' => 'memory', 'typeinstance' => 'free', }, } ``` ##### `table` Data type: `Hash[String[1], Collectd::SNMP_AGENT::Table]` Defines a table consisting of several Data blocks being its columns Default value: ```puppet { 'ifTable' => { 'indexoid' => 'IF-MIB::ifIndex', 'sizeoid' => 'IF-MIB::ifNumber', 'data'=> { 'ifDescr' => { 'plugin' => 'interface', 'oids' => 'IF-MIB::ifDescr', 'indexkey' => { 'source' => 'PluginInstance', }, }, 'ifOctets' => { 'plugin' => 'interface', 'oids' => 'IF-MIB::ifInOctets" "IF-MIB::ifOutOctets', 'type' => 'if_octets', 'typeinstance' => '', }, }, }, } ``` ### `collectd::plugin::statsd` https://collectd.org/wiki/index.php/Plugin:StatsD #### Parameters The following parameters are available in the `collectd::plugin::statsd` class: * [`ensure`](#-collectd--plugin--statsd--ensure) * [`host`](#-collectd--plugin--statsd--host) * [`port`](#-collectd--plugin--statsd--port) * [`deletecounters`](#-collectd--plugin--statsd--deletecounters) * [`deletetimers`](#-collectd--plugin--statsd--deletetimers) * [`deletegauges`](#-collectd--plugin--statsd--deletegauges) * [`deletesets`](#-collectd--plugin--statsd--deletesets) * [`countersum`](#-collectd--plugin--statsd--countersum) * [`interval`](#-collectd--plugin--statsd--interval) * [`timerpercentile`](#-collectd--plugin--statsd--timerpercentile) * [`timerlower`](#-collectd--plugin--statsd--timerlower) * [`timerupper`](#-collectd--plugin--statsd--timerupper) * [`timersum`](#-collectd--plugin--statsd--timersum) * [`timercount`](#-collectd--plugin--statsd--timercount) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `host` Data type: `Optional[Stdlib::Host]` Default value: `undef` ##### `port` Data type: `Optional[Stdlib::Port]` Default value: `undef` ##### `deletecounters` Data type: `Any` Default value: `undef` ##### `deletetimers` Data type: `Any` Default value: `undef` ##### `deletegauges` Data type: `Any` Default value: `undef` ##### `deletesets` Data type: `Any` Default value: `undef` ##### `countersum` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `timerpercentile` Data type: `Array` Default value: `[]` ##### `timerlower` Data type: `Any` Default value: `undef` ##### `timerupper` Data type: `Any` Default value: `undef` ##### `timersum` Data type: `Any` Default value: `undef` ##### `timercount` Data type: `Any` Default value: `undef` ### `collectd::plugin::swap` https://collectd.org/wiki/index.php/Plugin:Swap #### Parameters The following parameters are available in the `collectd::plugin::swap` class: * [`ensure`](#-collectd--plugin--swap--ensure) * [`interval`](#-collectd--plugin--swap--interval) * [`reportbydevice`](#-collectd--plugin--swap--reportbydevice) * [`reportbytes`](#-collectd--plugin--swap--reportbytes) * [`valuesabsolute`](#-collectd--plugin--swap--valuesabsolute) * [`valuespercentage`](#-collectd--plugin--swap--valuespercentage) * [`reportio`](#-collectd--plugin--swap--reportio) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ##### `reportbydevice` Data type: `Boolean` Default value: `false` ##### `reportbytes` Data type: `Boolean` Default value: `true` ##### `valuesabsolute` Data type: `Boolean` Default value: `true` ##### `valuespercentage` Data type: `Boolean` Default value: `false` ##### `reportio` Data type: `Boolean` Default value: `true` ### `collectd::plugin::sysevent` == Class: collectd::plugin::sysevent Class to manage sysevent plugin for collectd Documentation: https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_sysevent === Parameters [*ensure*] Ensure param for collectd::plugin type. Defaults to 'ensure' [*manage_package*] Set to true if Puppet should manage plugin package installation. Defaults to $collectd::manage_package [*listen_host*] Listen on this IP for incoming rsyslog messages. Defaults to '127.0.0.1' [*listen_port*] Listen on this port for incoming rsyslog messages. Defaults to 6666 [*regex_filter*] Enumerate a regex filter to apply to all incoming rsyslog messages. If a message matches this filter, it will be published. Defaults to '.*' [*buffer_size*] Maximum allowed size for incoming rsyslog messages. Messages that exceed this number will be truncated to this size. Default is 4096 bytes. Defaults to undef [*buffer_length*] Maximum number of rsyslog events that can be stored in plugin's ring buffer. Once an event has been read, its location becomes available for storing a new event. Defaults to undef #### Parameters The following parameters are available in the `collectd::plugin::sysevent` class: * [`ensure`](#-collectd--plugin--sysevent--ensure) * [`manage_package`](#-collectd--plugin--sysevent--manage_package) * [`listen_host`](#-collectd--plugin--sysevent--listen_host) * [`listen_port`](#-collectd--plugin--sysevent--listen_port) * [`regex_filter`](#-collectd--plugin--sysevent--regex_filter) * [`buffer_size`](#-collectd--plugin--sysevent--buffer_size) * [`buffer_length`](#-collectd--plugin--sysevent--buffer_length) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `listen_host` Data type: `Stdlib::Host` Default value: `'127.0.0.1'` ##### `listen_port` Data type: `Stdlib::Port` Default value: `6666` ##### `regex_filter` Data type: `String` Default value: `'/.*/'` ##### `buffer_size` Data type: `Optional[Integer[0]]` Default value: `undef` ##### `buffer_length` Data type: `Optional[Integer[1, default]]` Default value: `undef` ### `collectd::plugin::syslog` https://collectd.org/wiki/index.php/Plugin:SysLog #### Parameters The following parameters are available in the `collectd::plugin::syslog` class: * [`ensure`](#-collectd--plugin--syslog--ensure) * [`interval`](#-collectd--plugin--syslog--interval) * [`log_level`](#-collectd--plugin--syslog--log_level) * [`notify_level`](#-collectd--plugin--syslog--notify_level) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Float]` Default value: `undef` ##### `log_level` Data type: `Enum['debug', 'info', 'notice', 'warning', 'err']` Default value: `'info'` ##### `notify_level` Data type: `Optional[Enum['OKAY', 'WARNING', 'FAILURE']]` Default value: `undef` ### `collectd::plugin::table` Load and configure the table plugin * **See also** * https://collectd.org/wiki/index.php/Plugin:Table #### Examples ##### Parse `/proc/pressure/cpu` ```puppet class {'collectd::plugin::table': tables => { '/proc/pressure/cpu' => { 'plugin' => 'psi', 'instance => 'cpu', 'seperator' => ' =', 'results' => [{ 'type' => 'gauge', 'instance_from' => [0], 'instance_prefix' => 'arg10', 'values_from' => [2], }], } } } ``` #### Parameters The following parameters are available in the `collectd::plugin::table` class: * [`tables`](#-collectd--plugin--table--tables) * [`ensure`](#-collectd--plugin--table--ensure) * [`order`](#-collectd--plugin--table--order) ##### `tables` Data type: `Optional[Hash[String, Collectd::Table::Table, 1]]` `` blocks for table plugin Default value: `undef` ##### `ensure` Data type: `Enum['present', 'absent']` Should the plugin be configured Default value: `'present'` ##### `order` Data type: `Integer` Prefix of file in collectd config directory Default value: `10` ### `collectd::plugin::tail` Tail plugin https://collectd.org/wiki/index.php/Plugin:Tail #### Parameters The following parameters are available in the `collectd::plugin::tail` class: * [`interval`](#-collectd--plugin--tail--interval) * [`files`](#-collectd--plugin--tail--files) ##### `interval` Data type: `Any` Default value: `undef` ##### `files` Data type: `Hash` Default value: `{}` ### `collectd::plugin::tail_csv` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_tail_csv #### Parameters The following parameters are available in the `collectd::plugin::tail_csv` class: * [`metrics`](#-collectd--plugin--tail_csv--metrics) * [`files`](#-collectd--plugin--tail_csv--files) * [`ensure`](#-collectd--plugin--tail_csv--ensure) * [`order`](#-collectd--plugin--tail_csv--order) ##### `metrics` Data type: `Hash[String, Collectd::Tail_Csv::Metric, 1]` ##### `files` Data type: `Hash[String, Collectd::Tail_Csv::File, 1]` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `order` Data type: `Integer` Default value: `10` ### `collectd::plugin::target_v5upgrade` https://collectd.org/wiki/index.php/Target:v5_upgrade #### Parameters The following parameters are available in the `collectd::plugin::target_v5upgrade` class: * [`ensure`](#-collectd--plugin--target_v5upgrade--ensure) ##### `ensure` Data type: `Any` Default value: `'present'` ### `collectd::plugin::tcpconns` https://collectd.org/wiki/index.php/Plugin:TCPConns #### Parameters The following parameters are available in the `collectd::plugin::tcpconns` class: * [`localports`](#-collectd--plugin--tcpconns--localports) * [`remoteports`](#-collectd--plugin--tcpconns--remoteports) * [`listening`](#-collectd--plugin--tcpconns--listening) * [`interval`](#-collectd--plugin--tcpconns--interval) * [`allportssummary`](#-collectd--plugin--tcpconns--allportssummary) * [`ensure`](#-collectd--plugin--tcpconns--ensure) ##### `localports` Data type: `Optional[Array[Stdlib::Port]]` Default value: `undef` ##### `remoteports` Data type: `Optional[Array[Stdlib::Port]]` Default value: `undef` ##### `listening` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `allportssummary` Data type: `Optional[Boolean]` Default value: `undef` ##### `ensure` Data type: `Any` Default value: `'present'` ### `collectd::plugin::thermal` https://collectd.org/wiki/index.php/Plugin:thermal #### Parameters The following parameters are available in the `collectd::plugin::thermal` class: * [`devices`](#-collectd--plugin--thermal--devices) * [`ensure`](#-collectd--plugin--thermal--ensure) * [`ignoreselected`](#-collectd--plugin--thermal--ignoreselected) * [`interval`](#-collectd--plugin--thermal--interval) ##### `devices` Data type: `Array` Default value: `[]` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `ignoreselected` Data type: `Boolean` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::threshold` http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_threshold #### Parameters The following parameters are available in the `collectd::plugin::threshold` class: * [`ensure`](#-collectd--plugin--threshold--ensure) * [`interval`](#-collectd--plugin--threshold--interval) * [`types`](#-collectd--plugin--threshold--types) * [`plugins`](#-collectd--plugin--threshold--plugins) * [`hosts`](#-collectd--plugin--threshold--hosts) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Integer]` Default value: `undef` ##### `types` Data type: `Array[Collectd::Threshold::Type]` Default value: `[]` ##### `plugins` Data type: `Array[Collectd::Threshold::Plugin]` Default value: `[]` ##### `hosts` Data type: `Array[Collectd::Threshold::Host]` Default value: `[]` ### `collectd::plugin::turbostat` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_turbostat #### Parameters The following parameters are available in the `collectd::plugin::turbostat` class: * [`ensure`](#-collectd--plugin--turbostat--ensure) * [`core_c_states`](#-collectd--plugin--turbostat--core_c_states) * [`package_c_states`](#-collectd--plugin--turbostat--package_c_states) * [`system_management_interrupt`](#-collectd--plugin--turbostat--system_management_interrupt) * [`digital_temperature_sensor`](#-collectd--plugin--turbostat--digital_temperature_sensor) * [`tcc_activation_temp`](#-collectd--plugin--turbostat--tcc_activation_temp) * [`running_average_power_limit`](#-collectd--plugin--turbostat--running_average_power_limit) * [`logical_core_names`](#-collectd--plugin--turbostat--logical_core_names) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `core_c_states` Data type: `Optional[Integer]` Default value: `undef` ##### `package_c_states` Data type: `Optional[Integer]` Default value: `undef` ##### `system_management_interrupt` Data type: `Optional[Boolean]` Default value: `undef` ##### `digital_temperature_sensor` Data type: `Optional[Boolean]` Default value: `undef` ##### `tcc_activation_temp` Data type: `Optional[Integer]` Default value: `undef` ##### `running_average_power_limit` Data type: `Optional[Integer]` Default value: `undef` ##### `logical_core_names` Data type: `Optional[Boolean]` Default value: `undef` ### `collectd::plugin::unixsock` https://collectd.org/wiki/index.php/Plugin:UnixSock #### Parameters The following parameters are available in the `collectd::plugin::unixsock` class: * [`socketfile`](#-collectd--plugin--unixsock--socketfile) * [`socketgroup`](#-collectd--plugin--unixsock--socketgroup) * [`socketperms`](#-collectd--plugin--unixsock--socketperms) * [`deletesocket`](#-collectd--plugin--unixsock--deletesocket) * [`ensure`](#-collectd--plugin--unixsock--ensure) * [`interval`](#-collectd--plugin--unixsock--interval) ##### `socketfile` Data type: `Stdlib::Absolutepath` Default value: `'/var/run/collectd-unixsock'` ##### `socketgroup` Data type: `Any` Default value: `'collectd'` ##### `socketperms` Data type: `Any` Default value: `'0770'` ##### `deletesocket` Data type: `Any` Default value: `false` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::uptime` https://collectd.org/wiki/index.php/Plugin:Uptime #### Parameters The following parameters are available in the `collectd::plugin::uptime` class: * [`ensure`](#-collectd--plugin--uptime--ensure) * [`interval`](#-collectd--plugin--uptime--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::users` https://collectd.org/wiki/index.php/Plugin:Users #### Parameters The following parameters are available in the `collectd::plugin::users` class: * [`ensure`](#-collectd--plugin--users--ensure) * [`interval`](#-collectd--plugin--users--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::uuid` https://collectd.org/wiki/index.php/Plugin:UUID #### Parameters The following parameters are available in the `collectd::plugin::uuid` class: * [`uuid_file`](#-collectd--plugin--uuid--uuid_file) * [`ensure`](#-collectd--plugin--uuid--ensure) * [`interval`](#-collectd--plugin--uuid--interval) ##### `uuid_file` Data type: `Any` Default value: `'/etc/uuid'` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::varnish` https://collectd.org/wiki/index.php/Plugin:Varnish #### Parameters The following parameters are available in the `collectd::plugin::varnish` class: * [`ensure`](#-collectd--plugin--varnish--ensure) * [`manage_package`](#-collectd--plugin--varnish--manage_package) * [`instances`](#-collectd--plugin--varnish--instances) * [`interval`](#-collectd--plugin--varnish--interval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `instances` Data type: `Hash` Default value: ```puppet { 'localhost' => { }, } ``` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::virt` https://collectd.org/wiki/index.php/Plugin:virt #### Parameters The following parameters are available in the `collectd::plugin::virt` class: * [`connection`](#-collectd--plugin--virt--connection) * [`ensure`](#-collectd--plugin--virt--ensure) * [`manage_package`](#-collectd--plugin--virt--manage_package) * [`refresh_interval`](#-collectd--plugin--virt--refresh_interval) * [`domain`](#-collectd--plugin--virt--domain) * [`block_device`](#-collectd--plugin--virt--block_device) * [`interface_device`](#-collectd--plugin--virt--interface_device) * [`ignore_selected`](#-collectd--plugin--virt--ignore_selected) * [`plugin_instance_format`](#-collectd--plugin--virt--plugin_instance_format) * [`hostname_format`](#-collectd--plugin--virt--hostname_format) * [`interface_format`](#-collectd--plugin--virt--interface_format) * [`extra_stats`](#-collectd--plugin--virt--extra_stats) * [`interval`](#-collectd--plugin--virt--interval) ##### `connection` Data type: `String` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `refresh_interval` Data type: `Optional[Pattern[/^\d+$/]]` Default value: `undef` ##### `domain` Data type: `Optional[String]` Default value: `undef` ##### `block_device` Data type: `Optional[String]` Default value: `undef` ##### `interface_device` Data type: `Optional[String]` Default value: `undef` ##### `ignore_selected` Data type: `Optional[Boolean]` Default value: `undef` ##### `plugin_instance_format` Data type: `Optional[String[1]]` Default value: `undef` ##### `hostname_format` Data type: `Optional[String]` Default value: `undef` ##### `interface_format` Data type: `Optional[String]` Default value: `undef` ##### `extra_stats` Data type: `Optional[String]` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ### `collectd::plugin::vmem` https://collectd.org/wiki/index.php/Plugin:vmem #### Parameters The following parameters are available in the `collectd::plugin::vmem` class: * [`ensure`](#-collectd--plugin--vmem--ensure) * [`interval`](#-collectd--plugin--vmem--interval) * [`verbose`](#-collectd--plugin--vmem--verbose) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `interval` Data type: `Any` Default value: `undef` ##### `verbose` Data type: `Any` Default value: `false` ### `collectd::plugin::write_graphite` https://collectd.org/wiki/index.php/Graphite #### Parameters The following parameters are available in the `collectd::plugin::write_graphite` class: * [`carbons`](#-collectd--plugin--write_graphite--carbons) * [`carbon_defaults`](#-collectd--plugin--write_graphite--carbon_defaults) * [`ensure`](#-collectd--plugin--write_graphite--ensure) * [`globals`](#-collectd--plugin--write_graphite--globals) ##### `carbons` Data type: `Hash` Default value: `{}` ##### `carbon_defaults` Data type: `Any` Default value: `{}` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `globals` Data type: `Any` Default value: `false` ### `collectd::plugin::write_http` Enable write_http plugin * **See also** * https://collectd.org/wiki/index.php/Plugin:Write_HTTP #### Parameters The following parameters are available in the `collectd::plugin::write_http` class: * [`ensure`](#-collectd--plugin--write_http--ensure) * [`nodes`](#-collectd--plugin--write_http--nodes) * [`urls`](#-collectd--plugin--write_http--urls) * [`manage_package`](#-collectd--plugin--write_http--manage_package) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `nodes` Data type: `Hash[String, Hash[String, Scalar]]` Default value: `{}` ##### `urls` Data type: `Hash[String, Hash[String, Scalar]]` Default value: `{}` ##### `manage_package` Data type: `Optional[Boolean]` Default value: `undef` ### `collectd::plugin::write_kafka` The collectd::plugin::write_kafka class. #### Parameters The following parameters are available in the `collectd::plugin::write_kafka` class: * [`ensure`](#-collectd--plugin--write_kafka--ensure) * [`kafka_host`](#-collectd--plugin--write_kafka--kafka_host) * [`kafka_hosts`](#-collectd--plugin--write_kafka--kafka_hosts) * [`kafka_port`](#-collectd--plugin--write_kafka--kafka_port) * [`topics`](#-collectd--plugin--write_kafka--topics) * [`properties`](#-collectd--plugin--write_kafka--properties) * [`meta`](#-collectd--plugin--write_kafka--meta) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `kafka_host` Data type: `Any` Default value: `undef` ##### `kafka_hosts` Data type: `Array[String]` Default value: `['localhost:9092']` ##### `kafka_port` Data type: `Stdlib::Port` Default value: `9092` ##### `topics` Data type: `Hash` Default value: `{}` ##### `properties` Data type: `Hash` Default value: `{}` ##### `meta` Data type: `Hash` Default value: `{}` ### `collectd::plugin::write_log` The collectd::plugin::write_log class. #### Parameters The following parameters are available in the `collectd::plugin::write_log` class: * [`format`](#-collectd--plugin--write_log--format) * [`ensure`](#-collectd--plugin--write_log--ensure) ##### `format` Data type: `String` Default value: `'JSON'` ##### `ensure` Data type: `Any` Default value: `'present'` ### `collectd::plugin::write_network` A define to make a generic network output for collectd #### Parameters The following parameters are available in the `collectd::plugin::write_network` class: * [`ensure`](#-collectd--plugin--write_network--ensure) * [`servers`](#-collectd--plugin--write_network--servers) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `servers` Data type: `Hash` Default value: `{ 'localhost' => { 'serverport' => '25826' } }` ### `collectd::plugin::write_prometheus` Configures write_prometheus plugin. #### Parameters The following parameters are available in the `collectd::plugin::write_prometheus` class: * [`port`](#-collectd--plugin--write_prometheus--port) * [`ip`](#-collectd--plugin--write_prometheus--ip) * [`ensure`](#-collectd--plugin--write_prometheus--ensure) ##### `port` Data type: `Stdlib::Port` Defines the port on which to accept scrape requests from Prometheus. Default value: `9103` ##### `ip` Data type: `Optional[Stdlib::IP::Address]` Defines the IP address to bind to. In not specified, the listener will bind to all IPs present. Default value: `undef` ##### `ensure` Data type: `Any` Default value: `'present'` ### `collectd::plugin::write_riemann` https://collectd.org/wiki/index.php/Plugin:Write_Riemann #### Parameters The following parameters are available in the `collectd::plugin::write_riemann` class: * [`nodes`](#-collectd--plugin--write_riemann--nodes) * [`ensure`](#-collectd--plugin--write_riemann--ensure) * [`manage_package`](#-collectd--plugin--write_riemann--manage_package) * [`tags`](#-collectd--plugin--write_riemann--tags) * [`attributes`](#-collectd--plugin--write_riemann--attributes) ##### `nodes` Data type: `Array[Collectd::Write_riemann::Node]` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `manage_package` Data type: `Boolean` Default value: `$collectd::manage_package` ##### `tags` Data type: `Array[String[1]]` Default value: `[]` ##### `attributes` Data type: `Hash[String[1],String[1]]` Default value: `{}` ### `collectd::plugin::write_sensu` https://collectd.org/wiki/index.php/Plugin:Write_Sensu #### Parameters The following parameters are available in the `collectd::plugin::write_sensu` class: * [`ensure`](#-collectd--plugin--write_sensu--ensure) * [`manage_package`](#-collectd--plugin--write_sensu--manage_package) * [`sensu_host`](#-collectd--plugin--write_sensu--sensu_host) * [`sensu_port`](#-collectd--plugin--write_sensu--sensu_port) * [`store_rates`](#-collectd--plugin--write_sensu--store_rates) * [`always_append_ds`](#-collectd--plugin--write_sensu--always_append_ds) * [`metrics`](#-collectd--plugin--write_sensu--metrics) * [`metrics_handler`](#-collectd--plugin--write_sensu--metrics_handler) * [`notifications`](#-collectd--plugin--write_sensu--notifications) * [`notifs_handler`](#-collectd--plugin--write_sensu--notifs_handler) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `manage_package` Data type: `Any` Default value: `undef` ##### `sensu_host` Data type: `Stdlib::Host` Default value: `'localhost'` ##### `sensu_port` Data type: `Stdlib::Port` Default value: `3030` ##### `store_rates` Data type: `Boolean` Default value: `false` ##### `always_append_ds` Data type: `Boolean` Default value: `false` ##### `metrics` Data type: `Any` Default value: `false` ##### `metrics_handler` Data type: `Any` Default value: `'example_metric_handler'` ##### `notifications` Data type: `Any` Default value: `false` ##### `notifs_handler` Data type: `Any` Default value: `'example_notification_handler'` ### `collectd::plugin::write_tsdb` https://collectd.org/wiki/index.php/Plugin:Write_TSDB #### Parameters The following parameters are available in the `collectd::plugin::write_tsdb` class: * [`ensure`](#-collectd--plugin--write_tsdb--ensure) * [`globals`](#-collectd--plugin--write_tsdb--globals) * [`host`](#-collectd--plugin--write_tsdb--host) * [`port`](#-collectd--plugin--write_tsdb--port) * [`host_tags`](#-collectd--plugin--write_tsdb--host_tags) * [`store_rates`](#-collectd--plugin--write_tsdb--store_rates) * [`always_append_ds`](#-collectd--plugin--write_tsdb--always_append_ds) ##### `ensure` Data type: `Any` Default value: `present` ##### `globals` Data type: `Boolean` Default value: `false` ##### `host` Data type: `Stdlib::Host` Default value: `'localhost'` ##### `port` Data type: `Stdlib::Port` Default value: `4242` ##### `host_tags` Data type: `Array` Default value: `[]` ##### `store_rates` Data type: `Boolean` Default value: `false` ##### `always_append_ds` Data type: `Boolean` Default value: `false` ### `collectd::plugin::zfs_arc` https://collectd.org/wiki/index.php/Plugin:ZFS_ARC #### Parameters The following parameters are available in the `collectd::plugin::zfs_arc` class: * [`ensure`](#-collectd--plugin--zfs_arc--ensure) ##### `ensure` Data type: `Any` Default value: `'present'` ### `collectd::plugin::zookeeper` The collectd::plugin::zookeeper class. #### Parameters The following parameters are available in the `collectd::plugin::zookeeper` class: * [`ensure`](#-collectd--plugin--zookeeper--ensure) * [`interval`](#-collectd--plugin--zookeeper--interval) * [`zookeeper_host`](#-collectd--plugin--zookeeper--zookeeper_host) * [`zookeeper_port`](#-collectd--plugin--zookeeper--zookeeper_port) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `interval` Data type: `Optional[Integer]` Default value: `undef` ##### `zookeeper_host` Data type: `Stdlib::Host` Default value: `'localhost'` ##### `zookeeper_port` Data type: `Stdlib::Port` Default value: `2181` ### `collectd::repo` collectd::repo Handle package repo configuration ### `collectd::repo::debian` The collectd::repo::debian class. ### `collectd::repo::redhat` The collectd::repo::redhat class. ### `collectd::service` The collectd::service class. ## Defined types ### `collectd::plugin` The collectd::plugin class. #### Parameters The following parameters are available in the `collectd::plugin` defined type: * [`ensure`](#-collectd--plugin--ensure) * [`content`](#-collectd--plugin--content) * [`order`](#-collectd--plugin--order) * [`globals`](#-collectd--plugin--globals) * [`interval`](#-collectd--plugin--interval) * [`plugin`](#-collectd--plugin--plugin) * [`flushinterval`](#-collectd--plugin--flushinterval) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `content` Data type: `Any` Default value: `undef` ##### `order` Data type: `Any` Default value: `'10'` ##### `globals` Data type: `Any` Default value: `false` ##### `interval` Data type: `Any` Default value: `undef` ##### `plugin` Data type: `Any` Default value: `$name` ##### `flushinterval` Data type: `Optional[Integer]` Default value: `undef` ### `collectd::plugin::aggregation::aggregator` The collectd::plugin::aggregation::aggregator class. #### Parameters The following parameters are available in the `collectd::plugin::aggregation::aggregator` defined type: * [`ensure`](#-collectd--plugin--aggregation--aggregator--ensure) * [`host`](#-collectd--plugin--aggregation--aggregator--host) * [`plugin`](#-collectd--plugin--aggregation--aggregator--plugin) * [`plugininstance`](#-collectd--plugin--aggregation--aggregator--plugininstance) * [`agg_type`](#-collectd--plugin--aggregation--aggregator--agg_type) * [`typeinstance`](#-collectd--plugin--aggregation--aggregator--typeinstance) * [`sethost`](#-collectd--plugin--aggregation--aggregator--sethost) * [`setplugin`](#-collectd--plugin--aggregation--aggregator--setplugin) * [`setplugininstance`](#-collectd--plugin--aggregation--aggregator--setplugininstance) * [`settypeinstance`](#-collectd--plugin--aggregation--aggregator--settypeinstance) * [`groupby`](#-collectd--plugin--aggregation--aggregator--groupby) * [`calculatesum`](#-collectd--plugin--aggregation--aggregator--calculatesum) * [`calculatenum`](#-collectd--plugin--aggregation--aggregator--calculatenum) * [`calculateaverage`](#-collectd--plugin--aggregation--aggregator--calculateaverage) * [`calculateminimum`](#-collectd--plugin--aggregation--aggregator--calculateminimum) * [`calculatemaximum`](#-collectd--plugin--aggregation--aggregator--calculatemaximum) * [`calculatestddev`](#-collectd--plugin--aggregation--aggregator--calculatestddev) ##### `ensure` Data type: `String` Default value: `'present'` ##### `host` Data type: `Optional[String]` Default value: `undef` ##### `plugin` Data type: `Optional[String]` Default value: `undef` ##### `plugininstance` Data type: `Optional[Integer[0]]` Default value: `undef` ##### `agg_type` Data type: `Optional[String]` Default value: `undef` ##### `typeinstance` Data type: `Optional[String]` Default value: `undef` ##### `sethost` Data type: `Optional[String]` Default value: `undef` ##### `setplugin` Data type: `Optional[String]` Default value: `undef` ##### `setplugininstance` Data type: `Optional[Integer[0]]` Default value: `undef` ##### `settypeinstance` Data type: `Optional[String]` Default value: `undef` ##### `groupby` Data type: `Array[String]` Default value: `[]` ##### `calculatesum` Data type: `Optional[Boolean]` Default value: `undef` ##### `calculatenum` Data type: `Optional[Boolean]` Default value: `undef` ##### `calculateaverage` Data type: `Optional[Boolean]` Default value: `undef` ##### `calculateminimum` Data type: `Optional[Boolean]` Default value: `undef` ##### `calculatemaximum` Data type: `Optional[Boolean]` Default value: `undef` ##### `calculatestddev` Data type: `Optional[Boolean]` Default value: `undef` ### `collectd::plugin::apache::instance` https://collectd.org/wiki/index.php/Plugin:Apache #### Parameters The following parameters are available in the `collectd::plugin::apache::instance` defined type: * [`url`](#-collectd--plugin--apache--instance--url) * [`ensure`](#-collectd--plugin--apache--instance--ensure) * [`user`](#-collectd--plugin--apache--instance--user) * [`password`](#-collectd--plugin--apache--instance--password) * [`verifypeer`](#-collectd--plugin--apache--instance--verifypeer) * [`verifyhost`](#-collectd--plugin--apache--instance--verifyhost) * [`cacert`](#-collectd--plugin--apache--instance--cacert) * [`sslciphers`](#-collectd--plugin--apache--instance--sslciphers) * [`timeout`](#-collectd--plugin--apache--instance--timeout) ##### `url` Data type: `Stdlib::Httpurl` ##### `ensure` Data type: `String` Default value: `present` ##### `user` Data type: `Optional[String]` Default value: `undef` ##### `password` Data type: `Optional[String]` Default value: `undef` ##### `verifypeer` Data type: `Optional[Boolean]` Default value: `undef` ##### `verifyhost` Data type: `Optional[Boolean]` Default value: `undef` ##### `cacert` Data type: `Optional[Stdlib::Absolutepath]` Default value: `undef` ##### `sslciphers` Data type: `Optional[String]` Default value: `undef` ##### `timeout` Data type: `Optional[Integer]` Default value: `undef` ### `collectd::plugin::curl::page` The collectd::plugin::curl::page class. #### Parameters The following parameters are available in the `collectd::plugin::curl::page` defined type: * [`url`](#-collectd--plugin--curl--page--url) * [`ensure`](#-collectd--plugin--curl--page--ensure) * [`user`](#-collectd--plugin--curl--page--user) * [`password`](#-collectd--plugin--curl--page--password) * [`verifypeer`](#-collectd--plugin--curl--page--verifypeer) * [`verifyhost`](#-collectd--plugin--curl--page--verifyhost) * [`cacert`](#-collectd--plugin--curl--page--cacert) * [`header`](#-collectd--plugin--curl--page--header) * [`measureresponsetime`](#-collectd--plugin--curl--page--measureresponsetime) * [`measureresponsecode`](#-collectd--plugin--curl--page--measureresponsecode) * [`matches`](#-collectd--plugin--curl--page--matches) * [`plugininstance`](#-collectd--plugin--curl--page--plugininstance) ##### `url` Data type: `String` ##### `ensure` Data type: `String` Default value: `'present'` ##### `user` Data type: `Optional[String]` Default value: `undef` ##### `password` Data type: `Optional[String]` Default value: `undef` ##### `verifypeer` Data type: `Optional[Boolean]` Default value: `undef` ##### `verifyhost` Data type: `Optional[Boolean]` Default value: `undef` ##### `cacert` Data type: `Optional[Stdlib::Absolutepath]` Default value: `undef` ##### `header` Data type: `Optional[String]` Default value: `undef` ##### `measureresponsetime` Data type: `Optional[Boolean]` Default value: `undef` ##### `measureresponsecode` Data type: `Optional[Boolean]` Default value: `undef` ##### `matches` Data type: `Optional[Array[Hash]]` Default value: `undef` ##### `plugininstance` Data type: `String` Default value: `$name` ### `collectd::plugin::curl_json` See http://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_curl_json #### Parameters The following parameters are available in the `collectd::plugin::curl_json` defined type: * [`url`](#-collectd--plugin--curl_json--url) * [`instance`](#-collectd--plugin--curl_json--instance) * [`keys`](#-collectd--plugin--curl_json--keys) * [`ensure`](#-collectd--plugin--curl_json--ensure) * [`host`](#-collectd--plugin--curl_json--host) * [`interval`](#-collectd--plugin--curl_json--interval) * [`user`](#-collectd--plugin--curl_json--user) * [`password`](#-collectd--plugin--curl_json--password) * [`digest`](#-collectd--plugin--curl_json--digest) * [`verifypeer`](#-collectd--plugin--curl_json--verifypeer) * [`verifyhost`](#-collectd--plugin--curl_json--verifyhost) * [`cacert`](#-collectd--plugin--curl_json--cacert) * [`header`](#-collectd--plugin--curl_json--header) * [`post`](#-collectd--plugin--curl_json--post) * [`timeout`](#-collectd--plugin--curl_json--timeout) * [`order`](#-collectd--plugin--curl_json--order) * [`manage_package`](#-collectd--plugin--curl_json--manage_package) ##### `url` Data type: `Any` ##### `instance` Data type: `Any` ##### `keys` Data type: `Hash` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `host` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `user` Data type: `Any` Default value: `undef` ##### `password` Data type: `Any` Default value: `undef` ##### `digest` Data type: `Any` Default value: `undef` ##### `verifypeer` Data type: `Any` Default value: `undef` ##### `verifyhost` Data type: `Any` Default value: `undef` ##### `cacert` Data type: `Any` Default value: `undef` ##### `header` Data type: `Any` Default value: `undef` ##### `post` Data type: `Any` Default value: `undef` ##### `timeout` Data type: `Any` Default value: `undef` ##### `order` Data type: `Any` Default value: `'10'` ##### `manage_package` Data type: `Any` Default value: `undef` ### `collectd::plugin::dbi::database` database allows you to create blocks with the same name of database, #### Parameters The following parameters are available in the `collectd::plugin::dbi::database` defined type: * [`driver`](#-collectd--plugin--dbi--database--driver) * [`ensure`](#-collectd--plugin--dbi--database--ensure) * [`host`](#-collectd--plugin--dbi--database--host) * [`databasename`](#-collectd--plugin--dbi--database--databasename) * [`driveroption`](#-collectd--plugin--dbi--database--driveroption) * [`selectdb`](#-collectd--plugin--dbi--database--selectdb) * [`query`](#-collectd--plugin--dbi--database--query) * [`db_query_interval`](#-collectd--plugin--dbi--database--db_query_interval) ##### `driver` Data type: `String` ##### `ensure` Data type: `String` Default value: `'present'` ##### `host` Data type: `Optional[String]` Default value: `undef` ##### `databasename` Data type: `String` Default value: `$name` ##### `driveroption` Data type: `Hash` Default value: `{}` ##### `selectdb` Data type: `Optional[String]` Default value: `undef` ##### `query` Data type: `Array` Default value: `[]` ##### `db_query_interval` Data type: `Optional[Integer[1]]` Default value: `undef` ### `collectd::plugin::dbi::query` The collectd::plugin::dbi::query class. #### Parameters The following parameters are available in the `collectd::plugin::dbi::query` defined type: * [`statement`](#-collectd--plugin--dbi--query--statement) * [`ensure`](#-collectd--plugin--dbi--query--ensure) * [`results`](#-collectd--plugin--dbi--query--results) * [`minversion`](#-collectd--plugin--dbi--query--minversion) * [`maxversion`](#-collectd--plugin--dbi--query--maxversion) ##### `statement` Data type: `String` ##### `ensure` Data type: `String` Default value: `'present'` ##### `results` Data type: `Array` Default value: `[{}]` ##### `minversion` Data type: `Optional[String]` Default value: `undef` ##### `maxversion` Data type: `Optional[String]` Default value: `undef` ### `collectd::plugin::exec::cmd` The collectd::plugin::exec::cmd class. #### Parameters The following parameters are available in the `collectd::plugin::exec::cmd` defined type: * [`user`](#-collectd--plugin--exec--cmd--user) * [`group`](#-collectd--plugin--exec--cmd--group) * [`exec`](#-collectd--plugin--exec--cmd--exec) * [`notification_exec`](#-collectd--plugin--exec--cmd--notification_exec) ##### `user` Data type: `String` ##### `group` Data type: `String` ##### `exec` Data type: `Array` Default value: `[]` ##### `notification_exec` Data type: `Array` Default value: `[]` ### `collectd::plugin::filecount::directory` https://collectd.org/wiki/index.php/Plugin:FileCount #### Parameters The following parameters are available in the `collectd::plugin::filecount::directory` defined type: * [`path`](#-collectd--plugin--filecount--directory--path) * [`ensure`](#-collectd--plugin--filecount--directory--ensure) * [`instance`](#-collectd--plugin--filecount--directory--instance) * [`pattern`](#-collectd--plugin--filecount--directory--pattern) * [`mtime`](#-collectd--plugin--filecount--directory--mtime) * [`size`](#-collectd--plugin--filecount--directory--size) * [`recursive`](#-collectd--plugin--filecount--directory--recursive) * [`includehidden`](#-collectd--plugin--filecount--directory--includehidden) ##### `path` Data type: `Stdlib::Absolutepath` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `instance` Data type: `String` Default value: `$name` ##### `pattern` Data type: `Optional[String]` Default value: `undef` ##### `mtime` Data type: `Optional[String]` Default value: `undef` ##### `size` Data type: `Optional[String]` Default value: `undef` ##### `recursive` Data type: `Optional[Boolean]` Default value: `undef` ##### `includehidden` Data type: `Optional[Boolean]` Default value: `undef` ### `collectd::plugin::filter::chain` https://collectd.org/wiki/index.php/Chains #### Parameters The following parameters are available in the `collectd::plugin::filter::chain` defined type: * [`ensure`](#-collectd--plugin--filter--chain--ensure) * [`target`](#-collectd--plugin--filter--chain--target) * [`target_options`](#-collectd--plugin--filter--chain--target_options) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `target` Data type: `Optional[Collectd::Filter::Target]` Default value: `undef` ##### `target_options` Data type: `Optional[Hash]` Default value: `undef` ### `collectd::plugin::filter::match` https://collectd.org/wiki/index.php/Chains #### Parameters The following parameters are available in the `collectd::plugin::filter::match` defined type: * [`chain`](#-collectd--plugin--filter--match--chain) * [`rule`](#-collectd--plugin--filter--match--rule) * [`plugin`](#-collectd--plugin--filter--match--plugin) * [`options`](#-collectd--plugin--filter--match--options) ##### `chain` Data type: `String` ##### `rule` Data type: `String` ##### `plugin` Data type: `Collectd::Filter::Match` ##### `options` Data type: `Optional[Hash]` Default value: `undef` ### `collectd::plugin::filter::rule` https://collectd.org/wiki/index.php/Chains #### Parameters The following parameters are available in the `collectd::plugin::filter::rule` defined type: * [`chain`](#-collectd--plugin--filter--rule--chain) ##### `chain` Data type: `String` ### `collectd::plugin::filter::target` https://collectd.org/wiki/index.php/Chains #### Parameters The following parameters are available in the `collectd::plugin::filter::target` defined type: * [`chain`](#-collectd--plugin--filter--target--chain) * [`plugin`](#-collectd--plugin--filter--target--plugin) * [`options`](#-collectd--plugin--filter--target--options) * [`rule`](#-collectd--plugin--filter--target--rule) ##### `chain` Data type: `String` ##### `plugin` Data type: `Collectd::Filter::Target` ##### `options` Data type: `Optional[Hash]` Default value: `undef` ##### `rule` Data type: `Optional[String]` Default value: `undef` ### `collectd::plugin::genericjmx::connection` https://collectd.org/wiki/index.php/Plugin:GenericJMX #### Parameters The following parameters are available in the `collectd::plugin::genericjmx::connection` defined type: * [`collect`](#-collectd--plugin--genericjmx--connection--collect) * [`service_url`](#-collectd--plugin--genericjmx--connection--service_url) * [`host`](#-collectd--plugin--genericjmx--connection--host) * [`user`](#-collectd--plugin--genericjmx--connection--user) * [`password`](#-collectd--plugin--genericjmx--connection--password) * [`instance_prefix`](#-collectd--plugin--genericjmx--connection--instance_prefix) ##### `collect` Data type: `Array` ##### `service_url` Data type: `String` ##### `host` Data type: `Optional[String]` Default value: `undef` ##### `user` Data type: `Optional[String]` Default value: `undef` ##### `password` Data type: `Optional[String]` Default value: `undef` ##### `instance_prefix` Data type: `Optional[String]` Default value: `undef` ### `collectd::plugin::genericjmx::mbean` https://collectd.org/wiki/index.php/Plugin:GenericJMX #### Parameters The following parameters are available in the `collectd::plugin::genericjmx::mbean` defined type: * [`object_name`](#-collectd--plugin--genericjmx--mbean--object_name) * [`values`](#-collectd--plugin--genericjmx--mbean--values) * [`instance_prefix`](#-collectd--plugin--genericjmx--mbean--instance_prefix) * [`instance_from`](#-collectd--plugin--genericjmx--mbean--instance_from) ##### `object_name` Data type: `String` ##### `values` Data type: `Array` ##### `instance_prefix` Data type: `Optional[String]` Default value: `undef` ##### `instance_from` Data type: `Array` Default value: `[]` ### `collectd::plugin::mysql::database` The collectd::plugin::mysql::database class. #### Parameters The following parameters are available in the `collectd::plugin::mysql::database` defined type: * [`ensure`](#-collectd--plugin--mysql--database--ensure) * [`database`](#-collectd--plugin--mysql--database--database) * [`host`](#-collectd--plugin--mysql--database--host) * [`port`](#-collectd--plugin--mysql--database--port) * [`masterstats`](#-collectd--plugin--mysql--database--masterstats) * [`slavestats`](#-collectd--plugin--mysql--database--slavestats) * [`username`](#-collectd--plugin--mysql--database--username) * [`password`](#-collectd--plugin--mysql--database--password) * [`socket`](#-collectd--plugin--mysql--database--socket) * [`innodbstats`](#-collectd--plugin--mysql--database--innodbstats) * [`slavenotifications`](#-collectd--plugin--mysql--database--slavenotifications) * [`wsrepstats`](#-collectd--plugin--mysql--database--wsrepstats) * [`aliasname`](#-collectd--plugin--mysql--database--aliasname) * [`connecttimeout`](#-collectd--plugin--mysql--database--connecttimeout) * [`sslkey`](#-collectd--plugin--mysql--database--sslkey) * [`sslcert`](#-collectd--plugin--mysql--database--sslcert) * [`sslca`](#-collectd--plugin--mysql--database--sslca) * [`sslcapath`](#-collectd--plugin--mysql--database--sslcapath) * [`sslcipher`](#-collectd--plugin--mysql--database--sslcipher) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `database` Data type: `String` Default value: `$name` ##### `host` Data type: `Optional[Stdlib::Host]` Default value: `undef` ##### `port` Data type: `Optional[Stdlib::Port]` Default value: `undef` ##### `masterstats` Data type: `Boolean` Default value: `false` ##### `slavestats` Data type: `Boolean` Default value: `false` ##### `username` Data type: `Optional[String[1]]` Default value: `undef` ##### `password` Data type: `Optional[String[1]]` Default value: `undef` ##### `socket` Data type: `Optional[String]` Default value: `undef` ##### `innodbstats` Data type: `Optional[Boolean]` Default value: `undef` ##### `slavenotifications` Data type: `Optional[String]` Default value: `undef` ##### `wsrepstats` Data type: `Optional[Boolean]` Default value: `undef` ##### `aliasname` Data type: `Optional[String]` Default value: `undef` ##### `connecttimeout` Data type: `Optional[Integer]` Default value: `undef` ##### `sslkey` Data type: `Optional[String]` Default value: `undef` ##### `sslcert` Data type: `Optional[String]` Default value: `undef` ##### `sslca` Data type: `Optional[String]` Default value: `undef` ##### `sslcapath` Data type: `Optional[String]` Default value: `undef` ##### `sslcipher` Data type: `Optional[String]` Default value: `undef` ### `collectd::plugin::network::listener` The collectd::plugin::network::listener class. #### Parameters The following parameters are available in the `collectd::plugin::network::listener` defined type: * [`ensure`](#-collectd--plugin--network--listener--ensure) * [`authfile`](#-collectd--plugin--network--listener--authfile) * [`port`](#-collectd--plugin--network--listener--port) * [`securitylevel`](#-collectd--plugin--network--listener--securitylevel) * [`interface`](#-collectd--plugin--network--listener--interface) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `authfile` Data type: `Optional[Stdlib::Absolutepath]` Default value: `undef` ##### `port` Data type: `Optional[Stdlib::Port]` Default value: `undef` ##### `securitylevel` Data type: `Optional[Collectd::Network::SecurityLevel]` Default value: `undef` ##### `interface` Data type: `Optional[String]` Default value: `undef` ### `collectd::plugin::network::server` The collectd::plugin::network::server class. #### Parameters The following parameters are available in the `collectd::plugin::network::server` defined type: * [`ensure`](#-collectd--plugin--network--server--ensure) * [`username`](#-collectd--plugin--network--server--username) * [`password`](#-collectd--plugin--network--server--password) * [`port`](#-collectd--plugin--network--server--port) * [`securitylevel`](#-collectd--plugin--network--server--securitylevel) * [`interface`](#-collectd--plugin--network--server--interface) * [`forward`](#-collectd--plugin--network--server--forward) * [`resolveinterval`](#-collectd--plugin--network--server--resolveinterval) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `username` Data type: `Optional[String]` Default value: `undef` ##### `password` Data type: `Optional[String]` Default value: `undef` ##### `port` Data type: `Optional[Stdlib::Port]` Default value: `undef` ##### `securitylevel` Data type: `Optional[Collectd::Network::SecurityLevel]` Default value: `undef` ##### `interface` Data type: `Optional[String]` Default value: `undef` ##### `forward` Data type: `Optional[Boolean]` Default value: `undef` ##### `resolveinterval` Data type: `Optional[Integer[1]]` Default value: `undef` ### `collectd::plugin::nut::ups` The collectd::plugin::nut::ups class. #### Parameters The following parameters are available in the `collectd::plugin::nut::ups` defined type: * [`ensure`](#-collectd--plugin--nut--ups--ensure) ##### `ensure` Data type: `Any` Default value: `'present'` ### `collectd::plugin::oracle::database` https://collectd.org/wiki/index.php/Plugin:Oracle #### Parameters The following parameters are available in the `collectd::plugin::oracle::database` defined type: * [`username`](#-collectd--plugin--oracle--database--username) * [`password`](#-collectd--plugin--oracle--database--password) * [`query`](#-collectd--plugin--oracle--database--query) * [`connect_id`](#-collectd--plugin--oracle--database--connect_id) * [`database`](#-collectd--plugin--oracle--database--database) ##### `username` Data type: `String` ##### `password` Data type: `String` ##### `query` Data type: `Array` ##### `connect_id` Data type: `String` Default value: `$name` ##### `database` Data type: `String` Default value: `$name` ### `collectd::plugin::oracle::query` https://collectd.org/wiki/index.php/Plugin:Oracle #### Parameters The following parameters are available in the `collectd::plugin::oracle::query` defined type: * [`statement`](#-collectd--plugin--oracle--query--statement) * [`results`](#-collectd--plugin--oracle--query--results) * [`query`](#-collectd--plugin--oracle--query--query) ##### `statement` Data type: `String` ##### `results` Data type: `Array` ##### `query` Data type: `String` Default value: `$name` ### `collectd::plugin::perl::plugin` The collectd::plugin::perl::plugin class. #### Parameters The following parameters are available in the `collectd::plugin::perl::plugin` defined type: * [`module`](#-collectd--plugin--perl--plugin--module) * [`manage_package`](#-collectd--plugin--perl--plugin--manage_package) * [`enable_debugger`](#-collectd--plugin--perl--plugin--enable_debugger) * [`include_dir`](#-collectd--plugin--perl--plugin--include_dir) * [`provider`](#-collectd--plugin--perl--plugin--provider) * [`source`](#-collectd--plugin--perl--plugin--source) * [`destination`](#-collectd--plugin--perl--plugin--destination) * [`order`](#-collectd--plugin--perl--plugin--order) * [`config`](#-collectd--plugin--perl--plugin--config) ##### `module` Data type: `Any` ##### `manage_package` Data type: `Any` Default value: `true` ##### `enable_debugger` Data type: `Variant[Boolean, String]` Default value: `false` ##### `include_dir` Data type: `Variant[Boolean, String, Array]` Default value: `false` ##### `provider` Data type: `Any` Default value: `false` ##### `source` Data type: `Variant[Boolean, String]` Default value: `false` ##### `destination` Data type: `Variant[Boolean, String]` Default value: `false` ##### `order` Data type: `String` Default value: `'01'` ##### `config` Data type: `Hash` Default value: `{}` ### `collectd::plugin::postgresql::database` databasename allows you to create blocks with the same name of database, useful if you have multiple instances of different version of pg #### Parameters The following parameters are available in the `collectd::plugin::postgresql::database` defined type: * [`ensure`](#-collectd--plugin--postgresql--database--ensure) * [`host`](#-collectd--plugin--postgresql--database--host) * [`databasename`](#-collectd--plugin--postgresql--database--databasename) * [`port`](#-collectd--plugin--postgresql--database--port) * [`user`](#-collectd--plugin--postgresql--database--user) * [`password`](#-collectd--plugin--postgresql--database--password) * [`sslmode`](#-collectd--plugin--postgresql--database--sslmode) * [`query`](#-collectd--plugin--postgresql--database--query) * [`interval`](#-collectd--plugin--postgresql--database--interval) * [`instance`](#-collectd--plugin--postgresql--database--instance) * [`krbsrvname`](#-collectd--plugin--postgresql--database--krbsrvname) * [`writer`](#-collectd--plugin--postgresql--database--writer) * [`service`](#-collectd--plugin--postgresql--database--service) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `host` Data type: `Optional[Stdlib::Host]` Default value: `undef` ##### `databasename` Data type: `Any` Default value: `$name` ##### `port` Data type: `Optional[Stdlib::Port]` Default value: `undef` ##### `user` Data type: `Any` Default value: `undef` ##### `password` Data type: `Any` Default value: `undef` ##### `sslmode` Data type: `Any` Default value: `undef` ##### `query` Data type: `Any` Default value: `[]` ##### `interval` Data type: `Any` Default value: `undef` ##### `instance` Data type: `Any` Default value: `undef` ##### `krbsrvname` Data type: `Any` Default value: `undef` ##### `writer` Data type: `Any` Default value: `undef` ##### `service` Data type: `Any` Default value: `undef` ### `collectd::plugin::postgresql::query` The collectd::plugin::postgresql::query class. #### Parameters The following parameters are available in the `collectd::plugin::postgresql::query` defined type: * [`ensure`](#-collectd--plugin--postgresql--query--ensure) * [`statement`](#-collectd--plugin--postgresql--query--statement) * [`params`](#-collectd--plugin--postgresql--query--params) * [`results`](#-collectd--plugin--postgresql--query--results) * [`minversion`](#-collectd--plugin--postgresql--query--minversion) * [`maxversion`](#-collectd--plugin--postgresql--query--maxversion) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `statement` Data type: `String` Default value: `undef` ##### `params` Data type: `Array` Default value: `[]` ##### `results` Data type: `Array` Default value: `[{}]` ##### `minversion` Data type: `Any` Default value: `undef` ##### `maxversion` Data type: `Any` Default value: `undef` ### `collectd::plugin::postgresql::writer` The collectd::plugin::postgresql::writer class. #### Parameters The following parameters are available in the `collectd::plugin::postgresql::writer` defined type: * [`ensure`](#-collectd--plugin--postgresql--writer--ensure) * [`statement`](#-collectd--plugin--postgresql--writer--statement) * [`storerates`](#-collectd--plugin--postgresql--writer--storerates) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `statement` Data type: `String` Default value: `undef` ##### `storerates` Data type: `Any` Default value: `undef` ### `collectd::plugin::powerdns::recursor` The collectd::plugin::powerdns::recursor class. #### Parameters The following parameters are available in the `collectd::plugin::powerdns::recursor` defined type: * [`ensure`](#-collectd--plugin--powerdns--recursor--ensure) * [`socket`](#-collectd--plugin--powerdns--recursor--socket) * [`collect`](#-collectd--plugin--powerdns--recursor--collect) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `socket` Data type: `Optional[String[1]]` Default value: `undef` ##### `collect` Data type: `Array[String[1]]` Default value: `[]` ### `collectd::plugin::powerdns::server` The collectd::plugin::powerdns::server class. #### Parameters The following parameters are available in the `collectd::plugin::powerdns::server` defined type: * [`ensure`](#-collectd--plugin--powerdns--server--ensure) * [`socket`](#-collectd--plugin--powerdns--server--socket) * [`collect`](#-collectd--plugin--powerdns--server--collect) ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `socket` Data type: `Optional[String[1]]` Default value: `undef` ##### `collect` Data type: `Array[String[1]]` Default value: `[]` ### `collectd::plugin::processes::process` The collectd::plugin::processes::process class. #### Parameters The following parameters are available in the `collectd::plugin::processes::process` defined type: * [`process`](#-collectd--plugin--processes--process--process) * [`ensure`](#-collectd--plugin--processes--process--ensure) * [`collect_context_switch`](#-collectd--plugin--processes--process--collect_context_switch) * [`collect_file_descriptor`](#-collectd--plugin--processes--process--collect_file_descriptor) * [`collect_memory_maps`](#-collectd--plugin--processes--process--collect_memory_maps) ##### `process` Data type: `String` Default value: `$name` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `collect_context_switch` Data type: `Optional[Boolean]` Default value: `undef` ##### `collect_file_descriptor` Data type: `Optional[Boolean]` Default value: `undef` ##### `collect_memory_maps` Data type: `Optional[Boolean]` Default value: `undef` ### `collectd::plugin::processes::processmatch` The collectd::plugin::processes::processmatch class. #### Parameters The following parameters are available in the `collectd::plugin::processes::processmatch` defined type: * [`regex`](#-collectd--plugin--processes--processmatch--regex) * [`ensure`](#-collectd--plugin--processes--processmatch--ensure) * [`matchname`](#-collectd--plugin--processes--processmatch--matchname) * [`collect_context_switch`](#-collectd--plugin--processes--processmatch--collect_context_switch) * [`collect_file_descriptor`](#-collectd--plugin--processes--processmatch--collect_file_descriptor) * [`collect_memory_maps`](#-collectd--plugin--processes--processmatch--collect_memory_maps) ##### `regex` Data type: `Any` ##### `ensure` Data type: `Any` Default value: `'present'` ##### `matchname` Data type: `Any` Default value: `$name` ##### `collect_context_switch` Data type: `Optional[Boolean]` Default value: `undef` ##### `collect_file_descriptor` Data type: `Optional[Boolean]` Default value: `undef` ##### `collect_memory_maps` Data type: `Optional[Boolean]` Default value: `undef` ### `collectd::plugin::python::module` Single module definition #### Parameters The following parameters are available in the `collectd::plugin::python::module` defined type: * [`config`](#-collectd--plugin--python--module--config) * [`ensure`](#-collectd--plugin--python--module--ensure) * [`module`](#-collectd--plugin--python--module--module) * [`module_import`](#-collectd--plugin--python--module--module_import) * [`modulepath`](#-collectd--plugin--python--module--modulepath) * [`script_source`](#-collectd--plugin--python--module--script_source) ##### `config` Data type: `Array[Hash[String,Variant[String,Boolean,Numeric,Array[Variant[Boolean,String,Numeric]]]]]` Default value: `[]` ##### `ensure` Data type: `Enum['present','absent']` Default value: `'present'` ##### `module` Data type: `String` Default value: `$title` ##### `module_import` Data type: `Optional[String]` Default value: `undef` ##### `modulepath` Data type: `Optional[Stdlib::Absolutepath]` Default value: `undef` ##### `script_source` Data type: `Optional[String]` Default value: `undef` ### `collectd::plugin::snmp::data` https://collectd.org/wiki/index.php/Plugin:SNMP #### Parameters The following parameters are available in the `collectd::plugin::snmp::data` defined type: * [`instance`](#-collectd--plugin--snmp--data--instance) * [`type`](#-collectd--plugin--snmp--data--type) * [`values`](#-collectd--plugin--snmp--data--values) * [`ensure`](#-collectd--plugin--snmp--data--ensure) * [`instance_prefix`](#-collectd--plugin--snmp--data--instance_prefix) * [`scale`](#-collectd--plugin--snmp--data--scale) * [`shift`](#-collectd--plugin--snmp--data--shift) * [`table`](#-collectd--plugin--snmp--data--table) * [`ignore`](#-collectd--plugin--snmp--data--ignore) * [`invert_match`](#-collectd--plugin--snmp--data--invert_match) ##### `instance` Data type: `String` ##### `type` Data type: `String[1]` ##### `values` Data type: `Variant[String[1], Array[String[1], 1]]` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `instance_prefix` Data type: `Optional[String[1]]` Default value: `undef` ##### `scale` Data type: `Optional[Numeric]` Default value: `undef` ##### `shift` Data type: `Optional[Numeric]` Default value: `undef` ##### `table` Data type: `Boolean` Default value: `false` ##### `ignore` Data type: `Optional[Variant[String[1], Array[String[1], 1]]]` Default value: `undef` ##### `invert_match` Data type: `Boolean` Default value: `false` ### `collectd::plugin::snmp::host` https://collectd.org/wiki/index.php/Plugin:SNMP #### Parameters The following parameters are available in the `collectd::plugin::snmp::host` defined type: * [`collect`](#-collectd--plugin--snmp--host--collect) * [`ensure`](#-collectd--plugin--snmp--host--ensure) * [`address`](#-collectd--plugin--snmp--host--address) * [`version`](#-collectd--plugin--snmp--host--version) * [`interval`](#-collectd--plugin--snmp--host--interval) * [`community`](#-collectd--plugin--snmp--host--community) * [`username`](#-collectd--plugin--snmp--host--username) * [`security_level`](#-collectd--plugin--snmp--host--security_level) * [`context`](#-collectd--plugin--snmp--host--context) * [`auth_protocol`](#-collectd--plugin--snmp--host--auth_protocol) * [`auth_passphrase`](#-collectd--plugin--snmp--host--auth_passphrase) * [`privacy_protocol`](#-collectd--plugin--snmp--host--privacy_protocol) * [`privacy_passphrase`](#-collectd--plugin--snmp--host--privacy_passphrase) ##### `collect` Data type: `Variant[String[1], Array[String[1], 1]]` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `address` Data type: `String[1]` Default value: `$name` ##### `version` Data type: `Collectd::SNMP::Version` Default value: `'1'` ##### `interval` Data type: `Optional[Integer[0]]` Default value: `undef` ##### `community` Data type: `String[1]` Default value: `'public'` ##### `username` Data type: `Optional[String[1]]` Default value: `undef` ##### `security_level` Data type: `Optional[Collectd::SNMP::SecurityLevel]` Default value: `undef` ##### `context` Data type: `Optional[String[1]]` Default value: `undef` ##### `auth_protocol` Data type: `Optional[Collectd::SNMP::AuthProtocol]` Default value: `undef` ##### `auth_passphrase` Data type: `Optional[String[1]]` Default value: `undef` ##### `privacy_protocol` Data type: `Optional[Collectd::SNMP::PrivacyProtocol]` Default value: `undef` ##### `privacy_passphrase` Data type: `Optional[String[1]]` Default value: `undef` ### `collectd::plugin::table::table` table definition for table plugin #### Examples ##### Parse the /proc/uptime file ```puppet collectd::plugin::table::table{'/proc/uptime': table => { 'plugin' => 'uptime', 'instance' => 'first', 'separator' => ' ', 'results' => [{ 'type' => 'gauge', 'values_from' => [0], }], } } ``` #### Parameters The following parameters are available in the `collectd::plugin::table::table` defined type: * [`$tablename`](#-collectd--plugin--table--table---tablename) * [`$table`](#-collectd--plugin--table--table---table) * [`table`](#-collectd--plugin--table--table--table) * [`ensure`](#-collectd--plugin--table--table--ensure) * [`tablename`](#-collectd--plugin--table--table--tablename) ##### `$tablename` Name of table typically a filename ##### `$table` Table definition ##### `table` Data type: `Collectd::Table::Table` ##### `ensure` Data type: `Enum['present', 'absent']` Default value: `'present'` ##### `tablename` Data type: `Stdlib::Unixpath` Default value: `$name` ### `collectd::plugin::tail::file` The collectd::plugin::tail::file class. #### Parameters The following parameters are available in the `collectd::plugin::tail::file` defined type: * [`filename`](#-collectd--plugin--tail--file--filename) * [`instance`](#-collectd--plugin--tail--file--instance) * [`matches`](#-collectd--plugin--tail--file--matches) * [`ensure`](#-collectd--plugin--tail--file--ensure) ##### `filename` Data type: `Stdlib::Absolutepath` ##### `instance` Data type: `String` ##### `matches` Data type: `Array[Hash]` ##### `ensure` Data type: `Any` Default value: `'present'` ### `collectd::plugin::write_graphite::carbon` a single graphite backend #### Parameters The following parameters are available in the `collectd::plugin::write_graphite::carbon` defined type: * [`ensure`](#-collectd--plugin--write_graphite--carbon--ensure) * [`graphitehost`](#-collectd--plugin--write_graphite--carbon--graphitehost) * [`graphiteport`](#-collectd--plugin--write_graphite--carbon--graphiteport) * [`storerates`](#-collectd--plugin--write_graphite--carbon--storerates) * [`graphiteprefix`](#-collectd--plugin--write_graphite--carbon--graphiteprefix) * [`graphitepostfix`](#-collectd--plugin--write_graphite--carbon--graphitepostfix) * [`interval`](#-collectd--plugin--write_graphite--carbon--interval) * [`escapecharacter`](#-collectd--plugin--write_graphite--carbon--escapecharacter) * [`alwaysappendds`](#-collectd--plugin--write_graphite--carbon--alwaysappendds) * [`protocol`](#-collectd--plugin--write_graphite--carbon--protocol) * [`separateinstances`](#-collectd--plugin--write_graphite--carbon--separateinstances) * [`logsenderrors`](#-collectd--plugin--write_graphite--carbon--logsenderrors) * [`reconnectinterval`](#-collectd--plugin--write_graphite--carbon--reconnectinterval) * [`reversehost`](#-collectd--plugin--write_graphite--carbon--reversehost) * [`preserveseparator`](#-collectd--plugin--write_graphite--carbon--preserveseparator) * [`dropduplicatefields`](#-collectd--plugin--write_graphite--carbon--dropduplicatefields) ##### `ensure` Data type: `Any` Default value: `'present'` ##### `graphitehost` Data type: `Stdlib::Host` Default value: `'localhost'` ##### `graphiteport` Data type: `Stdlib::Port` Default value: `2003` ##### `storerates` Data type: `Boolean` Default value: `true` ##### `graphiteprefix` Data type: `Any` Default value: `'collectd.'` ##### `graphitepostfix` Data type: `Any` Default value: `undef` ##### `interval` Data type: `Any` Default value: `undef` ##### `escapecharacter` Data type: `Any` Default value: `'_'` ##### `alwaysappendds` Data type: `Boolean` Default value: `false` ##### `protocol` Data type: `Any` Default value: `'tcp'` ##### `separateinstances` Data type: `Boolean` Default value: `false` ##### `logsenderrors` Data type: `Boolean` Default value: `true` ##### `reconnectinterval` Data type: `Integer` Default value: `0` ##### `reversehost` Data type: `Boolean` Default value: `false` ##### `preserveseparator` Data type: `Boolean` Default value: `false` ##### `dropduplicatefields` Data type: `Boolean` Default value: `false` ### `collectd::type` The collectd::type class. #### Parameters The following parameters are available in the `collectd::type` defined type: * [`target`](#-collectd--type--target) * [`ds`](#-collectd--type--ds) * [`ds_type`](#-collectd--type--ds_type) * [`min`](#-collectd--type--min) * [`max`](#-collectd--type--max) * [`ds_name`](#-collectd--type--ds_name) * [`types`](#-collectd--type--types) ##### `target` Data type: `String` ##### `ds` Data type: `String` Default value: `$name` ##### `ds_type` Data type: `Optional[Enum['ABSOLUTE', 'COUNTER', 'DERIVE', 'GAUGE']]` Default value: `undef` ##### `min` Data type: `Variant[Numeric, Enum['U']]` Default value: `'U'` ##### `max` Data type: `Variant[Numeric, Enum['U']]` Default value: `'U'` ##### `ds_name` Data type: `String` Default value: `'value'` ##### `types` Data type: ```puppet Array[Struct[{ min => Variant[Numeric, Enum['U']], max => Variant[Numeric, Enum['U']], ds_type => Enum['ABSOLUTE', 'COUNTER', 'DERIVE', 'GAUGE'], ds_name => String, }]] ``` Default value: `[]` ### `collectd::typesdb` This define initialize a collectd typesdb file #### Parameters The following parameters are available in the `collectd::typesdb` defined type: * [`path`](#-collectd--typesdb--path) * [`group`](#-collectd--typesdb--group) * [`mode`](#-collectd--typesdb--mode) * [`owner`](#-collectd--typesdb--owner) * [`include`](#-collectd--typesdb--include) ##### `path` Data type: `String` File path Default value: `$title` ##### `group` Data type: `String` File Default value: `$collectd::config_group` ##### `mode` Data type: `String` File mode Default value: `$collectd::config_mode` ##### `owner` Data type: `String` File owner Default value: `$collectd::config_owner` ##### `include` Data type: `Boolean` Include the file in the typesdb config (require collectd::purge_config at true) Default value: `false` ## Functions ### `collectd::indent` Type: Puppet Language The collectd::indent function. #### `collectd::indent(String $arg)` The collectd::indent function. Returns: `String` ##### `arg` Data type: `String` ### `collectd_convert_processes` Type: Ruby 3.x API Converts the array from the old style to define process or processmatch in the processes plugin into a create_resources compatible hash which can be used with the new style define. Example: [ { 'name' => 'foo', 'regex' => '.*' } , { 'name' => 'bar', 'regex' => '[0-9]+' }, "alone" ] will be converted to { 'foo' => { 'regex' => '.*' } , 'bar' => { 'regex' => '[0-9]+' }, 'alone' => {} } #### `collectd_convert_processes()` Converts the array from the old style to define process or processmatch in the processes plugin into a create_resources compatible hash which can be used with the new style define. Example: [ { 'name' => 'foo', 'regex' => '.*' } , { 'name' => 'bar', 'regex' => '[0-9]+' }, "alone" ] will be converted to { 'foo' => { 'regex' => '.*' } , 'bar' => { 'regex' => '[0-9]+' }, 'alone' => {} } Returns: `Any` ## Data types ### `Collectd::Amqp::Format` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_amqp Alias of `Enum['Command', 'JSON', 'Graphite']` ### `Collectd::Bind::View` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_bind Alias of ```puppet Struct[{ name => String, qtypes => Optional[Boolean], resolverstats => Optional[Boolean], cacherrsets => Optional[Boolean], zones => Optional[Array[String]], }] ``` ### `Collectd::Filter::Builtintarget` https://collectd.org/wiki/index.php/Chains#Built-in_targets Alias of `Enum['jump', 'stop', 'return', 'write']` ### `Collectd::Filter::Match` https://collectd.org/wiki/index.php/Table_of_Matches Alias of `Enum['empty_counter', 'hashed', 'regex', 'timediff', 'value']` ### `Collectd::Filter::Plugintarget` https://collectd.org/wiki/index.php/Table_of_Targets Alias of `Enum['notification', 'replace', 'scale', 'set']` ### `Collectd::Filter::Target` https://collectd.org/wiki/index.php/Chains Alias of `Variant[Collectd::Filter::Builtintarget, Collectd::Filter::Plugintarget]` ### `Collectd::LOGPARSER::Logfile` https://wiki.opnfv.org/display/fastpath/Logparser+plugin+HLD Alias of ```puppet Struct[{ 'firstfullread' => Boolean, 'message' => Array[Hash[String[1],Collectd::LOGPARSER::Message]] }] ``` ### `Collectd::LOGPARSER::Match` https://wiki.opnfv.org/display/fastpath/Logparser+plugin+HLD Alias of ```puppet Struct[{ 'regex' => String, Optional['submatchidx'] => Integer, Optional['excluderegex'] => String, Optional['ismandatory'] => Variant[Boolean, String], Optional['severity'] => String, Optional['plugininstance'] => Variant[Boolean, String], Optional['type'] => Variant[Boolean, String], Optional['typeinstance'] => Variant[Boolean, String], }] ``` ### `Collectd::LOGPARSER::Message` https://wiki.opnfv.org/display/fastpath/Logparser+plugin+HLD Alias of ```puppet Struct[{ Optional['defaultplugininstance'] => String, Optional['defaulttype'] => String, Optional['defaulttypeinstance'] => String, Optional['defaultseverity'] => String, Optional['match'] => Array[Hash[String[1],Collectd::LOGPARSER::Match]] }] ``` ### `Collectd::MCELOG::Memory` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_mcelog Alias of ```puppet Struct[{ NotUndef['mcelogclientsocket'] => String[1], NotUndef['persistentnotification'] => Boolean, }] ``` ### `Collectd::Manifests::Init` The Collectd::Manifests::Init data type. Alias of `Pattern[/(^5.4|^5.5|^5.6|^5.7|^5.8|^master)/]` ### `Collectd::Modbus::Data` https://github.com/collectd/collectd/blob/main/src/modbus.c Alias of ```puppet Struct[{ Optional['instance'] => String, NotUndef['type'] => String[1], NotUndef['register_base'] => Integer[0], NotUndef['register_type'] => Enum[ 'Int16', 'Int32', 'Int32LE', 'Uint16', 'Uint32', 'Uint32LE', 'Float', 'FloatLE', 'Uint64', 'Int64', 'Double', ], Optional['register_cmd'] => Enum['ReadHolding', 'ReadInput'], }] ``` ### `Collectd::Modbus::Host` represents a modbus host entry Alias of ```puppet Struct[{ NotUndef['address'] => String[1], NotUndef['port'] => Stdlib::Port, NotUndef['slaves'] => Hash[Integer, Collectd::Modbus::Slave], Optional['interval'] => Integer[0] }] ``` ### `Collectd::Modbus::Slave` Represents a modbus host's slave entry Alias of ```puppet Struct[{ NotUndef['instance'] => String[1], NotUndef['collect'] => Variant[ String[1], Array[String[1], 1] ] }] ``` ### `Collectd::Network::SecurityLevel` The Collectd::Network::SecurityLevel data type. Alias of `Enum['Encrypt', 'Sign', 'None']` ### `Collectd::Redis::Node` The Collectd::Redis::Node data type. Alias of `Struct[{Optional['host'] => String[1], Optional['port'] => Variant[Stdlib::Port, String[1]], Optional['password'] => String[1], Optional['timeout'] => Integer[0], Optional['queries'] => Hash[String[1], Hash[String[1], String[1]]]}]` ### `Collectd::SNMP::AuthProtocol` The Collectd::SNMP::AuthProtocol data type. Alias of `Enum['MD5', 'SHA']` ### `Collectd::SNMP::Data` The Collectd::SNMP::Data data type. Alias of `Struct[{Optional['instance'] => String, NotUndef['type'] => String[1], NotUndef['values'] => Variant[String[1], Array[String[1], 1]], Optional['instance_prefix'] => String[1], Optional['scale'] => Numeric, Optional['shift'] => Numeric, Optional['table'] => Boolean, Optional['ignore'] => Variant[String[1], Array[String[1], 1]], Optional['invert_match'] => Boolean}]` ### `Collectd::SNMP::Host` The Collectd::SNMP::Host data type. Alias of `Variant[Collectd::SNMP::Host::V2, Collectd::SNMP::Host::V3]` ### `Collectd::SNMP::Host::V2` The Collectd::SNMP::Host::V2 data type. Alias of `Struct[{NotUndef['address'] => String[1], NotUndef['version'] => Collectd::SNMP::Version::V2, NotUndef['community'] => String[1], NotUndef['collect'] => Variant[String[1], Array[String[1], 1]], Optional['interval'] => Integer[0]}]` ### `Collectd::SNMP::Host::V3` The Collectd::SNMP::Host::V3 data type. Alias of `Struct[{NotUndef['address'] => String[1], NotUndef['version'] => Collectd::SNMP::Version::V3, NotUndef['username'] => String[1], Optional['context'] => String[1], NotUndef['security_level'] => Collectd::SNMP::SecurityLevel, Optional['auth_protocol'] => Collectd::SNMP::AuthProtocol, Optional['auth_passphrase'] => String[1], Optional['privacy_protocol'] => Collectd::SNMP::PrivacyProtocol, Optional['privacy_passphrase'] => String[1], NotUndef['collect'] => Variant[String[1], Array[String[1], 1]], Optional['interval'] => Integer[0]}]` ### `Collectd::SNMP::PrivacyProtocol` The Collectd::SNMP::PrivacyProtocol data type. Alias of `Enum['AES', 'DES']` ### `Collectd::SNMP::SecurityLevel` The Collectd::SNMP::SecurityLevel data type. Alias of `Enum['authPriv', 'authNoPriv', 'noAuthNoPriv']` ### `Collectd::SNMP::Version` The Collectd::SNMP::Version data type. Alias of `Variant[Collectd::SNMP::Version::V2, Collectd::SNMP::Version::V3]` ### `Collectd::SNMP::Version::V2` The Collectd::SNMP::Version::V2 data type. Alias of `Variant[Integer[1, 2], Enum['1', '2']]` ### `Collectd::SNMP::Version::V3` The Collectd::SNMP::Version::V3 data type. Alias of `Variant[Integer[3, 3], Enum['3']]` ### `Collectd::SNMP_AGENT::Data` https://wiki.opnfv.org/display/fastpath/SNMP+Agent+HLD Alias of ```puppet Struct[{ 'plugin' => String, 'oids' => String, Optional['type'] => String, Optional['typeinstance'] => String, Optional['scale'] => String, Optional['shift'] => String, Optional['indexkey'] => Collectd::SNMP_AGENT::IndexKey, Optional['plugininstance'] => String, }] ``` ### `Collectd::SNMP_AGENT::IndexKey` https://wiki.opnfv.org/display/fastpath/SNMP+Agent+HLD Alias of ```puppet Struct['source' => String, Optional['regex'] => String, Optional['group'] => String] ``` ### `Collectd::SNMP_AGENT::Table` https://wiki.opnfv.org/display/fastpath/SNMP+Agent+HLD Alias of ```puppet Struct[{ Optional['indexoid'] => String, Optional['sizeoid'] => String, Optional['data'] => Hash[String[1], Collectd::SNMP_AGENT::Data] }] ``` ### `Collectd::Table::Result` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_table Alias of ```puppet Struct[{ 'type' => String, 'values_from' => Array[Integer, 1], 'instance_prefix' => Optional[String], 'instances_from' => Optional[Array[Integer, 1]] }] ``` ### `Collectd::Table::Table` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_table Alias of ```puppet Struct[{ 'plugin' => Optional[String], 'separator' => Optional[String], 'instance' => Optional[String], 'results' => Array[Collectd::Table::Result, 1] }] ``` ### `Collectd::Tail_Csv::File` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_tail_csv Alias of ```puppet Struct[{ 'collect' => Array[String, 1], 'plugin' => Optional[String[1]], 'instance' => Optional[String[1]], 'interval' => Optional[Numeric], 'time_from' => Optional[Integer[0]], }] ``` ### `Collectd::Tail_Csv::Metric` https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_tail_csv Alias of ```puppet Struct[{ 'type' => String[1], 'value_from' => Integer[0], 'instance' => Optional[String[1]], }] ``` ### `Collectd::Threshold::Host` The Collectd::Threshold::Host data type. Alias of ```puppet Struct[{ name => String[1], plugins => Optional[Array[Collectd::Threshold::Plugin]], types => Optional[Array[Collectd::Threshold::Type]], }] ``` ### `Collectd::Threshold::Plugin` The Collectd::Threshold::Plugin data type. Alias of ```puppet Struct[{ name => String[1], instance => Optional[String[1]], types => Optional[Array[Collectd::Threshold::Type]], }] ``` ### `Collectd::Threshold::Type` The Collectd::Threshold::Type data type. Alias of ```puppet Struct[{ name => String[1], instance => Optional[String[1]], failure_max => Optional[Numeric], warning_max => Optional[Numeric], failure_min => Optional[Numeric], warning_min => Optional[Numeric], data_source => Optional[String[1]], invert => Optional[Boolean], persist => Optional[Boolean], persist_ok => Optional[Boolean], percentage => Optional[Boolean], hits => Optional[Integer], hysteresis => Optional[Integer], interesting => Optional[Boolean], }] ``` ### `Collectd::Write_riemann::Node` The Collectd::Write_riemann::Node data type. Alias of ```puppet Struct[{ name => String[1], host => Optional[String[1]], port => Optional[Integer], protocol => Optional[Enum['TCP', 'TLS', 'UDP']], tls_cert_file => Optional[String[1]], tls_ca_file => Optional[String[1]], tls_key_file => Optional[String[1]], batch => Optional[Boolean], batch_max_size => Optional[Integer], batch_flush_timeout => Optional[Integer], store_rates => Optional[Boolean], always_append_ds => Optional[Boolean], ttl_factor => Optional[Float], notifications => Optional[Boolean], check_thresholds => Optional[Boolean], event_service_prefix => Optional[String[1]], }] ``` ## Tasks ### `getval` Get a particular metric for a host **Supports noop?** false #### Parameters ##### `metric` Data type: `String[1]` Name of metric, e.g. load/load-relative ### `listval` Lists all available collectd metrics **Supports noop?** false