From d857921517b5cb03af8fc81c57ce753768375fe9 Mon Sep 17 00:00:00 2001 From: Victor Hansson Date: Mon, 1 Jul 2024 07:56:12 +0300 Subject: [PATCH] F OpenNebula/one#6430: Refactor Monitoring section * Overview * Instalation and configuration * Grafana Visualization * Alert Manager * Exporter Metrics Signed-off-by: Victor Hansson --- .../monitor_alert/alerts.rst | 8 ++++---- .../monitor_alert/grafana.rst | 14 +++++++------- .../monitor_alert/install.rst | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/source/management_and_operations/monitor_alert/alerts.rst b/source/management_and_operations/monitor_alert/alerts.rst index a676fd02ed..b540b3579e 100644 --- a/source/management_and_operations/monitor_alert/alerts.rst +++ b/source/management_and_operations/monitor_alert/alerts.rst @@ -7,9 +7,9 @@ Alert Manager Installation and Configuration ================================================================================ -.. note:: If you are already running the Prometheus AlertManager you can skip this section and add to your rules file the alarms described in the next section. +.. note:: If you are already running the Prometheus AlertManager you can skip this section and add the alarms described in the next section to your rules file. -AlertManager is part of the Prometheus distribution and should be already installed in your system after completing the installation process, :ref:`see more details here `. +AlertManager is part of the Prometheus distribution and should already be installed in your system after completing the installation process, :ref:`see more details here `. Now you just need to enable and start the AlertManager service: @@ -43,7 +43,7 @@ The configuration file for the AlertManager can be found in ``/etc/one/alertmana Alerts Rules ================================================================================ -We provide some pre-defined alert rules that cover the common use cases for an OpenNebula cloud. These rules are not intended to use as-is, but as a starting point to define the alert situations for your specific use case. Please `review the Promethus documentation `_ to adapt the provided alert rules. +We provide some pre-defined alert rules that cover the most common use cases for an OpenNebula cloud. These rules are not intended to use as-is, but as a starting point to define the alert situations for your specific use case. Please `review the Prometheus documentation `_ to adapt the provided alert rules. Alert Rules can be found in ``/etc/one/prometheus/rules.yml`` @@ -128,7 +128,7 @@ Setting up Alarms for OpenNebula in HA .. important:: - To avoid duplicated / multiplicated alert notifications you should configure **all** your alertmanager instances to run in HA mode, + To avoid duplicate alert notifications you should configure **all** your alertmanager instances to run in HA mode, then point **all** your prometheus instances to them. Please refer to the :ref:`Using Prometheus with OpenNebula in HA ` section for details. diff --git a/source/management_and_operations/monitor_alert/grafana.rst b/source/management_and_operations/monitor_alert/grafana.rst index 6002cc2c2e..7bcf65c8ae 100644 --- a/source/management_and_operations/monitor_alert/grafana.rst +++ b/source/management_and_operations/monitor_alert/grafana.rst @@ -7,12 +7,12 @@ Grafana Visualization Requirements ================================================================================ -This guide assumes you have already and up and running Grafana service. If you do not have already Grafana installed, follow the follwoing guides: +This guide assumes you already have a up and running Grafana service. If you do not already have Grafana installed, refer to the following guides: - `Download and Installation `_. - `Add a new Prometheus Data sources `_. -.. note:: Prometheus is listening in the standard port (9090) as described in the installation guide. +.. note:: Prometheus is listening on the standard port (9090) as described in the installation guide. Grafana Dashboards ================================================================================ @@ -36,7 +36,7 @@ Grafana Provisioning Grafana supports `provisioning` which can be used to automatically reconfigure Grafana instances in shell scripts or automation engines like ansible. -In case of OpenNebula you can use it to for example configure datasources and dashboards: +In case of OpenNebula you can use it to, for instance, configure datasources and dashboards: .. prompt:: bash # auto @@ -54,14 +54,14 @@ In case of OpenNebula you can use it to for example configure datasources and da .. important:: - In the case your Grafana instance is running along Prometheus on the same OpenNebula server, - then the **http://localhost:9090** above can be utilized with `ssh tunneling`: + In the case that your Grafana instance is running alongside Prometheus on the same OpenNebula server, + then the **http://localhost:9090** above, can be accessed with `ssh tunneling`: .. prompt:: bash $ auto $ ssh -L 9090:localhost:9090 user@opennebula-server-running-prometheus - Otherwise, provide FQDN or IP address and make sure you can access Prometheus instance from your web browser. + Otherwise, provide the FQDN or IP address and make sure that you can access the Prometheus instance from your web browser. .. prompt:: bash # auto @@ -80,7 +80,7 @@ In case of OpenNebula you can use it to for example configure datasources and da # systemctl restart grafana-server.service After the `grafana-server.service` restarts you should be able to connect and verify that the ``prometheus`` datasource -is operational and OpenNebula dashboards show live data. +is operational and the OpenNebula dashboards show live data. Please refer to the official documentation to learn more about `Grafana provisioning `_. diff --git a/source/management_and_operations/monitor_alert/install.rst b/source/management_and_operations/monitor_alert/install.rst index 4eb64dea0d..0a1b94cba8 100644 --- a/source/management_and_operations/monitor_alert/install.rst +++ b/source/management_and_operations/monitor_alert/install.rst @@ -9,7 +9,7 @@ This page describes how to install the OpenNebula Prometheus integration package Step 1. OpenNebula Repositories [Front-end, Hosts] ================================================================================ -At this point OpenNebula software repositories should be already configured in your front-end and hosts. Double check this is the case before proceeding, more information can be found in the :ref:`OpenNebula Repositories ` guide. +At this point OpenNebula software repositories should already be configured in your front-end and hosts. Double check this is the case before proceeding, more information can be found in the :ref:`OpenNebula Repositories ` guide. Step 2. Install Front-end Packages [Front-end] ================================================================================ @@ -69,7 +69,7 @@ Note that you will be able to use any existing installation of the node exporter Step 4. Configure Prometheus [Front-end] ================================================================================ -The OpenNebula Prometheus package comes with a simple script that automatically configure the scrape endpoints for your cloud. First, make sure all your hosts are properly listed with onehost command, for example: +The OpenNebula Prometheus package comes with a simple script that automatically configures the scrape endpoints for your cloud. First, make sure all your hosts are properly listed with the onehost command, for example: .. prompt:: bash $ auto