Skip to content

Commit

Permalink
Add qlog doc (#1184)
Browse files Browse the repository at this point in the history
  • Loading branch information
matoval authored Oct 23, 2024
1 parent 32a3ae7 commit 5312a25
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/source/user_guide/configuration_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^
Expand Down

0 comments on commit 5312a25

Please sign in to comment.