From c9b9dec0edf1c6dfbb54e01f07dbc7264ecda0aa Mon Sep 17 00:00:00 2001 From: Markus Opolka Date: Wed, 13 Nov 2024 11:17:49 +0100 Subject: [PATCH 1/4] Update GitHub Issue Templates - Use our organisation wide templates --- .github/ISSUE_TEMPLATE.md | 47 --------------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 27 ++++++++++++ .github/ISSUE_TEMPLATE/documentation.yaml | 10 +++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 15 +++++++ .github/ISSUE_TEMPLATE/question.yaml | 10 +++++ 5 files changed, 62 insertions(+), 47 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/documentation.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/question.yaml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index ecd4c79..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - -## Expected Behavior - - - -## Current Behavior - - - -## Possible Solution - - - -## Steps to Reproduce (for bugs) - - -1. -2. -3. -4. - -## Context - - - -## Your Environment - -* Icinga Web 2 Grafana version (System - About): -* Icinga Web 2 version and modules (System - About): -* Version used (`icinga2 --version`): -* Operating System and version: -* Enabled features (`icinga2 feature list`): -* Config validation (`icinga2 daemon -C`): - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..6adb01d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,27 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug", "needs-triage"] +body: + - type: checkboxes + id: terms + attributes: + label: Please try to fill out as much of the information below as you can. Thank you! + options: + - label: Yes, I've searched similar issues on GitHub and didn't find any. + required: true + - type: input + id: app_version + attributes: + label: Which version contains the bug? + placeholder: 1.0.0 + - type: textarea + id: description + attributes: + label: Describe the bug + description: Please provide a concise description of the bug, add any relevant output or error messages. You can use markdown. + - type: textarea + id: recreate + attributes: + label: How to recreate the bug? + description: Please provide the steps to recreate the issue. diff --git a/.github/ISSUE_TEMPLATE/documentation.yaml b/.github/ISSUE_TEMPLATE/documentation.yaml new file mode 100644 index 0000000..088b14f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yaml @@ -0,0 +1,10 @@ +name: Documentation +description: Suggest documentation improvements +title: "[Documentation]: " +labels: ["documentation"] +body: + - type: textarea + id: description + attributes: + label: Describe the improvements you'd like. + description: Please provide as much context as possible. You can use markdown. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..12c9e2e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,15 @@ +name: Feature Request +description: Request a feature or enhancement +title: "[Feature]: " +labels: ["feature", "needs-triage"] +body: + - type: markdown + attributes: + value: | + Please try to fill out as much of the information below as you can. Thank you! + **Note:** If you want to sponsor new features, contact us at info@netways.de + - type: textarea + id: description + attributes: + label: Describe the feature request + description: Please provide a concise description of the feature. You can use markdown. diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml new file mode 100644 index 0000000..65183ea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yaml @@ -0,0 +1,10 @@ +name: Question +description: Ask a question +title: "[Question]: " +labels: ["question"] +body: + - type: textarea + id: description + attributes: + label: Ask a question + description: Please provide as much context as possible. You can use markdown. From 7650862afeb790d6774e6c6087fec93a6e95e44f Mon Sep 17 00:00:00 2001 From: Markus Opolka Date: Wed, 13 Nov 2024 11:26:48 +0100 Subject: [PATCH 2/4] Update repository path in doc/ --- doc/01-about.md | 2 +- doc/02-installation.md | 8 ++++---- doc/05-update.md | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/01-about.md b/doc/01-about.md index 393e3be..085f4f3 100644 --- a/doc/01-about.md +++ b/doc/01-about.md @@ -22,4 +22,4 @@ LICENSE file included in the source package. ## Support -[Github Issues](https://github.com/Mikesch-mp/icingaweb2-module-grafana/issues) +[Github Issues](https://github.com/NETWAYS/icingaweb2-module-grafana/issues) diff --git a/doc/02-installation.md b/doc/02-installation.md index 02b5ce2..dd452ad 100644 --- a/doc/02-installation.md +++ b/doc/02-installation.md @@ -28,26 +28,26 @@ Use this only if you want to use/test the latest developer version of the module ``` ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" -REPO_URL="https://github.com/Mikesch-mp/icingaweb2-module-grafana" +REPO_URL="https://github.com/NETWAYS/icingaweb2-module-grafana" TARGET_DIR="${ICINGAWEB_MODULEPATH}/grafana" git clone "${REPO_URL}" "${TARGET_DIR}" ``` ### Tarball -Replace the version number with the lates available version from [Latest Release](https://github.com/Mikesch-mp/icingaweb2-module-grafana/releases/latest) +Replace the version number with the lates available version from [Latest Release](https://github.com/NETWAYS/icingaweb2-module-grafana/releases/latest) ``` MODULE_VERSION="2.0.1" ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" -REPO_URL="https://github.com/Mikesch-mp/icingaweb2-module-grafana" +REPO_URL="https://github.com/NETWAYS/icingaweb2-module-grafana" TARGET_DIR="${ICINGAWEB_MODULEPATH}/grafana" URL="${REPO_URL}/archive/v${MODULE_VERSION}.tar.gz" install -d -m 0755 "${TARGET_DIR}" wget -q -O - "$URL" | tar xfz - -C "${TARGET_DIR}" --strip-components 1 ``` -### Enable the module +### Enable the module In the Icinga Web 2 frontend in `Configuration -> Modules -> grafana -> enable`. diff --git a/doc/05-update.md b/doc/05-update.md index 0c56479..1bbf548 100644 --- a/doc/05-update.md +++ b/doc/05-update.md @@ -14,13 +14,13 @@ inside the module directory (usaly /usr/share/icingaweb2/modules/grafana) ## Using latest tarball The steps taken to update are the same as installation, but to make sure old files are removed -we will delete the old module directory first. Get the [latest version number](https://github.com/Mikesch-mp/icingaweb2-module-grafana/releases/latest) from git and put +we will delete the old module directory first. Get the [latest version number](https://github.com/NETWAYS/icingaweb2-module-grafana/releases/latest) from git and put into the `MODULE_VERSION` variable ```bash MODULE_VERSION="2.0.0" ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" -REPO_URL="https://github.com/Mikesch-mp/icingaweb2-module-grafana" +REPO_URL="https://github.com/NETWAYS/icingaweb2-module-grafana" TARGET_DIR="${ICINGAWEB_MODULEPATH}/grafana" URL="${REPO_URL}/archive/v${MODULE_VERSION}.tar.gz" rm -rf ${TARGET_DIR} @@ -36,5 +36,5 @@ and or changed configuration options. When done, just hit the `Save Changes` but ## Dashboards -Dont forget to check the dashboard directories for newer versions of existing ones +Dont forget to check the dashboard directories for newer versions of existing ones or new dashboards. From 2a6bd3f8c3ab28cfe756805d39f71aca301f133d Mon Sep 17 00:00:00 2001 From: Markus Opolka Date: Wed, 13 Nov 2024 11:27:36 +0100 Subject: [PATCH 3/4] Update README, CONTRIBUTING and RELEASE - Replace repository name - Mention upsteam repo and fork Co-authored-by: Tobias Bauriedel --- CONTRIBUTING.md | 35 +++++++++++++++-------------------- README.md | 15 ++++++--------- RELEASE.md | 14 +++++++------- 3 files changed, 28 insertions(+), 36 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 17c9052..1a5e2db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,8 +19,8 @@ bug reports and features requests or writing code to add enhancements or fix bug ## Introduction -Please consider our [roadmap](https://github.com/Icinga/icingaweb2/milestones) and -[open issues](https://github.com/icinga/icingaweb2/issues) when you start contributing +Please consider the milestones and +open issues when you start contributing to the project. Before starting your work on this Icinga Web 2 for Grafana, you should [fork the project](https://help.github.com/articles/fork-a-repo/) @@ -37,20 +37,15 @@ Please continue reading in the following sections for a step by step guide. ## Fork the Project [Fork the project](https://help.github.com/articles/fork-a-repo/) to your GitHub account -and clone the repository: - -``` -git clone git@github.com:dnsmichi/icingaweb2-module-grafana.git -cd icingaweb2-module-grafana -``` +and clone the repository. Add a new remote `upstream` with this repository as value. ``` -git remote add upstream https://github.com/Mikesch-mp/icingaweb2-module-grafana.git +git remote add upstream https://github.com/NETWAYS/icingaweb2-module-grafana.git ``` -You can pull updates to your fork's master branch: +You can pull updates to your fork's main branch: ``` git fetch --all @@ -104,15 +99,15 @@ Don't worry, you can squash those changes into a single commit later on. ## Pull Requests -Once you've committed your changes, please update your local master +Once you've committed your changes, please update your local main branch and rebase your fix/feature branch against it before submitting a PR. ``` -git checkout master +git checkout main git pull upstream HEAD git checkout fix/style-detail-view -git rebase master +git rebase main ``` Once you've resolved any conflicts, push the branch to your remote repository. @@ -148,22 +143,22 @@ Thanks a lot for your contribution! ### Rebase a Branch -If you accidentally sent in a PR which was not rebased against the upstream master, +If you accidentally sent in a PR which was not rebased against the upstream main, developers might ask you to rebase your PR. -First off, fetch and pull `upstream` master. +First off, fetch and pull `upstream` main. ``` -git checkout master +git checkout main git fetch --all git pull upstream HEAD ``` -Then change to your working branch and start rebasing it against master: +Then change to your working branch and start rebasing it against main: ``` git checkout fix/style-detail-view -git rebase master +git rebase main ``` If you are running into a conflict, rebase will stop and ask you to fix the problems. @@ -196,7 +191,7 @@ If you fear to break things, do the rebase in a backup branch first and later re git checkout fix/style-detail-view git checkout -b fix/style-detail-view-rebase -git rebase master +git rebase main git branch -D fix/style-detail-view git checkout -b fix/style-detail-view @@ -237,7 +232,7 @@ git push -f origin fix/style-detail-view ## Testing -You can help test-drive the Git master inside the +You can help test-drive the Git main inside the [Icinga 2 Vagrant boxes](https://github.com/icinga/icinga-vagrant). $ git clone https://github.com/Icinga/icinga-vagrant.git diff --git a/README.md b/README.md index 3aa7f6e..a7fe021 100644 --- a/README.md +++ b/README.md @@ -10,24 +10,20 @@ 6. [Contributing](#contributing) 7. [Donations](#donations) - ## About Add Grafana graphs into Icinga Web 2 to display performance metrics. - - + + - +
- - - ## License Icinga Web 2 and this Icinga Web 2 module are licensed under the terms of the GNU @@ -48,12 +44,14 @@ Join the [Icinga community channels](https://icinga.com/community/) for question ## Documentation -You can find the complete documentation inside the [doc](https://github.com/Mikesch-mp/icingaweb2-module-grafana/raw/master/doc) folder. +You can find the complete documentation inside the [doc](doc/) folder. ## Thanks This module borrows a lot from https://github.com/Icinga/icingaweb2-module-generictts & https://github.com/Icinga/icingaweb2-module-pnp. +This is a fork of https://github.com/Mikesch-mp/icingaweb2-module-grafana/ + ## Contributing There are many ways to contribute to the Icinga Web module for Grafana -- @@ -61,4 +59,3 @@ whether it be sending patches, testing, reporting bugs, or reviewing and updating the documentation. Every contribution is appreciated! Please continue reading in the [contributing chapter](CONTRIBUTING.md). - diff --git a/RELEASE.md b/RELEASE.md index b583f33..90a93d3 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -10,7 +10,7 @@ VERSION=1.2.1 ## Issues -Check issues at https://github.com/Mikesch-mp/icingaweb2-module-grafana/milestones +Check issues at https://github.com/NETWAYS/icingaweb2-module-grafana/milestones ## Version @@ -30,18 +30,18 @@ Ensure to have [github_changelog_generator](https://github.com/skywinder/github- installed and set the GitHub token to avoid rate limiting. ``` -github_changelog_generator -u mikesch-mp -p icingaweb2-module-grafana --future-release=$VERSION +github_changelog_generator -u netways -p icingaweb2-module-grafana --future-release=$VERSION ``` ## Git Tag -Commit these changes to the "master" branch: +Commit these changes to the "main" branch: ``` $ git commit -v -a -m "Release version $VERSION" ``` -Create a signed tag (tags/v) on the "master" branch. +Create a signed tag (tags/v) on the "main" branch. ``` $ git tag -m "Version $VERSION" v$VERSION @@ -56,7 +56,7 @@ $ git push --tags ## Release Tests -* Provision the vagrant boxes and pull the master in `/usr/share/icingaweb2/modules/grafana` +* Provision the vagrant boxes and pull the main in `/usr/share/icingaweb2/modules/grafana` Example: @@ -70,7 +70,7 @@ $ vagrant ssh -c "cd /usr/share/icingaweb2/modules/grafana && sudo git pull" ## GitHub Release Create a new release for the newly created Git tag. -https://github.com/Mikesch-mp/icingaweb2-module-grafana/releases +https://github.com/NETWAYS/icingaweb2-module-grafana/releases Note: A new GitHub release will be synced by Icinga Exchange automatically. @@ -81,4 +81,4 @@ Note: A new GitHub release will be synced by Icinga Exchange automatically. # After the release -* Close the released version at https://github.com/Mikesch-mp/icingaweb2-module-grafana/milestones +* Close the released version at https://github.com/NETWAYS/icingaweb2-module-grafana/milestones From ca2a87f20c21609d760c9f4ce461d556cc6fc4a3 Mon Sep 17 00:00:00 2001 From: Markus Opolka Date: Wed, 13 Nov 2024 12:00:55 +0100 Subject: [PATCH 4/4] Spellcheck docs/ --- doc/01-about.md | 2 +- doc/02-installation.md | 6 +-- doc/03-module-configuration.md | 48 ++++++++++---------- doc/04-graph-configuration.md | 8 ++-- doc/05-update.md | 4 +- doc/06-create-grafana-dashboards-influxdb.md | 14 +++--- doc/07-create-grafana-dashboards-graphite.md | 14 +++--- 7 files changed, 48 insertions(+), 48 deletions(-) diff --git a/doc/01-about.md b/doc/01-about.md index 085f4f3..1f950b2 100644 --- a/doc/01-about.md +++ b/doc/01-about.md @@ -22,4 +22,4 @@ LICENSE file included in the source package. ## Support -[Github Issues](https://github.com/NETWAYS/icingaweb2-module-grafana/issues) +[GitHub Issues](https://github.com/NETWAYS/icingaweb2-module-grafana/issues) diff --git a/doc/02-installation.md b/doc/02-installation.md index dd452ad..d456c35 100644 --- a/doc/02-installation.md +++ b/doc/02-installation.md @@ -16,7 +16,7 @@ to the latest version, please [read on here](05-update.md). ## Install the Grafana module As with any Icinga Web 2 module, installation is pretty straight-forward. In -case you're installing it from source all you have to do is to drop the grafana +case you're installing it from source all you have to do is to drop the Grafana module in one of your module paths. You can examine (and set) the module path(s) in `Configuration / Application`. In a typical environment you'll probably drop the module to `/usr/share/icingaweb2/modules/grafana`. Please note that the directory @@ -35,7 +35,7 @@ git clone "${REPO_URL}" "${TARGET_DIR}" ### Tarball -Replace the version number with the lates available version from [Latest Release](https://github.com/NETWAYS/icingaweb2-module-grafana/releases/latest) +Replace the version number with the latest available version from [Latest Release](https://github.com/NETWAYS/icingaweb2-module-grafana/releases/latest) ``` MODULE_VERSION="2.0.1" @@ -51,7 +51,7 @@ wget -q -O - "$URL" | tar xfz - -C "${TARGET_DIR}" --strip-components 1 In the Icinga Web 2 frontend in `Configuration -> Modules -> grafana -> enable`. -![iEnable grafana module](images/02-installation-01.png) +![enable Grafana module](images/02-installation-01.png) You can also enable the module by using the `icingacli` command: diff --git a/doc/03-module-configuration.md b/doc/03-module-configuration.md index f125291..1ab22f3 100644 --- a/doc/03-module-configuration.md +++ b/doc/03-module-configuration.md @@ -1,20 +1,20 @@ # Module configuration -Here you will learn howto configure the module and details about the options you can choose. +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 inifile directly. +The configuration can be done via web interface or by editing the configuration ini-file directly. ### Configuration with web interface -Browse to [/icingaweb2/config/modules#!/icingaweb2/grafana/config](/icingaweb2/config/modules#!/icingaweb2/grafana/config). Here you can set all the options descripted below. +Browse to [/icingaweb2/config/modules#!/icingaweb2/grafana/config](/icingaweb2/config/modules#!/icingaweb2/grafana/config). Here you can set all the options described below. ![Grafana module configuration](images/03-module_grafana_configuration01.png "Grafana module configuration") --- -### Configuration by editing inifile +### Configuration by editing ini-file -On most ditributions, if you used the repository as install source, you will find the configuration file in `/etc/icingaweb2/modules/grafana`. +On most distributions, if you used the repository as install source, you will find the configuration file in `/etc/icingaweb2/modules/grafana`. If the directory does not exists create it with @@ -22,7 +22,7 @@ If the directory does not exists create it with install -d -m 0755 -g icingaweb2 /etc/icingaweb2/modules/grafana ``` -Then use your prefered editor to create the file config.ini in the just created or existing directory. +Then use your preferred editor to create the file config.ini in the just created or existing directory. #### Example config.ini (/etc/icingaweb2/modules/grafana/config.ini) @@ -70,24 +70,24 @@ ssl_verifyhost = "0" |enableLink | **Optional.** Enable/disable graph with a rendered URL to the Grafana dashboard. Defaults to `yes`.| |datasource | **Required for Grafana 4.x only.** Type of the Grafana datasource (`influxdb`, `graphite` or `pnp`). Defaults to `influxdb`.| |defaultdashboard | **Required.** Name of the default dashboard which will be shown for unconfigured graphs. Set to `none` to hide the module output. Defaults to `icinga2-default`.| -|defaultdashboarduid | **Required for Grafana 5** The UID of the default dashbaoard for **Grafana 5**. +|defaultdashboarduid | **Required for Grafana 5** The UID of the default dashboard for **Grafana 5**. |defaultdashboardpanelid| **Required** ID of the panel used in the default dashboard. Defaults to `1`. |shadows | **Optional.** Show shadows around the graphs. ** Defaults to `false`.| |defaultorgid | **Required.** Number of the default organization id where dashboards are located. Defaults to `1`. |defaultdashboardstore | **Optional.** Grafana backend (file or database). Defaults to `Database`.| |accessmode | **Optional.** Controls whether graphs are fetched with curl (`indirectproxy`) or in iframe ('iframe'). Iframe needs `auth.anonymous` enabled in Grafana. Defaults to `indirectproxy`.| |timeout | **Proxy only** **Optional.** Timeout in seconds for proxy mode to fetch images. Defaults to `5`.| -|authentication | **Proxy only** Authentication type used to acccess Grafana. Can be set to `anon`,`token` or `basic`. Defaults to `anon`. +|authentication | **Proxy only** Authentication type used to access Grafana. Can be set to `anon`,`token` or `basic`. Defaults to `anon`. |username | **Proxy with basic only** **Required** HTTP Basic Auth user name to access Grafana.| |password | **Proxy with basic only** **Required** HTTP Basic Auth password to access Grafana. Requires the username setting.| |apitoken | **Proxy with token only** **Required** API token used to access Grafana.| |indirectproxyrefresh | **Indirect Proxy Only** **Optional.** Refresh graphs on indirect proxy mode. Defaults to `yes`.| |usepublic | **Optional** Enable usage of publichost/protocol. Defaults to `no`.| -|publichost | **Optional** Use a diffrent host for the graph links.| -|publicprotocol | **Optional** Use a diffrent protocol for the graph links.| +|publichost | **Optional** Use a different host for the graph links.| +|publicprotocol | **Optional** Use a different protocol for the graph links.| |custvardisable | **Optional** Custom variable (vars.idontwanttoseeagraph for example) that will disable graphs. Defaults to `grafana_graph_disable`.| |custvarconfig | **Optional** Custom variable (vars.usegraphconfig for example) that will be used as config name. Defaults to `grafana_graph_config`.| -|theme | **Optional.** Select grafana theme for the graph (light or dark). Defaults to `light`.| +|theme | **Optional.** Select Grafana theme for the graph (light or dark). Defaults to `light`.| |debug | **Optional.** Enables the debug information under the graph if the user has permission to see them. Defaults to `disabled`.| |ssl_verifypeer | **Proxy mode only** **Optional.** Verify the peer's SSL certificate. Defaults to `false`.| |ssl_verifyhost | **Proxy mode only** **Optional.** Verify the certificate's name against host. Defaults to `false`.| @@ -96,7 +96,7 @@ ssl_verifyhost = "0" --- ### host -**Required** Hostname and port or Grafana url depending on your Grafana installation. +**Required** Hostname and port or Grafana URL depending on your Grafana installation. For example `127.0.0.1:300` or `localhost:3000` or `grafana-host-domain.tld/grafana` or `10.111.1.1/grafana` @@ -127,46 +127,46 @@ The datasource that Grafana server uses. Can be InfluxDB, Graphite. ### defaultorgid Number of the default organization id where dashboards are located. Defaults to `1`. -You can fetch the id if you browse to your grafana server menu -> Admin -> Global Orgs +You can fetch the id if you browse to your Grafana server menu -> Admin -> Global Orgs ### defaultdashboard The name of the default dashboard that is used when **no graph is configured** for your service, host or command. See [04-graph configuration](04-graph-configuration.md) for details about how to configure graphs. ### defaultdashboarduid -**Required for Grrafana 5** The UID for the default dashboard for Grafana 5. +**Required for Grafana 5** The UID for the default dashboard for Grafana 5. To get the UID, inspect the URL from your dashboard inside Grafana, it is right before the dashboard name. For example the URL is 'https://192.168.178.52:3000/d/FxAre-ekz/icinga2-default?orgId=1' the UID is then 'FxAre-ekz'. ### defaultdashboardpanelid -The id of the panel used in the defaul dashboard. Defaults to `1`. +The id of the panel used in the default dashboard. Defaults to `1`. ### shadows Enable/Disable fancy shadows around the graph image. ### accessmode -Controls ihow the graphs are fetched/delivered for/to the users. +Controls how the graphs are fetched/delivered for/to the users. Defaults to `indirectproxy`. #### indirectproxy -This mode the module still will feth the graphs with curl on **server side**, but the images are given by reference. +This mode the module still will fetch the graphs with curl on **server side**, but the images are given by reference. This will speed up the page load, but the image will take some seconds to show up. Pro: Very fast page loading, very secure. Contra: Images take some seconds to show up. #### iframe -In Iframe mode you have the full power of Grafana features like mouse over tooltip. +In iframe mode you have the full power of Grafana features like mouse over tool tip. Pro: All features from Grafana enabled. Fast page rendering. Contra: Less secure, page refresh from Icingaweb2 will be distracting! Needs `auth.anonymous` enabled in Grafana. Also you need `allow_embedding = true` enabled in your grafana.ini ### ssl_verifypeer Only for `proxy` & `ìndirectproxy` modes. Verify the peer's SSL certificate. Defaults to `false`. -Read [CURLOPT_SSL_VERIFYHOST](https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html) for mor informations. +Read [CURLOPT_SSL_VERIFYHOST](https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html) for more information. ### ssl_verifyhost Only for `proxy` & `ìndirectproxy` modes.Verify the certificate's name against host. Defaults to `false`. -Read [CURLOPT_SSL_VERIFYPEER](https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html) for mor informations. +Read [CURLOPT_SSL_VERIFYPEER](https://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html) for more information. ### timeout Used with 'proxy' mode only. @@ -174,7 +174,7 @@ Timeout in seconds for loading graph images from Grafana server. Defaults to `5 If you often get a timeout message then the image, raise this to 10 or more seconds. ### authentication -Authentication type used to acccess Grafana. Can be set to `anon`,`token` or `basic`. Defaults to `anon`. +Authentication type used to access Grafana. Can be set to `anon`,`token` or `basic`. Defaults to `anon`. * `anon` needs enabled [auth.anonymous] enabled in grafana.ini. * `basic` needs [auth.basic] enabled in grafana.ini. * `token` needs a generated API token from Grafana. @@ -196,7 +196,7 @@ Defaults to `yes`. ### usepublic Enables/Disables the usage of a `public` URL to the Grafana server. -If you have set your grafanaurl for example to localhost then you can set here a url that is used for to link to Grafana. +If you have set your grafanaurl for example to localhost then you can set here a URL that is used for to link to Grafana. ### publichost Used with 'usepublic = yes'. @@ -212,7 +212,7 @@ For example `vars.idontwanttoseeagraph = true` or `vars.idontwanttoseeagraph = " ### custvarconfig Name of the custom variable (vars.usegraphconfig for example) that will be used as graph config name. Defaults to `grafana_graph_config`. -This will overwrite the search order and force the module to use the graph configuration name that the variiable points to. +This will overwrite the search order and force the module to use the graph configuration name that the variable points to. For example you have `vars.grafana_graph_config = "check_my_tesla"` in your service configuration, the module will look for an [graph configuration](04-graph-configuration.md) that is named `check_my_tesla` and use this to render/show the performance graph. If there is no such a configuration, the `default-template` will be used. @@ -221,4 +221,4 @@ If there is no such a configuration, the `default-template` will be used. The Grafana theme that will be used. Defaults to `light`. ### debug -Show debug informtions if user has permission to see them. Defaults to `false`. +Show debug information if user has permission to see them. Defaults to `false`. diff --git a/doc/04-graph-configuration.md b/doc/04-graph-configuration.md index ccd79da..40928f3 100644 --- a/doc/04-graph-configuration.md +++ b/doc/04-graph-configuration.md @@ -89,7 +89,7 @@ This opens a new tab with the configuration options ![Add New Grafana Graph](images/04-graph.configuration-03.png) -We will use the `parametrized service name` "if-usage" in our example, the dasboard named `nwc_health` and the graph with panelid 1. +We will use the `parametrized service name` "if-usage" in our example, the dashboard named `nwc_health` and the graph with panelid 1. ![Add New Grafana Graph](images/04-graph.configuration-04.png) @@ -99,14 +99,14 @@ After hitting the `Add graph` button we see our new graph configuration. ### Auto repeating panels -If you set a graph to be autorepeating your Grafana dashboard must provide the repeating panels by its own. +If you set a graph to be auto repeating your Grafana dashboard must provide the repeating panels by its own. The formula for how many panels will be shown is ``` Number of service perfdata metrics / number of metrics per panel config (nmetrics) = number of panels ``` -The Dasboard needs templating for metrics of a service like +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$/ ``` @@ -149,7 +149,7 @@ This opens a new tab with the configuration options ![Add New Grafana Graph](images/04-graph.configuration-03.png) Fill in the name of the `check_command` name we just discovered above as **__Name__**, the dashboard name -and the panelid of the graph you want to use. Thats it :) +and the panelid of the graph you want to use. That's it :) Example: diff --git a/doc/05-update.md b/doc/05-update.md index 1bbf548..ca0f661 100644 --- a/doc/05-update.md +++ b/doc/05-update.md @@ -9,7 +9,7 @@ If you used [git clone](02-installation.md) to install the module, just do git pull ``` -inside the module directory (usaly /usr/share/icingaweb2/modules/grafana) +inside the module directory (usually /usr/share/icingaweb2/modules/grafana) ## Using latest tarball @@ -36,5 +36,5 @@ and or changed configuration options. When done, just hit the `Save Changes` but ## Dashboards -Dont forget to check the dashboard directories for newer versions of existing ones +Don't forget to check the dashboard directories for newer versions of existing ones or new dashboards. diff --git a/doc/06-create-grafana-dashboards-influxdb.md b/doc/06-create-grafana-dashboards-influxdb.md index 42943bd..cfc83cb 100644 --- a/doc/06-create-grafana-dashboards-influxdb.md +++ b/doc/06-create-grafana-dashboards-influxdb.md @@ -11,9 +11,9 @@ To save your changes, just hit the :floppy_disk: icon. ## Templating -We use templateing to get a map from var-[hostname|servicename|command] to a Grafana variable. We will set this as a query to InfluxDB and later if you want we change it to an constant. +We use templating to get a map from var-[hostname|servicename|command] to a Grafana variable. We will set this as a query to InfluxDB and later if you want we change it to an constant. Open the `Templating` settings and hit the ![Templating](images/06-new-button.png) button. -The variable name has to be `hostname`, `service` or `command` for the use with the grafana module. +The variable name has to be `hostname`, `service` or `command` for the use with the Grafana module. The `Datasource` should point to your InfluxDB datasource. Set the `Type` to `Query`, Refresh to `On Dashboard Load` and if you want, set `Sort` to what preferred sort order. @@ -36,7 +36,7 @@ The complete templating should now look like this ![Complete Templating](images/06-templating-influx.png) -Close the templateing and hit the :floppy_disk: icon to save the dashboard we made so far. +Close the templating and hit the :floppy_disk: icon to save the dashboard we made so far. ![New Dashboard with templating](images/06-new-dashboard-with-templating.png) @@ -90,15 +90,15 @@ Change the `pl` axis by clicking on the small colored line and choose `Right` as ![Set Y axis](images/06-dashboard-panel-yaxis.png) -## Change colors for values/tresholds +## Change colors for values/thresholds -To change the colors the quick way just click on the small colored line infront of the metric/thresholds in the legend. +To change the colors the quick way just click on the small colored line in front of the metric/thresholds in the legend. ![Colors for metrics/threshold](images/06-dashboard-panel-colors.png) The default Icinga2 color for critical is `#ff5566` and for warning it is `#ffaa44` -Dont forget to hit the :floppy_disk: from time to timee to save your dashboard. +Don't forget to hit the :floppy_disk: from time to time to save your dashboard. ## Change graph title (General tab) @@ -117,7 +117,7 @@ The left Y axis we set to `percent: (0-100)`, the `Y-Min` and `Decimals` to **0* ## Legend (Legend tab) Activate `As Table`, `Min`, `Max`, `Avg` and `Current` to have some more information shown. -If you want to hide metrics with only **0** in the choosen time range, activate **Hide series** `With only zeros` too. +If you want to hide metrics with only **0** in the chosen time range, activate **Hide series** `With only zeros` too. ![Legend](images/06-dashboard-panel-legend.png) diff --git a/doc/07-create-grafana-dashboards-graphite.md b/doc/07-create-grafana-dashboards-graphite.md index b079482..0d33a3a 100644 --- a/doc/07-create-grafana-dashboards-graphite.md +++ b/doc/07-create-grafana-dashboards-graphite.md @@ -11,9 +11,9 @@ To save your changes, just hit the :floppy_disk: icon. ## Templating -We use templateing to get a map from var-[hostname|servicename|command] to a Grafana variable. We will set this as a query to InfluxDB and later if you want we change it to an constant. +We use templating to get a map from var-[hostname|servicename|command] to a Grafana variable. We will set this as a query to InfluxDB and later if you want we change it to an constant. Open the `Templating` settings and hit the ![Templating](images/06-new-button.png) button. -The variable name has to be `hostname`, `service` or `command` for the use with the grafana module. +The variable name has to be `hostname`, `service` or `command` for the use with the Grafana module. The `Datasource` should point to your Graphite datasource. Set the `Type` to `Query`, Refresh to `On Dashboard Load` and if you want, set `Sort` to what preferred sort order. @@ -39,7 +39,7 @@ The complete templating should now look like this ![Complete Templating](images/07-templating-graphite.png) -Close the templateing and hit the :floppy_disk: icon to save the dashboard we made so far. +Close the templating and hit the :floppy_disk: icon to save the dashboard we made so far. ![New Dashboard with templating](images/06-new-dashboard-with-templating.png) @@ -94,15 +94,15 @@ Change the `pl`, `pl.warn`and `pl.crit` axis by clicking on the small colored li ![Set Y axis](images/06-dashboard-panel-yaxis.png) -## Change colors for values/tresholds +## Change colors for values/thresholds -To change the colors the quick way just click on the small colored line infront of the metric/thresholds in the legend. +To change the colors the quick way just click on the small colored line in front of the metric/thresholds in the legend. ![Colors for metrics/threshold](images/06-dashboard-panel-colors.png) The default Icinga2 color for critical is `#ff5566` and for warning it is `#ffaa44` -Dont forget to hit the :floppy_disk: from time to timee to save your dashboard. +Don't forget to hit the :floppy_disk: from time to time to save your dashboard. ## Change graph title (General tab) @@ -121,7 +121,7 @@ The left Y axis we set to `percent: (0-100)`, the `Y-Min` and `Decimals` to **0* ## Legend (Legend tab) Activate `As Table`, `Min`, `Max`, `Avg` and `Current` to have some more information shown. -If you want to hide metrics with only **0** in the choosen time range, activate **Hide series** `With only zeros` too. +If you want to hide metrics with only **0** in the chosen time range, activate **Hide series** `With only zeros` too. ![Legend](images/06-dashboard-panel-legend.png)