Skip to content

Commit c7ea837

Browse files
committed
Update CONTRIBUTING.rst
1 parent 6b1021e commit c7ea837

File tree

1 file changed

+2
-46
lines changed

1 file changed

+2
-46
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Checklist:
4343
* A nice 16x16 transparent PNG icon, for example based on https://simpleicons.org or font-awesome (not in Git, will be put for download on https://download.linuxfabrik.ch).
4444
* README file explaining "How?" and Why?"
4545
* optional: ``unit-test/run`` - the unittest file (see `Unit Tests <#unit-tests>`_)
46-
* optional: Grafana panel (see :doc:`GRAFANA`) and Icinga Web 2 Grafana Module .ini file
46+
* optional: Grafana dashboard (see :doc:`GRAFANA`) and Icinga Web 2 Grafana Module .ini file, if you also define a Service Set (you need a consistent Service Name to rely on)
4747
* optional: Icinga Director Basket Config
4848
* optional: sudoers file (see `sudoers File <#sudoers-file>`_)
4949

@@ -454,51 +454,7 @@ If the plugin requires ``sudo``-permissions to run, please add the plugin to the
454454
Grafana Dashboards
455455
------------------
456456

457-
Each Grafana panel should be meaningful, especially when comparing it to other related panels (eg memory usage and CPU usage). When sensible, there should be an additional panel with min, max, mean and last columns. This can be achieved my setting the visualization to table and using the transform > reduce functions. This is preferred to using the legend options, because they change the width of the graph, making it harder to correlate events across panels. Unfortunately, it is currently impossible to set the unit per row, so you need to make on additional panel for each unit.
458-
459-
When modifying existing panels or creating new panels, always work with the 'all-panel' dashboard (from ``assets/grafana/``). The title of the panels should be capitalized, the metrics should be lowercase. Be sure to create a new row named after the plugin. This field will be used for the automatic splitting into smaller dashboards later on. Therefore, the name has to match the folder/plugin name (spaces will be replaced with ``-``, ``/`` will be ignored. eg ``Network I/O`` will become ``network-io``).
460-
461-
As there are two options to import the Grafana dashboards (either importing via the WebGUI or provisioning, see the README for details), the Grafana dashboard also need to be exported twice.
462-
463-
Always make sure that there is no sensitive data in the export (eg. hostnames).
464-
465-
466-
Exporting for later import via the WebGUI
467-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
468-
469-
* Make sure all rows are collapsed
470-
* Share dashboard (Icon right of the dashboard title)
471-
* Export
472-
* Export for sharing externally: yes
473-
* Save to file: all-panels-external.json
474-
475-
Afterwards generate the dashboards for each plugin using the
476-
``grafana-tool``:
477-
478-
.. code:: bash
479-
480-
./tools/grafana-tool assets/grafana/all-panels-external.json --auto --filename-postfix '.grafana-external' --generate-icingaweb2-ini
481-
482-
Make sure to adjust the generated ini file if necessary.
483-
484-
485-
Exporting for provisioning
486-
~~~~~~~~~~~~~~~~~~~~~~~~~~
487-
488-
* Make sure all rows are collapsed
489-
* Share dashboard (Icon right of the dashboard title)
490-
* Export
491-
* Export for sharing externally: no
492-
* Save to file: all-panels-provisioning.json
493-
494-
Afterwards generate the dashboards for each plugin using the
495-
``grafana-tool``:
496-
497-
.. code:: bash
498-
499-
./tools/grafana-tool assets/grafana/all-panels-provisioning.json --auto --filename-postfix '.grafana-provisioning' --generate-icingaweb2-ini
500-
501-
Make sure to adjust the generated ini file if necessary.
457+
The title of the dashboard should be capitalized, the name has to match the folder/plugin name (spaces will be replaced with ``-``, ``/`` will be ignored. eg ``Network I/O`` will become ``network-io``). Each Grafana panel should be meaningful, especially when comparing it to other related panels (eg memory usage and CPU usage).
502458

503459

504460
Icinga Director Basket Config

0 commit comments

Comments
 (0)