from collectd and translates requested values from collectd's internal format
to SNMP format. Supports SNMP: get, getnext and walk requests.
-All the plugins above are available on the collectd master, except for the
-Gnocchi and Aodh plugins as they are Python-based plugins and only C plugins
-are accepted by the collectd community. The Gnocchi and Aodh plugins live in
-the OpenStack repositories.
+All the plugins above are available on the collectd main branch, except for
+the Gnocchi and Aodh plugins as they are Python-based plugins and only C
+plugins are accepted by the collectd community. The Gnocchi and Aodh plugins
+live in the OpenStack repositories.
-Other plugins existing as a pull request into collectd master:
+.. TODO: Update this to reflect merging of these PRs
+Other plugins existing as a pull request into collectd main:
* *Legacy/IPMI*: A read plugin that reports platform thermals, voltages,
fanspeed, current, flow, power etc. Also, the plugin monitors Intelligent
Building all Barometer upstreamed plugins from scratch
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The plugins that have been merged to the collectd master branch can all be
+The plugins that have been merged to the collectd main branch can all be
built and configured through the barometer repository.
.. note::
^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
-Branch: master
+Branch: main
Dependencies: DPDK (http://dpdk.org/)
.. note:: DPDK statistics plugin requires DPDK version 16.04 or later.
To build and install DPDK to /usr please see:
-https://github.com/collectd/collectd/blob/master/docs/BUILD.dpdkstat.md
+https://github.com/collectd/collectd/blob/main/docs/BUILD.dpdkstat.md
Building and installing collectd:
hexadecimal bitmask of the cores to run on).
For more information on the plugin parameters, please see:
-https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
.. note:: dpdkstat plugin initialization time depends on read interval. It
requires 5 read cycles to set up internal buffers and states, during that time
^^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
-Branch: master
+Branch: main
Dependencies: None, but assumes hugepages are configured.
</Plugin>
For more information on the plugin parameters, please see:
-https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
Intel PMU Plugin
^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
-Branch: master
+Branch: main
Dependencies:
.. code:: bash
- $ wget https://raw.githubusercontent.com/andikleen/pmu-tools/master/event_download.py
+ $ wget https://raw.githubusercontent.com/andikleen/pmu-tools/main/event_download.py
$ python event_download.py
This will download the json files to the location: $HOME/.cache/pmu-events/. If you don't want to
Cores "[0-7]"
For more information on the plugin parameters, please see:
-https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
.. note::
^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
-Branch: master
+Branch: main
Dependencies:
</Plugin>
For more information on the plugin parameters, please see:
-https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
IPMI Plugin
^^^^^^^^^^^^
dispatch the values to collectd and send SEL notifications.
For more information on the IPMI plugin parameters and SEL feature configuration,
-please see: https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+please see: https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
Extended analog sensors support doesn't require additional configuration. The usual
collectd IPMI documentation can be used:
^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
-Branch: master
+Branch: main
Dependencies: mcelog
</Plugin>
For more information on the plugin parameters, please see:
-https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
Simulating a Machine Check Exception can be done in one of 3 ways:
^^^^^^^^^^^^^^^^^^^^^
OvS Plugins Repo: https://github.com/collectd/collectd
-OvS Plugins Branch: master
+OvS Plugins Branch: main
OvS Events MIBs: The SNMP OVS interface link status is provided by standard
IF-MIB (http://www.net-snmp.org/docs/mibs/IF-MIB.txt)
$ git clone $REPO
$ cd collectd
- $ git checkout master
+ $ git checkout main
$ ./build.sh
$ ./configure --enable-syslog --enable-logfile --enable-debug
$ make
</Plugin>
For more information on the plugin parameters, please see:
-https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
OVS PMD stats
^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
-Branch: master
+Branch: main
Dependencies: NET-SNMP library
retreived using standard IF-MIB tables.
For more information on the plugin parameters, please see:
-https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
For more details on AgentX subagent, please see:
http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/
^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
-Branch: master
+Branch: main
Dependencies: libvirt (https://libvirt.org/), libxml2
</Plugin>
For more information on the plugin parameters, please see:
-https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
+https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
.. _install-collectd-as-a-service:
References
^^^^^^^^^^^
.. [1] https://collectd.org/wiki/index.php/Naming_schema
-.. [2] https://github.com/collectd/collectd/blob/master/src/daemon/plugin.h
+.. [2] https://github.com/collectd/collectd/blob/main/src/daemon/plugin.h
.. [3] https://collectd.org/wiki/index.php/Value_list_t
.. [4] https://collectd.org/wiki/index.php/Data_set
.. [5] https://collectd.org/documentation/manpages/types.db.5.shtml
# there are 3 collectd flavors:
# -"stable" - based on stable collectd release
-# -"master" - development version, based on master branch
-# -"experimental" - it is based on master branch as above and includes
+# -"master" - development version, based on main branch
+# -"experimental" - it is based on main branch as above and includes
# set pull requests with experimental features
ifeq ($(COLLECTD_FLAVOR), stable)
# using latest stable release
SAMPLE_CONF_VARIANT_NAME = collectd_sample_configs
else
# 'master' and 'experimental' collectd flavors are both using
-# code from master branch
- COLLECTD_TAG ?= master
+# code from main branch
+ COLLECTD_TAG ?= main
SAMPLE_CONF_VARIANT_NAME = collectd_sample_configs-master
ifeq ($(COLLECTD_FLAVOR), experimental)
# 'experimental' flavor is using additional Pull Requests that
-# are put on top of master release
+# are put on top of main release
COLLECTD_USE_EXPERIMENTAL_PR ?= y
endif #end of experimental-branch handling
endif