diff --git a/docs/source/devices/configure.rst b/docs/source/devices/configure.rst index d3089de53d7aafff58e2a0bae3c44e35fab1ce46..ba16efcba32e33497ce095b7f977860ed1c9d9de 100644 --- a/docs/source/devices/configure.rst +++ b/docs/source/devices/configure.rst @@ -6,6 +6,8 @@ The devices receive their configuration from two sources: - The TangoDB database, for static *properties*, - Externally, from the user, or a control system, that set *control attributes*. +.. _tangodb: + TangoDB ------------------------- diff --git a/docs/source/logs.rst b/docs/source/logs.rst index fd6b9735ac548688d3c63718bb0c32373fa1de73..91900af0a483e4833d6f1ace25da9336eb98c9cd 100644 --- a/docs/source/logs.rst +++ b/docs/source/logs.rst @@ -7,7 +7,9 @@ The devices, and the docker containers in general, produce logging output. The e This is mostly useful for interactive use. -ELK stack +.. _elk: + +ELK ------------------ To monitor the logs remotely, or to browse older logs, use the *ELK stack* that is included on the station, and served on http://localhost:5601. ELK, or ElasticSearch + Logstash + Kibana, is a popular log collection and querying system. Currently, the following logs are collected in our ELK installation: diff --git a/docs/source/monitoring.rst b/docs/source/monitoring.rst index 1fbcf81d713e4eb45854dd913975f13e564822b0..0f479a4298401ee35da37f2a890936efde09541c 100644 --- a/docs/source/monitoring.rst +++ b/docs/source/monitoring.rst @@ -17,10 +17,12 @@ You are encouraged to inspect each panel (graph) to see the underlying database The Grafana dashboards are configured with the following data sources: -- *Prometheus*, the time-series database that caches the latest values of all monitoring points (see next section), +- :ref:`prometheus-section`, the time-series database that caches the latest values of all monitoring points (see next section), - *Archiver DB*, the database that provides a long-term cache of attributes, -- *Tango DB*, providing access to device properties (fixed settings), -- *ELK*, the log output of the devices. +- :ref:`tangodb`, providing access to device properties (fixed settings), +- :ref:`elk`, the log output of the devices. + +.. _prometheus-section: Prometheus ------------------------- diff --git a/docs/source/remote_interfaces.rst b/docs/source/remote_interfaces.rst index 452708cf02cd2afad80626056d15d43097d04625..f587e5592c9c858a74277e0f59ac560cfec42e04 100644 --- a/docs/source/remote_interfaces.rst +++ b/docs/source/remote_interfaces.rst @@ -24,7 +24,7 @@ Futhermore, there are some low-level interfaces: +---------------------+--------------+----------------------+-------------------+ | :ref:`rest-api` |tango-rest |http://localhost:8080 |tango-cs/tango | +---------------------+--------------+----------------------+-------------------+ -|Tango Database |MariaDB |http://localhost:3306 |tango/tango | +| :ref:`tangodb` |MariaDB |http://localhost:3306 |tango/tango | +---------------------+--------------+----------------------+-------------------+ |Archive Database |MariaDB |http://localhost:3307 |tango/tango | +---------------------+--------------+----------------------+-------------------+