Skip to content

Commit

Permalink
docs: install/monitoring-stack match new tag format
Browse files Browse the repository at this point in the history
The new tag format changes the downloaded file name and the directory
name.

Fixes #2288

Signed-off-by: Amnon Heiman <amnon@scylladb.com>
  • Loading branch information
amnonh committed Jul 8, 2024
1 parent d7bc101 commit 94ccb69
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/source/install/monitoring-stack.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ Install Scylla Monitoring Stack
:substitutions:
wget https://github.com/scylladb/scylla-monitoring/archive/|version|.tar.gz
tar -xvf scylla-monitoring-|version|.tar.gz
cd scylla-monitoring-scylla-monitoring-|version|
tar -xvf |version|.tar.gz
cd scylla-monitoring-|version|
As an alternative, you can clone and use the Git repository directly.

Expand Down Expand Up @@ -289,15 +289,15 @@ If the environment variables **SCYLLA_USER** and **SCYLLA_PSSWD** are set, they
To set the user and password from a file, edit `grafana/datasource.scylla.yml`. Uncomment the **secureJsonData** part and set the user and password.

.. note:: It is best to use a dedicated user and password with limited privileges.


Use an external directory for the Prometheus data directory
...........................................................

The ``-d`` flag, places the Prometheus data directory outside of its container and by doing that makes it persistent.

.. note:: Specifying an external directory is important for systems in production. Without it,
every restart of the monitoring stack will result in metrics lost.
.. note:: Specifying an external directory is important for systems in production. Without it,
every restart of the monitoring stack will result in metrics lost.

If the directory provided does not exist, the ``start-all.sh`` script will create it. Note that you should avoid running docker as root, the ``start-all.sh`` script
will use the user permissions that runs it. This is important if you want to place the prometheus directory not under the user path but somewhere else, for example ``/prometheus-data``.
Expand Down Expand Up @@ -377,7 +377,7 @@ To do that run ./start-all.sh with the -l flag. For example:
Configure rsyslog on each Scylla node
.....................................
generates metrics and alerts from logs. To get full functionality, you should use rsyslog_. Scylla Monitoring Stack will act as an additional rsyslog server.
Scylla Monitoring Stack collects Scylla logs using Loki and generates metrics and alerts based on these logs.
Scylla Monitoring Stack collects Scylla logs using Loki and generates metrics and alerts based on these logs.
To use this feature, you need to direct logs from each Scylla node to Loki.
The recommended method to do this is by using rsyslog_, where Scylla Monitoring Stack (Loki) acts as an additional rsyslog server.
.. note:: Scylla can send logs to more than one log collection service.
Expand Down

0 comments on commit 94ccb69

Please sign in to comment.