Chapter 4. collectd plugins

host

String

plugin

String

plugininstance

Integer

agg_type

String

typeinstance

String

sethost

String

setplugin

String

setplugininstance

Integer

settypeinstance

String

groupby

Array of Strings

calculatesum

Boolean

calculatenum

Boolean

calculateaverage

Boolean

calculateminimum

Boolean

calculatemaximum

Boolean

calculatestddev

Boolean

manage_package

Boolean

transport

String

host

String

port

Integer

user

String

password

String

address

String

instances

Hash

retry_delay

Integer

send_queue_limit

Integer

interval

Integer

instances

Hash

interval

Integer

manage-package

Boolean

package_install_options

List

url

HTTP URL

user

String

password

String

verifypeer

Boolean

verifyhost

Boolean

cacert

AbsolutePath

sslciphers

String

timeout

Integer

values_percentage

Boolean

report_degraded

Boolean

query_state_fs

Boolean

interval

Integer

url

HTTP URL

memorystats

Boolean

opcodes

Boolean

parsetime

Boolean

qtypes

Boolean

resolverstats

Boolean

serverstats

Boolean

zonemaintstats

Boolean

views

Array

interval

Integer

name

String

qtypes

Boolean

resolverstats

Boolean

cacherrsets

Boolean

zones

List of strings

daemons

Array

longrunavglatency

Boolean

convertspecialmetrictypes

Boolean

package_name

String

ignore_selected

Boolean

interval

Integer

cgroups

List

interfaces

Array

idle

Amount of idle time

collectd_cpu_total{...,type_instance='idle'}

interrupt

CPU blocked by interrupts

collectd_cpu_total{...,type_instance='interrupt'}

nice

Amount of time running low priority processes

collectd_cpu_total{...,type_instance='nice'}

softirq

Amount of cycles spent in servicing interrupt requests

collectd_cpu_total{...,type_instance='waitirq'}

steal

The percentage of time a virtual CPU waits for a real CPU while the hypervisor is servicing another virtual processor

collectd_cpu_total{...,type_instance='steal'}

system

Amount of time spent on system level (kernel)

collectd_cpu_total{...,type_instance='system'}

user

Jiffies that user processes use

collectd_cpu_total{...,type_instance='user'}

wait

CPU waiting on outstanding I/O request

collectd_cpu_total{...,type_instance='wait'}

reportbystate

Boolean

true

valuespercentage

Boolean

true

reportbycpu

Boolean

true

reportnumcpu

Boolean

false

reportgueststate

Boolean

false

subtractgueststate

Boolean

true

interval

Integer

120

datadir

String

storerates

Boolean

interval

Integer

free

Amount of free disk space

collectd_df_df_complex{...,type_instance="free"}

reserved

Amount of reserved disk space

collectd_df_df_complex{...,type_instance="reserved"}

used

Amount of used disk space

collectd_df_df_complex{...,type_instance="used"}

devices

Array

[]

fstypes

Array

['xfs']

ignoreselected

Boolean

true

mountpoints

Array

[]

reportbydevice

Boolean

true

reportinodes

Boolean

true

reportreserved

Boolean

true

valuesabsolute

Boolean

true

valuespercentage

Boolean

false

disks

Array

[]

ignoreselected

Boolean

false

udevnameattr

String

<undefined>

merged

The number of queued operations that can be merged together, for example, one physical disk access served two or more logical operations.

time

The average time an I/O-operation takes to complete. The values might not be accurate.

io_time

Time spent doing I/Os (ms). You can use this metric as a device load percentage. A value of 1 second matches 100% of load.

weighted_io_time

Measure of both I/O completion time and the backlog that might be accumulating.

pending_operations

Shows queue size of pending I/O operations.

report_per_node_hp

Boolean

true

report_root_hp

Boolean

true

values_pages

Boolean

true

values_bytes

Boolean

false

values_percentage

Boolean

false

interfaces

Array

[]

ignoreselected

Boolean

false

reportinactive

Boolean

true

report_relative

Boolean

true

Mcelogfile

String

Memory

Hash { mcelogclientsocket[string], persistentnotification[boolean] }

instances

Hash

interval

Integer

Defaults

valuesabsolute

Boolean

true

valuespercentage

Boolean

host

Hostname

port

Port number (Integer)

reverselookups

Boolean

includeunitid

Boolean

interval

Integer

address

String

bridges

List

port

Integer

socket

String

processes

Array

<undefined>

process_matches

Array

<undefined>

collect_context_switch

Boolean

<undefined>

collect_file_descriptor

Boolean

<undefined>

collect_memory_maps

Boolean

<undefined>

disks

Array

ignoreselected

Boolean

interval

Integer

reportbydevice

