File README.SUSE of Package icingaweb2-module-graphite

Preliminary note for openSUSE
=============================

Above discription is from icingaweb2-module-graphite site.

In Suse you only must do:
   1. Insert "Listen 8000" in /etc/apache2/listen.conf
   2. systemctl restart apache2
   3. icinga2 feature enable graphite
   4. systemctl restart icinga2
   5. systemctl enable carbon-cache
   6. systemctl start carbon-cache
   7. Enable module graphite in icingaweb2
   8. Configure graphite module backend. Minimum Graphite Web URL with http://127.0.0.1:8000



Prepare Icinga2
===============

Enable the graphite feature:

icinga2 feature enable graphite

Adjust it's configuration in /etc/icinga2/features-enabled/graphite.conf:

library "perfdata"

object GraphiteWriter "graphite" {
  host = "127.0.0.1"
  port = 2003
  enable_send_thresholds = true
  enable_send_metadata = true
}

And then restart Icinga2. Enabling thresholds is not a hard requirement. 
However, some templates look better when they are able to render a max values or similar.


Installation
============

Just extract/clone this module to a graphite subfolder in your Icinga Web 2 module path. 
Enable the graphite module in your Icinga Web 2 frontend 
(Configuration -> Modules -> graphite -> enable) 
and it should work out of the box.

NB: It is best practice to install 3rd party modules into a distinct module folder 
for example /usr/share/icingaweb2/modules. In case you don't know where this might be 
please check the module path in your Icinga Web 2 configuration.


Configuration
=============

Copy the sample configuration to /etc/icingaweb2/modules like so:

    mkdir -p /etc/icingaweb2/modules/graphite
    cp -rv sample-config/icinga2/* /etc/icingaweb2/modules/graphite

Change permissions:

    chown -R root:icingaweb2 /etc/icingaweb2/modules/graphite
    chmod -R 2755 /etc/icingaweb2/modules/graphite

Edit /etc/icingaweb2/modules/graphite/config.ini and set web\_url to the Graphite web host.

    [graphite]
    web_url = http://my.graphite.web

You don't need any configuration in your Icinga 2 installation (e.g. additional custom vars).


Testdrive
=========

Icinga 2 and Graphite feature enabled:

    icinga2 feature enable graphite

Graphite and Graphite Web running, e.g. as docker instance:

    sudo docker run -d --name graphite --restart=always -p 9090:80 -p 2003:2003 hopsoft/graphite-statsd

Icinga Web 2 with Graphite module enabled

    [graphite]
    web_url = http://localhost:9090