From 9a91d031fb2b0b84f950e575b14f1c745f73adbf Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Fri, 8 Oct 2021 07:16:16 +0200
Subject: [PATCH] L2SS-434: Added logviewer

---
 docs/source/interfaces/logs.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/source/interfaces/logs.rst b/docs/source/interfaces/logs.rst
index 91900af0a..648adf0c6 100644
--- a/docs/source/interfaces/logs.rst
+++ b/docs/source/interfaces/logs.rst
@@ -28,3 +28,17 @@ ELK allows you to filter, edit the columns, and a lot more. We enrich the log en
 .. image:: elk_log_fields.png
 
 Furthermore, statistics from the ELK stack, such as the number of ERROR log messages, are made available as a data source in :doc:`monitoring`.
+
+LogViewer
+------------------
+
+For each device, Tango collects the logs as well. These can be viewed with the LogViewer X11 application. Make sure ``$DISPLAY`` is set, and run::
+
+  cd docker-compose
+  make start logviewer
+
+If LogViewer does not appear, check ``docker logs logviewer`` to see what went wrong.
+
+For information on how to use the LogViewer, see https://tango-controls.readthedocs.io/en/latest/tools-and-extensions/built-in/logviewer/logviewer.html.
+
+.. note:: If you need an X11 server on Windows, install `VcXsrv <https://sourceforge.net/projects/vcxsrv/>`_, disable access control during its startup, and use ``export DISPLAY=host.docker.internal:0`` in WSL.
-- 
GitLab