From 5312a253ee0c0be5a99d2f9b8178dea7218c7438 Mon Sep 17 00:00:00 2001 From: Matthew Sandoval Date: Wed, 23 Oct 2024 09:32:05 -0700 Subject: [PATCH] Add qlog doc (#1184) --- .../user_guide/configuration_options.rst | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/source/user_guide/configuration_options.rst b/docs/source/user_guide/configuration_options.rst index 74f6c2e06..ad921693c 100644 --- a/docs/source/user_guide/configuration_options.rst +++ b/docs/source/user_guide/configuration_options.rst @@ -88,6 +88,35 @@ Please be aware that using payload tracing can potentially reveal sensitive info log-level: level: debug +^^^^ +Qlog +^^^^ + +.. list-table:: Qlog + :header-rows: 1 + :widths: auto + + * - Variable + - Description + - Type + * - QLOGDIR + - environment variable to the directory path where logs will be stored + - string + +Qlogs allows greater visibility in the Receptors mesh network. Set the QLOGDIR environment variable to the directory path where logs will be stored. Creating a new directory may help organize qlogs. +Once logs are created they can be viewed using (qvis)[https://github.com/quiclog/qvis] + +----------------- +Run qvis locally: +----------------- + +- Git clone qvis repo +- ``cd visualizations`` +- ``run npm install`` +- ``npm run serve`` +- Qvis is now served on port 8080 +- Upload qlogs to qvis and navigate to Sequence + ^^^^ Node ^^^^