Boolean

reportbytes

Boolean

valuesabsolute

Boolean

valuespercentage

Boolean

reportio

Boolean

localports

Port (Array)

remoteports

Port (Array)

listening

Boolean

allportssummary

Boolean

devices

Array

ignoreselected

Boolean

interval

Integer

interval

Integer

connection

String

refresh_interval

Hash

domain

String

block_device

String

interface_device

String

ignore_selected

Boolean

plugin_instance_format

String

hostname_format

String

interface_format

String

extra_stats

String

verbose

Boolean

interval

Integer

ensure

Enum[present, absent]

nodes

Hash[String, Hash[String, Scalar]]

urls

Hash[String, Hash[String, Scalar]]

manage_package

Boolean

kafka_hosts

Array[String]

topics

Hash

properties

Hash

meta

Hash

cURL

You can use this plugin to read files with libcurl and then parse the files according to the configuration.

cURL-JSON

You can use this plugin to query JSON data using the cURL library and parse the data according to the configuration.

DNS

You can use this plugin to interpret the packets and collect statistics of your DNS traffic on UDP port 53.

Entropy

You can use this plugin to report the available entropy on a system.

Ethstat

You can use this plugin to read performance statistics from the Ethernet cards.

Exec

You can use this plugin to execute scripts or applications and print to STDOUT.

fhcount

You can use this plugin to provide statistics about used, unused, and total number of file handles on Linux.

FileCount

You can use this plugin to count the number of files in a directory and its subdirectories.

FSCache

You can use this plugin to collect information about the file-system-based caching infrastructure for network file systems and other slow media.

HDDTemp

You can use this plugin to collect the temperature of hard disks.

IntelRDT

You can use this plugin to collect information provided by monitoring features of Intel Resource Director Technology.

IPMI

You can use this plugin to read hardware sensors from servers using the Intelligent Platform Management Interface (IPMI).

IRQ

You can use this plugin to collect the number of times each interrupt is handled by the operating system.

LogFile

You can use this plugin to write to a log file.

MySQL

You can use this plugin to connect to a MySQL database and issue a SHOW STATS command periodically. The command returns the server status variables, many of which are collected.

Netlink

You can use this plugin to get statistics for interfaces, qdiscs, classes, or filters.

Network

You can use this plugin to interact with other collectd instances.

NFS

You can use this plugin to get information about the usage of the Network File System (NFS), version 2, 3, and 4.

numa

You can use this plugin to report statistics of the Non-Uniform Memory Access (NUMA) subsystem of Linux.

OpenLDAP

You can use this plugin to report the status of OpenLDAP.

OpenVPN

You can use this plugin to read the status file printed by OpenVPN.

OVS Events

You can use this plugin to monitor the link status of OpenvSwitch-connected interfaces and send notifications when the link state change occurs.

PCIe Errors

You can use this plugin to monitor and report PCI Express errors.

Ping

You can use this plugin to measure network latency using Internet Control Message Protocol (ICMP) echo requests.

procevent

You can use this plugin to monitor process starts and exits.

Python

You can use this plugin to bind to python.

Sensors

You can use this plugin to read hardware sensors using lm-sensors.

Serial

You can use this plugin to collect traffic on the serial interface.

SNMP

You can use this plugin to read values from network devices using the Simple Network Management Protocol (SNMP).

SNMP Agent

You can use this plugin to handle queries from the principal SNMP agent and return the data collected by read plugins.

StatsD

You can use this plugin to implement the StatsD network protocol to allow clients to report events.

sysevent

You can use this plugin to listen for incoming rsyslog messages on a network socket.

SysLog

You can use this plugin to receive log messages from the collectd daemon and dispatch the messages to syslog.

Table

You can use this plugin to parse plain text files in table format.

Tail

You can use this plugin to tail log files, in a similar way as the tail -F command. Each line is given to one or more matches that test if the line is relevant for any statistics using a posix extended regular expression.

Tail CSV

You can use this plugin to tail CSV files.

threshold

You can use this plugin to generate notifications on given thresholds.

turbostat

You can use this plugin to read CPU frequency and C-state residency on modern Intel turbo-capable processors.

UnixSock

You can use this plugin to communicate with the collectd daemon.

Users

You can use this plugin to count the number of users currently logged into the system.

UUID

You can use this plugin to determine the uniquie identifier (UUID) of the system that it is running on.

Write Graphite

You can use this plugin to store values in Carbon, which is the storage layer of Graphite.

Write HTTP

You can use this plugin to send the values collected by collectd to a web server using HTTP POST requests.

Write Log

You can use this plugin to write metrics as INFO log messages.

Write Prometheus

You can use this plugin to implement a web server that can be scraped by Prometheus.