Skip to content

Mention the grafana-image-renderer in the documentation #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Mention the grafana-image-renderer in the documentation #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,13 @@ Join the [Icinga community channels](https://icinga.com/community/) for question
* [Icinga Web 2](https://github.com/Icinga/icingaweb2) (>= 2.11)
* [Icinga DB Web](https://github.com/Icinga/icingadb-web) (>= 1.02)
* [Grafana](https://grafana.com/) (>= 7.0)
* A data source as a backend for Grafana. Either:
* [InfluxDB](https://docs.influxdata.com/influxdb/) (>= 1.0)
* [Graphite](https://graphiteapp.org)
* [PHP 8.1](https://www.php.net) **with curl and gd enabled**
* [Grafana Image Renderer](https://grafana.com/grafana/plugins/grafana-image-renderer/) (when using proxy access)
* [PHP 8.1](https://www.php.net) (with curl and gd enabled)

A data source as a backend for Grafana. Either:

* [InfluxDB](https://docs.influxdata.com/influxdb/) (>= 1.0)
* [Graphite](https://graphiteapp.org)

## Documentation

Expand Down
2 changes: 2 additions & 0 deletions doc/01-about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ Add Grafana graphs into Icinga Web 2 to display performance metrics.
![Icinga Web 2 Grafana Integration](images/icingaweb2_grafana_screenshot_02.png "Grafana")

## Graphs for dashboards

![Icinga Web 2 Grafana Integration](images/icingaweb2_grafana_screenshot_06.png)

To add a graph to your dashboard click on the small clock left of the timerange menu of a graph.

## Show all graphs

To see all graphs on one page, click on the `Show all graphs` link in a host object view.
![Show all graph](images/showallgraph.png "Show all graph")

Expand Down
10 changes: 8 additions & 2 deletions doc/02-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@ to the latest version, please [read on here](05-update.md).
* [Icinga Web 2](https://github.com/Icinga/icingaweb2) (>= 2.11)
* [Icinga DB Web](https://github.com/Icinga/icingadb-web) (>= 1.02)
* [Grafana](https://grafana.com/) (>= 7.0)
* [InfluxDB](https://docs.influxdata.com/influxdb/) (>= 1.0) [Graphite](https://graphiteapp.org) as backend for Grafana
* [PHP 8.1](https://www.php.net) **with curl and gd enabled**
* [Grafana Image Renderer](https://grafana.com/grafana/plugins/grafana-image-renderer/) (when using proxy access)
* [PHP 8.1](https://www.php.net) (with curl and gd enabled)

The Grafana Image Renderer handles rendering panels and dashboards to PNGs using a headless browser (Chromium).

A data source as a backend for Grafana. Either:

* [InfluxDB](https://docs.influxdata.com/influxdb/) (>= 1.0)
* [Graphite](https://graphiteapp.org)

## Install the Grafana module

Expand Down
3 changes: 1 addition & 2 deletions doc/03-module-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Module configuration
Here you will learn how to configure the module and details about the options you can choose.

---

## Global configuration

The configuration can be done via web interface or by editing the configuration ini-file directly.

### Configuration with web interface
Expand Down
15 changes: 5 additions & 10 deletions doc/04-graph-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ You can add specific [graph configuration](/icingaweb2/grafana/graph) settings i

![Graph Configuration Menu](images/04-graph.configuration-01.png)

---
## Options

|Setting | Description|
|-------------------|-------------------|
|name | **Required.** The name of the `service` (not the `display_name`) or `parametrized service name` or `check_command` where a graph should be rendered.|
Expand All @@ -21,6 +21,7 @@ You can add specific [graph configuration](/icingaweb2/grafana/graph) settings i
|nmetrics | **Optional.** Defines the number of metrics in an auto repeating panel. Defaults to 1 if repeatable is yes.|

Example:

```
vim /etc/icingaweb2/modules/grafana/graphs.ini

Expand All @@ -38,8 +39,6 @@ nmetrics = "1"

```

---

## Service(s)

### Name search order
Expand Down Expand Up @@ -109,16 +108,14 @@ Number of service perfdata metrics / number of metrics per panel config (nmetric
The Dashboard needs templating for metrics of a service like
```
SHOW TAG VALUES FROM /^COMMAND_NAME$/ WITH KEY = "metric" where hostname =~ /^$hostname$/ and service =~ /^$service$/
```
```

See [Repeating Rows and Panels](http://docs.grafana.org/guides/whats-new-in-v2-1/#repeating-rows-and-panels) for more information.

---

## Host(s)

For host you just need to use the `check_command` name as service name for the graph configuration.
The default `check_command` mostly `hostalive`. To get a list of your hosts and the check_command
For host you just need to use the `check_command` name as service name for the graph configuration.
The default `check_command` mostly `hostalive`. To get a list of your hosts and the check_command
used for the host use this code snippet in your shell

```bash
Expand All @@ -136,8 +133,6 @@ koelin02 -> hostalive
koenas.fritz.box -> hostalive
```

---

### Add host graph

To add a new graph configuration click on `Add New Grafana Graph`
Expand Down