Skip to content

Commit 692508b

Browse files
Document metrics in Tarantool 3.0 (#4348)
1 parent 4402be2 commit 692508b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+3505
-49
lines changed

.gitmodules

-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
1-
[submodule "modules/metrics"]
2-
path = modules/metrics
3-
url = https://github.com/tarantool/metrics.git
41
[submodule "modules/luatest"]
52
path = modules/luatest
63
url = https://github.com/tarantool/luatest
7-
[submodule "modules/grafana-dashboard"]
8-
path = modules/grafana-dashboard
9-
url = https://github.com/tarantool/grafana-dashboard
104
[submodule "modules/tntcxx"]
115
path = modules/tntcxx
126
url = https://github.com/tarantool/tntcxx.git

build_submodules.sh

-12
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,6 @@ po_dest="${project_root}/locale/ru/LC_MESSAGES"
1111
# Copy Building Tarantool Docs guide
1212
cp README.rst doc/contributing/docs/_includes/README.rst
1313

14-
15-
# Monitoring
16-
monitoring_root="${project_root}/modules/metrics/doc/monitoring"
17-
monitoring_dest="${project_root}/doc/book"
18-
monitoring_grafana_root="${project_root}/modules/grafana-dashboard/doc/monitoring"
19-
20-
# Copy monitoring docs to the right destination
21-
mkdir -p "${monitoring_dest}"
22-
cp -rfv "${monitoring_root}" "${monitoring_dest}/"
23-
cp -rfv "${monitoring_grafana_root}" "${monitoring_dest}/"
24-
25-
2614
# Luatest
2715
luatest_root="${project_root}/modules/luatest"
2816
luatest_dest="${project_root}/doc/reference/reference_rock/luatest"

doc/book/admin/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ This chapter includes the following sections:
4141
os_notes
4242
bug_reports
4343
troubleshoot
44-
../monitoring/index
44+
monitoring

doc/book/admin/monitoring.rst

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _monitoring:
2+
3+
Monitoring
4+
==========
5+
6+
Monitoring is the process of capturing runtime information about the instances of a Tarantool cluster using metrics.
7+
Metrics can indicate various characteristics, such as memory usage, the number of records in spaces, replication status, and so on.
8+
Typically, metrics are monitored in real time, allowing for the identification of current issues or the prediction of potential ones.
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
:numbered: 0
13+
14+
monitoring/getting_started
15+
monitoring/grafana_dashboard
16+
monitoring/alerting
17+
monitoring/metrics_reference

0 commit comments

Comments
 (0)