From e193341620a4e7429bdbfe3c7b4e99245b8427ab Mon Sep 17 00:00:00 2001 From: Donien <88634789+Donien@users.noreply.github.com> Date: Fri, 30 Jan 2026 10:24:16 +0100 Subject: [PATCH] Make config documentation clearer --- doc/02-Installation.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/02-Installation.md b/doc/02-Installation.md index c959cb7..7f3856b 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -24,16 +24,18 @@ To install this module, follow the setup instructions for the **extras** reposit # Configuration +`config.ini` - section `graphite` + | Option | Description | Default value | |---------|-------------|----------------| -| graphite_api_url | The URL for Graphite including the scheme | `http://localhost:8081` | -| graphite_api_username | The user for HTTP basic auth. Not used if empty | | -| graphite_api_password | The password for HTTP basic auth. Not used if empty | | -| graphite_api_timeout | HTTP timeout for the API in seconds. Should be higher than 0 | `10` (seconds) | -| graphite_api_tls_insecure | Skip the TLS verification | `false` (unchecked) | -| graphite_max_data_points | The maximum numbers of datapoints each series returns. You can disable aggregation by setting this to 0. | `10000` | -| graphite_writer_host_name_template | The value of your Icinga 2 GraphiteWriter's attribute `host_name_template` (if specified) | `icinga2.$host.name$.host.$host.check_command$` | -| graphite_writer_service_name_template | The value of your Icinga 2 GraphiteWriter's attribute `service_name_template` (if specified) | `icinga2.$host.name$.services.$service.name$.$service.check_command$` | - -`graphite_max_data_points` is used for downsampling data. It uses the `maxDataPoints` option at the Graphite API. +| api_url | The URL for Graphite including the scheme | `http://localhost:8081` | +| api_username | The user for HTTP basic auth. Not used if empty | | +| api_password | The password for HTTP basic auth. Not used if empty | | +| api_timeout | HTTP timeout for the API in seconds. Should be higher than 0 | `10` (seconds) | +| api_tls_insecure | Skip the TLS verification | `false` (unchecked) | +| max_data_points | The maximum numbers of datapoints each series returns. You can disable aggregation by setting this to 0. | `10000` | +| writer_host_name_template | The value of your Icinga 2 GraphiteWriter's attribute `host_name_template` (if specified) | `icinga2.$host.name$.host.$host.check_command$` | +| writer_service_name_template | The value of your Icinga 2 GraphiteWriter's attribute `service_name_template` (if specified) | `icinga2.$host.name$.services.$service.name$.$service.check_command$` | + +`max_data_points` is used for downsampling data. It uses the `maxDataPoints` option at the Graphite API. If for any output series the number of datapoints in a selected range exceeds the maxDataPoints value then the datapoints over the whole period are consolidated.