Skip to content

Commit a241d99

Browse files
committed
Proofread docs, make links more SEO-friendly
1 parent e33aeb6 commit a241d99

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

doc/monitoring/grafana_dashboard.rst

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Grafana dashboard
66

77
Tarantool Grafana dashboard is available as part of
88
`Grafana Official & community built dashboards <https://grafana.com/grafana/dashboards>`_.
9-
You can find version for Prometheus datasource on
10-
`this page <https://grafana.com/grafana/dashboards/13054>`_ and version for
11-
InfluxDB datasource on `this page <https://grafana.com/grafana/dashboards/12567>`_.
9+
There's a version
10+
`for Prometheus data source <https://grafana.com/grafana/dashboards/13054>`_
11+
and one `for InfluxDB data source <https://grafana.com/grafana/dashboards/12567>`_.
1212
Tarantool Grafana dashboard is a ready for import template with basic memory,
13-
space operations and HTTP load panels, based on default `metrics <https://github.com/tarantool/metrics>`_
13+
space operations, and HTTP load panels, based on default `metrics <https://github.com/tarantool/metrics>`_
1414
package functionality.
1515

1616
Dashboard requires using ``metrics`` **0.5.0** or newer;
@@ -32,30 +32,31 @@ to properly display panels (e.g. provided with ``cartridge.roles.metrics`` role)
3232
Prepare a monitoring stack
3333
-------------------------------------------------------------------------------
3434

35-
Since there are Prometheus and InfluxDB datasource Grafana dashboards,
35+
Since there are Prometheus and InfluxDB data source Grafana dashboards,
3636
you can use
3737

3838
- `Telegraf <https://www.influxdata.com/time-series-platform/telegraf/>`_
3939
as a server agent for collecting metrics, `InfluxDB <https://www.influxdata.com/>`_
40-
as a time series database for storing metrics, `Grafana <https://grafana.com/>`_
40+
as a time series database for storing metrics, and `Grafana <https://grafana.com/>`_
4141
as a visualization platform; or
42-
- `Prometheus <https://prometheus.io/>`_ as both server agent for collecting metrics
43-
and time series database for storing metrics, `Grafana <https://grafana.com/>`_
42+
- `Prometheus <https://prometheus.io/>`_ as both a server agent for collecting metrics
43+
and a time series database for storing metrics, and `Grafana <https://grafana.com/>`_
4444
as a visualization platform.
4545

46-
For issues concerning set up of Prometheus, Telegraf, InfluxDB or Grafana instances
47-
please refer to corresponding project's documentation.
46+
For issues concerning setting up Prometheus, Telegraf, InfluxDB, or Grafana instances
47+
please refer to the corresponding project's documentation.
4848

4949
.. _monitoring-grafana_dashboard-collect_metrics:
5050

5151
-------------------------------------------------------------------------------
5252
Collect metrics with server agents
5353
-------------------------------------------------------------------------------
5454

55-
To collect metrics for Prometheus, first off you must set up metrics output with
55+
To collect metrics for Prometheus, first set up metrics output with
5656
``prometheus`` format. You can use :ref:`cartridge.roles.metrics <cartridge-role>`
57-
configuration or set up :ref:`output plugin <prometheus>` manually.
58-
To start collecting metrics, add a `job <https://prometheus.io/docs/prometheus/latest/getting_started/#configure-prometheus-to-monitor-the-sample-targets>`_
57+
configuration or set up the :ref:`Prometheus output plugin <prometheus>` manually.
58+
To start collecting metrics,
59+
`add a job <https://prometheus.io/docs/prometheus/latest/getting_started/#configure-prometheus-to-monitor-the-sample-targets>`_
5960
to Prometheus configuration with each Tarantool instance URI as a target and
6061
metrics path as it was configured on Tarantool instances:
6162

@@ -71,14 +72,14 @@ metrics path as it was configured on Tarantool instances:
7172
metrics_path: "/metrics/prometheus"
7273
7374
74-
To collect metrics for InfluxDB, you must use Telegraf agent.
75+
To collect metrics for InfluxDB, use the Telegraf agent.
7576
First off, configure Tarantool metrics output in ``json`` format
7677
with :ref:`cartridge.roles.metrics <cartridge-role>` configuration or
77-
corresponding :ref:`output plugin <json>`. To start collecting metrics,
78+
corresponding :ref:`JSON output plugin <json>`. To start collecting metrics,
7879
add `http input <https://github.com/influxdata/telegraf/blob/release-1.17/plugins/inputs/http/README.md>`_
7980
to Telegraf configuration including each Tarantool instance metrics URL:
8081

81-
.. code-block:: text
82+
.. code-block:: toml
8283
8384
[[inputs.http]]
8485
urls = [
@@ -119,13 +120,13 @@ Open Grafana import menu.
119120
.. image:: images/grafana_import_v6.png
120121
:align: left
121122

122-
To import specific dashboard, choose one of the following options:
123+
To import a specific dashboard, choose one of the following options:
123124

124-
- paste dashboard id (``12567`` for InfluxDB dashboard, ``13054`` for Prometheus dashboard), or
125-
- paste link to dashboard (https://grafana.com/grafana/dashboards/12567 for InfluxDB dashboard,
125+
- paste the dashboard id (``12567`` for InfluxDB dashboard, ``13054`` for Prometheus dashboard), or
126+
- paste a link to the dashboard (https://grafana.com/grafana/dashboards/12567 for InfluxDB dashboard,
126127
https://grafana.com/grafana/dashboards/13054 for Prometheus dashboard), or
127-
- paste dashboard json file contents, or
128-
- upload dashboard json file.
128+
- paste the dashboard JSON file contents, or
129+
- upload the dashboard JSON file.
129130

130131
Set dashboard name, folder, uid (if needed), and datasource-related query parameters
131132
(InfluxDB source, measurement and policy or Prometheus source, job and rate time range).
@@ -139,7 +140,7 @@ Set dashboard name, folder, uid (if needed), and datasource-related query parame
139140
Troubleshooting
140141
-------------------------------------------------------------------------------
141142

142-
If no data presents on graphs, ensure that you set up datasource and job/measurement correctly.
143+
If there's no data on the graphs, make sure that you have set up datasource and job/measurement correctly.
143144

144-
If no data presents on rps graphs on Prometheus table, ensure that
145+
If there's no data on the rps graphs on Prometheus table, make sure that
145146
your rate time range parameter is at least twice as Prometheus scrape interval.

0 commit comments

Comments
 (0)