Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add p2p validator dashboard information to prometheus endpoint docs.

pull/2333/head
derekpierre 2020-10-05 12:39:28 -04:00
parent 2c89cec8f8
commit 7000bc99f1
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/source/.static/img/p2p_validator_dashboard.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 383 KiB

18
docs/source/guides/network_node/ursula_configuration_guide.rst
View File

@ -203,7 +203,13 @@ It should eventually be listed on the `Status Monitor Page <https://status.nucyp
Prometheus Endpoint
~~~~~~~~~~~~~~~~~~~
Ursula can optionally provide a `Prometheus <https://prometheus.io>`_ metrics endpoint to be used for as a data source
for real-time monitoring. This functionality is disabled by default but can be enabled by providing the following
for real-time monitoring. The Prometheus client library is **not** installed by default and must be explicitly installed:
.. code:: bash
(nucypher)$ pip install nucypher[ursula]
The metrics endpoint is disabled by default but can be enabled by providing the following
parameters to the ``nucypher ursula run`` command:
* ``--prometheus`` - a boolean flag to enable the prometheus endpoint
@ -212,12 +218,12 @@ parameters to the ``nucypher ursula run`` command:
The corresponding endpoint, ``http://<node_ip>:<METRICS PORT>/metrics``, can be used as a Prometheus data source for
monitoring including the creation of alert criteria.
Prometheus is **not** installed by default and must be explicitly installed:
.. code:: bash
(nucypher)$ pip install nucypher[ursula]
During the Technical Contributor Phase of our testnet, *P2P Validator*
contributed a `self-hosted node monitoring suite <https://economy.p2p.org/nucypher-worker-node-monitoring-suite/amp/>`_
that uses a Grafana dashboard to visualize and monitor the metrics produced by the prometheus endpoint.
.. image:: ../../.static/img/p2p_validator_dashboard.png
:target: ../../.static/img/p2p_validator_dashboard.png
.. note::