The branch names have been updated, and main has replaced
master, which will no longer be updated.
Change-Id: Idfce21554594f15a831c8b7ec769eb85d52068b1
Signed-off-by: Emma Foley <efoley@redhat.com>
There are currently two variants of collectd container:
- barometer-collectd - it is based on stable collect release
- barometer-collectd-master - development container that is based on
There are currently two variants of collectd container:
- barometer-collectd - it is based on stable collect release
- barometer-collectd-master - development container that is based on
- latest 'master' branch for collectd project. It contains all available
- collectd plugins and features that are available on 'master' branch but
+ latest 'main' branch for collectd project. It contains all available
+ collectd plugins and features that are available on 'main' branch but
some issues with configuration or stability may occur
------------------------------------------------------------------------------
some issues with configuration or stability may occur
------------------------------------------------------------------------------
------------------------------------------------------------------------------
4. INSTALLATION NOTES: barometer-collectd-master (development container)
------------------------------------------------------------------------------
4. INSTALLATION NOTES: barometer-collectd-master (development container)
-To build docker barometer-collectd-master container run (it is based on master branch from collectd):
+To build docker barometer-collectd-master container run (it is based on main branch from collectd):
sudo docker build -f ./docker/barometer-collectd-master/Dockerfile .
from root barometer folder.
sudo docker build -f ./docker/barometer-collectd-master/Dockerfile .
from root barometer folder.
COPY docker/barometer-collectd-experimental/collectd_apply_pull_request.sh \
${repos_dir}/barometer/src/collectd/
COPY docker/barometer-collectd-experimental/collectd_apply_pull_request.sh \
${repos_dir}/barometer/src/collectd/
-# copying additional experimental configs on top of configs for 'master'
+# copying additional experimental configs on top of configs for 'main'
# branch release
COPY docker/barometer-collectd-experimental/experimental-configs/* \
${repos_dir}/barometer/src/collectd/collectd_sample_configs-master/
# branch release
COPY docker/barometer-collectd-experimental/experimental-configs/* \
${repos_dir}/barometer/src/collectd/collectd_sample_configs-master/
#
# This files contains list of pull requests to be applied on top
#
# This files contains list of pull requests to be applied on top
-# of master branch before building collectd included in docker
+# of main branch before building collectd included in docker
# collectd-experimental container
# Space/newline separated list of pull requests IDs
# collectd-experimental container
# Space/newline separated list of pull requests IDs
.. _`VES`: https://wiki.opnfv.org/display/fastpath/VES+plugin+updates
.. _`VES shema definition`: https://gerrit.onap.org/r/gitweb?p=demo.git;a=tree;f=vnfs/VES5.0/evel/evel-test-collector/docs/att_interface_definition;hb=refs/heads/master
.. _`PyYAML documentation`: https://pyyaml.org/wiki/PyYAMLDocumentation
.. _`VES`: https://wiki.opnfv.org/display/fastpath/VES+plugin+updates
.. _`VES shema definition`: https://gerrit.onap.org/r/gitweb?p=demo.git;a=tree;f=vnfs/VES5.0/evel/evel-test-collector/docs/att_interface_definition;hb=refs/heads/master
.. _`PyYAML documentation`: https://pyyaml.org/wiki/PyYAMLDocumentation
-.. _`collectd plugin description`: https://github.com/collectd/collectd/blob/master/src/collectd.conf.pod
-.. _`collectd data types file`: https://github.com/collectd/collectd/blob/master/src/types.db
-.. _`collectd data types description`: https://github.com/collectd/collectd/blob/master/src/types.db.pod
+.. _`collectd plugin description`: https://github.com/collectd/collectd/blob/main/src/collectd.conf.pod
+.. _`collectd data types file`: https://github.com/collectd/collectd/blob/main/src/types.db
+.. _`collectd data types description`: https://github.com/collectd/collectd/blob/main/src/types.db.pod
.. _`python regular expression syntax`: https://docs.python.org/2/library/re.html#regular-expression-syntax
.. _`Kafka collectd plugin`: https://collectd.org/wiki/index.php/Plugin:Write_Kafka
.. _`python regular expression syntax`: https://docs.python.org/2/library/re.html#regular-expression-syntax
.. _`Kafka collectd plugin`: https://collectd.org/wiki/index.php/Plugin:Write_Kafka
from collectd and translates requested values from collectd's internal format
to SNMP format. Supports SNMP: get, getnext and walk requests.
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
* *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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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::
built and configured through the barometer repository.
.. note::
^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
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:
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:
Building and installing collectd:
hexadecimal bitmask of the cores to run on).
For more information on the plugin parameters, please see:
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
.. 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
^^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
Dependencies: None, but assumes hugepages are configured.
Dependencies: None, but assumes hugepages are configured.
</Plugin>
For more information on the plugin parameters, please see:
</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
Intel PMU Plugin
^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
- $ 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
$ 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:
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
^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
</Plugin>
For more information on the plugin parameters, please see:
</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
dispatch the values to collectd and send SEL notifications.
For more information on the IPMI plugin parameters and SEL feature configuration,
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:
Extended analog sensors support doesn't require additional configuration. The usual
collectd IPMI documentation can be used:
^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
</Plugin>
For more information on the plugin parameters, please see:
</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:
Simulating a Machine Check Exception can be done in one of 3 ways:
^^^^^^^^^^^^^^^^^^^^^
OvS Plugins Repo: https://github.com/collectd/collectd
^^^^^^^^^^^^^^^^^^^^^
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)
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 clone $REPO
$ cd collectd
$ ./build.sh
$ ./configure --enable-syslog --enable-logfile --enable-debug
$ make
$ ./build.sh
$ ./configure --enable-syslog --enable-logfile --enable-debug
$ make
</Plugin>
For more information on the plugin parameters, please see:
</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
^^^^^^^^^^^^^^
OVS PMD stats
^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
^^^^^^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
Dependencies: NET-SNMP library
Dependencies: NET-SNMP library
retreived using standard IF-MIB tables.
For more information on the plugin parameters, please see:
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/
For more details on AgentX subagent, please see:
http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/
^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
^^^^^^^^^^^^
Repo: https://github.com/collectd/collectd
Dependencies: libvirt (https://libvirt.org/), libxml2
Dependencies: libvirt (https://libvirt.org/), libxml2
</Plugin>
For more information on the plugin parameters, please see:
</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:
.. _install-collectd-as-a-service:
References
^^^^^^^^^^^
.. [1] https://collectd.org/wiki/index.php/Naming_schema
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
.. [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
Before starting to build and run the Collectd container, understand the available
flavors of Collectd containers:
* barometer-collectd - stable release, based on collectd 5.11
Before starting to build and run the Collectd container, understand the available
flavors of Collectd containers:
* barometer-collectd - stable release, based on collectd 5.11
- * barometer-collectd-master - release based on collectd 'master' branch
- * barometer-collectd-experimental - release based on collectd 'master'
+ * barometer-collectd-master - release based on collectd 'main' branch
+ * barometer-collectd-experimental - release based on collectd 'main'
branch that also includes set of experimental (not yet merged into upstream)
pull requests
branch that also includes set of experimental (not yet merged into upstream)
pull requests
# there are 3 collectd flavors:
# -"stable" - based on stable collectd release
# 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
# 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
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
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
COLLECTD_USE_EXPERIMENTAL_PR ?= y
endif #end of experimental-branch handling
endif