diff --git a/README.md b/README.md index 0a79c5ee..e3512117 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Icinga Module for Graphite +# Icinga Web Graphite Integration [![PHP Support](https://img.shields.io/badge/php-%3E%3D%207.2-777BB4?logo=PHP)](https://php.net/) ![Build Status](https://github.com/icinga/icingaweb2-module-graphite/workflows/PHP%20Tests/badge.svg?branch=master) diff --git a/doc/01-About.md b/doc/01-About.md index 23f44bb3..01e012f4 100644 --- a/doc/01-About.md +++ b/doc/01-About.md @@ -1,4 +1,4 @@ -# Icinga Module for Graphite +# Icinga Web Graphite Integration This module integrates an existing [Graphite](https://graphite.readthedocs.io/en/latest/) installation in your [Icinga Web](https://icinga.com/products/infrastructure-monitoring/) diff --git a/doc/02-Installation.md b/doc/02-Installation.md index 53ed2881..75d7f405 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -34,7 +34,7 @@ However, some templates look better if they are able to render a max value or similar. -## Install the Graphite Module +## Install the Icinga Web Graphite Integration Install it [like any other module](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation). Use `graphite` as name. diff --git a/doc/04-Templates.md b/doc/04-Templates.md index bccd45b7..5acbae11 100644 --- a/doc/04-Templates.md +++ b/doc/04-Templates.md @@ -1,8 +1,8 @@ # Templates A template defines what kind of data a graph visualizes, which kind of graph to -use and its style. Essentially this module is using templates to tell Graphite -how to render which graphs. +use and its style. Essentially the Icinga Web Graphite Integration is using +templates to tell Graphite how to render which graphs. * [Location](04-Templates.md#templates-location) * [Structure](04-Templates.md#templates-structure) @@ -15,8 +15,8 @@ how to render which graphs. ## Template Location -There are a bunch of templates already shipped with this module, located in -its installation path. (e.g. `/usr/share/icingaweb2/modules/graphite`) +There are a bunch of templates already included, located in +the installation path. (e.g. `/usr/share/icingaweb2/modules/graphite`) To add additional/customized templates, place them in its configuration path. (e.g. `/etc/icingaweb2/modules/graphite/templates`) These will either extend @@ -26,7 +26,7 @@ templates of its parent folders. > **Note:** > -> Hidden files and directories (with a leading dot) are ignored by this module. +> Hidden files and directories (with a leading dot) are ignored. ## Template Structure @@ -115,8 +115,8 @@ here as well: title = "Disk usage on $disk$" -You may also define URL parameters once for all templates (including the ones -shipped with this module) in the `default_url_params` section in +You may also define URL parameters once for all templates +(including the shipped ones) in the `default_url_params` section in `/etc/icingaweb2/modules/graphite/config.ini`: [default_url_params] diff --git a/doc/05-Troubleshooting.md b/doc/05-Troubleshooting.md index df03d0d5..11ef7113 100644 --- a/doc/05-Troubleshooting.md +++ b/doc/05-Troubleshooting.md @@ -36,11 +36,12 @@ Example debug log for the host "icinga.com": ++ Not applying template 'default-service' ``` -The log describes how the Graphite module assembled the displayed graphs (or why -no graphs could be assembled). The plus signs indent the performed actions to -visualize their hierarchy, e.g. all actions below `Applying templates for check -command 'hostalive'` indented with more than one plus sign (until `Applying -default templates, (...)`) are sub-actions of the above one. +The log describes how the Icinga Web Graphite Integration assembled the +displayed graphs (or why no graphs could be assembled). The plus signs indent +the performed actions to visualize their hierarchy, e.g. all actions below +`Applying templates for check command 'hostalive'` indented with more than one +plus sign (until `Applying default templates, (...)`) are sub-actions of the +above one. #### Details diff --git a/doc/06-Demonstration.md b/doc/06-Demonstration.md index 344012d5..86638729 100644 --- a/doc/06-Demonstration.md +++ b/doc/06-Demonstration.md @@ -1,22 +1,23 @@ # Demonstration -This repository ships a [Dockerfile](../Dockerfile.demo) for demonstrating -and/or developing this module (but not for using it in production). +This repository ships a [Dockerfile](../Dockerfile.demo) for demonstration +and/or development (but not for usage in production). Build: ```bash -docker build -t icingaweb2-module-graphite-demo -f Dockerfile.demo . +docker build -t icingaweb2-graphite-demo -f Dockerfile.demo . ``` Run: ```bash -docker run -itp 8080:80 icingaweb2-module-graphite-demo +docker run -itp 8080:80 icingaweb2-graphite-demo ``` -The container serves an Icinga Web with this module and all dependencies -at http://localhost:8080/icingaweb2 and Graphite Web at http://localhost:8080. +The container serves an Icinga Web with the Graphite Integration and all +dependencies at http://localhost:8080/icingaweb2 and Graphite Web at +http://localhost:8080. Icinga monitors dummy services yielding random perfdata as expected by the shipped graph templates. @@ -24,7 +25,7 @@ as expected by the shipped graph templates. Use the container for development without re-building: ```bash -docker run -itp 8080:80 -v "$(pwd):/usr/share/icingaweb2/modules/graphite" icingaweb2-module-graphite-demo +docker run -itp 8080:80 -v "$(pwd):/usr/share/icingaweb2/modules/graphite" icingaweb2-graphite-demo ``` Code changes are visible immediately, but graph template changes @@ -33,5 +34,5 @@ require a container restart. Preserve graphs: ```bash -docker run -itp 8080:80 -v "$(pwd)/.whisper:/opt/graphite/storage/whisper" icingaweb2-module-graphite-demo +docker run -itp 8080:80 -v "$(pwd)/.whisper:/opt/graphite/storage/whisper" icingaweb2-graphite-demo ```