diff --git a/.gitlab/ci/pipelines/before_merging.yml b/.gitlab/ci/pipelines/before_merging.yml
index 8664aba30a9bafc710634f0130bf76a6b1ea8d14..6afa6f4e55dd2279413ff160531861fe6725b77d 100644
--- a/.gitlab/ci/pipelines/before_merging.yml
+++ b/.gitlab/ci/pipelines/before_merging.yml
@@ -4456,6 +4456,7 @@ documentation:manuals:
- docs/*/octez-*.html
- docs/api/octez-*.txt
- docs/developer/metrics.csv
+ - docs/developer/rollup_metrics.csv
- docs/user/node-config.json
documentation:docgen:
diff --git a/.gitlab/ci/pipelines/master_branch.yml b/.gitlab/ci/pipelines/master_branch.yml
index 067b62b0f1059b94f26db9d4f76ec66b7d819353..26a744142bc9aff9c47c97d41f01f5e3252fbc38 100644
--- a/.gitlab/ci/pipelines/master_branch.yml
+++ b/.gitlab/ci/pipelines/master_branch.yml
@@ -453,6 +453,7 @@ documentation:manuals:
- docs/*/octez-*.html
- docs/api/octez-*.txt
- docs/developer/metrics.csv
+ - docs/developer/rollup_metrics.csv
- docs/user/node-config.json
documentation:docgen:
diff --git a/.gitlab/ci/pipelines/merge_train.yml b/.gitlab/ci/pipelines/merge_train.yml
index e6a1c683e5a7aa6915789389c72f3daad59d74ff..64c752e46e328ed9156a48a7994b2e7ffbbd76cb 100644
--- a/.gitlab/ci/pipelines/merge_train.yml
+++ b/.gitlab/ci/pipelines/merge_train.yml
@@ -4456,6 +4456,7 @@ documentation:manuals:
- docs/*/octez-*.html
- docs/api/octez-*.txt
- docs/developer/metrics.csv
+ - docs/developer/rollup_metrics.csv
- docs/user/node-config.json
documentation:docgen:
diff --git a/.gitlab/ci/pipelines/schedule_extended_test.yml b/.gitlab/ci/pipelines/schedule_extended_test.yml
index ace794b66ce3567878e85b2f42e976b37f4000b7..12a251596b1a437ff67f7635c13487157c40af97 100644
--- a/.gitlab/ci/pipelines/schedule_extended_test.yml
+++ b/.gitlab/ci/pipelines/schedule_extended_test.yml
@@ -3008,6 +3008,7 @@ documentation:manuals:
- docs/*/octez-*.html
- docs/api/octez-*.txt
- docs/developer/metrics.csv
+ - docs/developer/rollup_metrics.csv
- docs/user/node-config.json
documentation:docgen:
diff --git a/ci/bin/common.ml b/ci/bin/common.ml
index da0d3ebb5453f5d919d2a857edc6f572f6dac84b..b0b2b04d41a58fc46c1b725f8de2fb39230671bf 100644
--- a/ci/bin/common.ml
+++ b/ci/bin/common.ml
@@ -1506,6 +1506,7 @@ module Documentation = struct
"docs/*/octez-*.html";
"docs/api/octez-*.txt";
"docs/developer/metrics.csv";
+ "docs/developer/rollup_metrics.csv";
"docs/user/node-config.json";
])
["./scripts/ci/documentation:manuals.sh"]
diff --git a/docs/Makefile b/docs/Makefile
index f2e53fbd469e4c15c1aca7253f15f65c87024d8e..49991e555d5c5f5b249dc90e0f55e19f63f78506 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -160,6 +160,9 @@ docexes:
developer/metrics.csv:
../octez-node dump-metrics > developer/metrics.csv
+developer/rollup_metrics.csv:
+ ../octez-smart-rollup-node dump-metrics > developer/rollup_metrics.csv
+
$(ERRDOCEXE): docexes
$(RPCDOCEXE): docexes
$(P2PDOCEXE): docexes
@@ -204,7 +207,7 @@ user/node-config.json: user/node-config.sh
# Pages generated by running Octez binaries
.PHONY: octez-gen
-octez-gen: developer/metrics.csv user/node-config.json manuals
+octez-gen: developer/metrics.csv developer/rollup_metrics.csv user/node-config.json manuals
# Pages generated by the generators under docs/doc_gen/
.PHONY: docexes-gen
@@ -233,6 +236,9 @@ sphinx-check: install-dependencies
# metrics.csv must actually contain some CSV rows with 4 fields each.
@echo "a,b,c,d" > developer/metrics.csv
@echo "1,2,3,4" >> developer/metrics.csv
+# rollup_metrics.csv must actually contain some CSV rows with 4 fields each.
+ @echo "a,b,c,d" > developer/rollup_metrics.csv
+ @echo "1,2,3,4" >> developer/rollup_metrics.csv
# Build with dummy output
@$(SPHINXBUILD) --builder dummy $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)"
@@ -301,6 +307,6 @@ fmt: black
clean:
@-rm -Rf "$(BUILDDIR)" linkcheck odoc.log
@-rm -f $(ERRDOCEXE) $(RPCDOCEXE) $(P2PDOCEXE)
- @-rm -Rf api/errors.rst developer/metrics.csv user/node-config.json alpha/rpc.rst shell/rpc.rst shell/p2p_api.rst user/default-acl.json CHANGES-dev.rst
+ @-rm -Rf api/errors.rst developer/metrics.csv user/node-config.json alpha/rpc.rst shell/rpc.rst shell/p2p_api.rst user/default-acl.json CHANGES-dev.rst developer/rollup_metrics.csv
@-rm -Rf api/octez-*.html api/octez-*.txt paris/octez-*.html alpha/octez-*.html quebec/octez-*.html
@-rm -Rf ../openapi-tmp
diff --git a/docs/developer/rollup_metrics.rst b/docs/developer/rollup_metrics.rst
new file mode 100644
index 0000000000000000000000000000000000000000..c3995cb4713ffb4e9d32e9678d4db464d5022b76
--- /dev/null
+++ b/docs/developer/rollup_metrics.rst
@@ -0,0 +1,19 @@
+
+Supported Open Metrics
+======================
+
+The smart-rollup node is able to produce metrics information and serve them in the
+`Open Metrics
+`_ format, an emerging standard for exposing metrics data, especially used in cloud-based systems.
+
+The smart-rollup node supports the following metrics, characterized by: the name of
+the metric, the type of the metric as in the `open metrics specification
+`__, a user-friendly description of the metric and a
+list of labels (that can be used to aggregate or query metrics).
+
+For more information check the Open Metrics specification.
+
+.. csv-table::
+ :file: rollup_metrics.csv
+ :header-rows: 1
+ :widths: 20, 20, 20, 10
diff --git a/docs/shell/smart_rollup_node.rst b/docs/shell/smart_rollup_node.rst
index 25b894c128d8e79e89913abf3d7c2bda7bd74fa4..aeac870504f6958e8b1f8b9c3f2c5c370bdf5660 100644
--- a/docs/shell/smart_rollup_node.rst
+++ b/docs/shell/smart_rollup_node.rst
@@ -373,6 +373,18 @@ The rollup node can now be run with just:
The configuration will be read from ``${ROLLUP_NODE_DIR}/config.json``.
+Monitoring a smart-rollup node
+""""""""""""""""""""""""""""""
+
+The smart-rollup node offers the same :doc:`monitoring features <../user/node-monitoring>` as the Octez node.
+
+For the list of metrics provided by the rollup node see the following page:
+
+.. toctree::
+ :maxdepth: 2
+
+ ../developer/rollup_metrics
+
Rollup node in a sandbox
""""""""""""""""""""""""