Overview: 

When a pull request against collectd is created for your feature:
• Update the Barometer stats and events wiki with the new metrics and events.
• Update the Barometer User Guide with the details of your feature.
• Update the Barometer src/ directory to install any dependencies, configure and build collectd with your new features. Make sure to include sample configuration files in collectd_sample_configs/
• Test on the supported systems
• Ensure any relevant RPMs are built by the CI
• Create appropriate Functests
• When your change is merged to collectd, just make sure to update the repos
listed in the User Guide for the plugin.
Submit Reviews for each of these changes to Barometer and Add Maryam
Tahhan as a Reviewer.

Directory Structure

Open

• 3rd Party:

  • Contains python based plugins that cannot be upstreamed to collectd: collectd VES plugin and Ovs PMD stats plugin

• baro_tests and baro_utils

  • Contain functest code for the developed collectd plugins

• ci 

  • Contains the scripts used to build collectd and it's dependencies as RPMs for Apex

    • Run nightly

    • upload RPMs to http://artifacts.opnfv.org/barometer.html

• docs

  • Contains the ReStructured text files that form that basis of what gets built as the barometer project documentation

  • An explanation of the structure of this directory can found here: http://opnfvdocsdemo.readthedocs.io/en/latest/how-to-use-docs/documentation-guide.html#document-structure-and-contribution

• mibs

  • Contains any custom defined MIBs

• src

  • This is the directory which contains makefiles that allow you to:

    1.  clone, build and install all the dependencies for any plugins that were upstreamed to collectd.

    2. clone, build and install collectd as a service on the platform.

       1. Reasonable default configurations for upstreamed plugins are provided under the collectd_sample_configs directory

• systems

  • The directory contains the script "build_base_machine.sh" which is intended to be used as a one stop shop installation script for collectd and all the newly developed plugins by barometer.

Update the Barometer stats and events wiki with the new metrics and events

Navigate to: Collectd Metrics and Events and edit the page to include your new stats/events in the appropriate table.

Update the Barometer User Guide with the details of your feature

1. Clone the barometer repo

2. Modify the userguide 

3. Test the documentation updates locally before pushing to OPNFV: http://opnfvdocsdemo.readthedocs.io/en/latest/how-to-use-docs/include-documentation.html#testing-build-documentation-locally

4. Create a gerrit review in OPNFV. 

5. Add @Former user (Deleted) as a reviewer.

Update the Barometer src/ directory to install any dependencies, configure

1. Clone the barometer repo

2. Modify the Makefiles in the src directory to clone, build and install all the dependencies for the new plugin

3. Modify the collectd build Makefiles to configure the new dependency

4. Add a reasonable default configuration.

5. Test on the supported systems

6. Create a gerrit review in OPNFV. 

7. Add @Former user (Deleted) as a reviewer.

Ensure any relevant RPMs are built by the CI

1. Clone the barometer repo

2. Modify the bash scripts in the ci directory to build your new plugin and any dependencies as RPMs

3. Test on CentOS

4. Create a gerrit review in OPNFV. 

5. Add @Former user (Deleted) as a reviewer.