Skip to content

Commit

Permalink
Docs: s/Graphite Module/Icinga Web Graphite Integration/
Browse files Browse the repository at this point in the history
  • Loading branch information
Al2Klimov committed Sep 22, 2022
1 parent 822fd54 commit af1fad2
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 23 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion doc/01-About.md
Original file line number Diff line number Diff line change
@@ -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/)
Expand Down
2 changes: 1 addition & 1 deletion doc/02-Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions doc/04-Templates.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Templates <a id="templates"></a>

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)
Expand All @@ -15,8 +15,8 @@ how to render which graphs.

## Template Location <a id="templates-location"></a>

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
Expand All @@ -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 <a id="templates-structure"></a>

Expand Down Expand Up @@ -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]
Expand Down
11 changes: 6 additions & 5 deletions doc/05-Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
17 changes: 9 additions & 8 deletions doc/06-Demonstration.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
# <a id="Demonstration"></a>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.

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
Expand All @@ -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
```

0 comments on commit af1fad2

Please sign in to comment.