Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add qlog doc #1184

Merged
merged 11 commits into from
Oct 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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