Skip to content

Added health checks and monitoring to optional installation #496

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.

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

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
33 changes: 33 additions & 0 deletions source/installguide/optional_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,39 @@ For storing certificates, admins can create and configure a java keystore file
and configure the same in the server.properties file as illustrated above.


Health Checks and Monitoring (Optional)
---------------------------------------

CloudStack as a plugin for exporting metrics in the format that Prometheus can consume.
This is done by enabling the following configuration parameters in the Global Settings.

.. parsed-literal::

# cloudmonkey update configuration name=prometheus.exporter.enable value=true
# cloudmonkey update configuration name=prometheus.exporter.port value=9595
# cloudmonkey update configuration name=prometheus.exporter.allowed.ips value="127.0.0.1,192.168.0.10"

.. note::
These settings are available to be configured via the CloudStack UI as well.
CloudStack Management needs to be restarted for the changes to take effect.
Replace the mock IP address 192.168.0.10 with the actual IP address of the Prometheus server.

.. warning::
A list of addresses can be provided as a comma separated list. It does NOT accept CIDR notation.

Then, configure prometheus to start pulling metrics by adding the following configuration to ``/etc/prometheus/prometheus.yml``.

.. parsed-literal::

- job_name: 'management'
static_configs:
- targets: ['192.168.0.20:9595']

.. note::
Replace the mock IP address 192.168.0.20 with the actual IP address of the Management server.
Public dashboards are available in the Grafana repository for visualizing CloudStack Management metrics.


Database Replication (Optional)
-------------------------------

Expand Down