From bb7fc2e5b1120d0b8e72843b0dc6d010e93c6b09 Mon Sep 17 00:00:00 2001 From: Dincer Celik Date: Mon, 23 Sep 2019 21:29:37 +0300 Subject: [PATCH] [prometheus] Added documentation for deployment and setting extra options Change-Id: I8bb39eaf8a4239c37fcbf91b55ec8003542e2506 --- .../logging-and-monitoring/index.rst | 1 + .../prometheus-guide.rst | 32 +++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 doc/source/reference/logging-and-monitoring/prometheus-guide.rst diff --git a/doc/source/reference/logging-and-monitoring/index.rst b/doc/source/reference/logging-and-monitoring/index.rst index 2ab7bd4a4c..9d14ac36ca 100644 --- a/doc/source/reference/logging-and-monitoring/index.rst +++ b/doc/source/reference/logging-and-monitoring/index.rst @@ -11,4 +11,5 @@ logging and monitoring services available in kolla. central-logging-guide monasca-guide osprofiler-guide + prometheus-guide skydive-guide diff --git a/doc/source/reference/logging-and-monitoring/prometheus-guide.rst b/doc/source/reference/logging-and-monitoring/prometheus-guide.rst new file mode 100644 index 0000000000..282f9089ee --- /dev/null +++ b/doc/source/reference/logging-and-monitoring/prometheus-guide.rst @@ -0,0 +1,32 @@ +.. _prometheus-guide: + +===================================================== +Prometheus - Monitoring System & Time Series Database +===================================================== + +Overview +~~~~~~~~ + +Kolla can deploy a full working Prometheus setup in either a **all-in-one** or +**multinode** setup. + +Preparation and deployment +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To enable Prometheus, modify the configuration file ``/etc/kolla/globals.yml`` +and change the following: + +.. code-block:: yaml + + enable_prometheus: "yes" + +Extending the default command line options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +It is possible to extend the default command line options for Prometheus by +using a custom variable. As an example, to set remote timeouts to 30 seconds +and data retention period to 2 days: + +.. code-block:: yaml + + prometheus_cmdline_extras: "-storage.remote.timeout 30s -storage.local.retention 48h"