mirror of
https://github.com/zadam/trilium.git
synced 2025-10-30 18:05:55 +01:00
docs(guide): document script logging
This commit is contained in:
19
docs/User Guide/User Guide/Scripting/Logging.md
vendored
Normal file
19
docs/User Guide/User Guide/Scripting/Logging.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
# Logging
|
||||
Both front-end and back-end notes can log messages for debugging.
|
||||
|
||||
## UI logging via `api.log`
|
||||
|
||||
<figure class="image image_resized image-style-align-center" style="width:57.74%;"><img style="aspect-ratio:749/545;" src="Logging_image.png" width="749" height="545"></figure>
|
||||
|
||||
The API log feature integrates with the script editor and it displays all the messages logged via `api.log`. This works for both back-end and front-end scripts.
|
||||
|
||||
The API log panel will appear after executing a script that uses `api.log` and it can be dismissed temporarily by pressing the close button in the top-right of the panel.
|
||||
|
||||
Apart from strings, an object can be passed as well in which case it will be pretty-formatted if possible (e.g. recursive objects are not supported).
|
||||
|
||||
## Console logging
|
||||
|
||||
For logs that are not directly visible to the user, the standard `console.log` can be used as well.
|
||||
|
||||
* For front-end scripts, the log will be shown in the Developer Tools (also known as Inspect).
|
||||
* For back-end scripts, the log will be shown in the server output while running but **will not** be visible in the <a class="reference-link" href="../Troubleshooting/Error%20logs/Backend%20(server)%20logs.md">Backend (server) logs</a>.
|
||||
BIN
docs/User Guide/User Guide/Scripting/Logging_image.png
vendored
Normal file
BIN
docs/User Guide/User Guide/Scripting/Logging_image.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
Reference in New Issue
Block a user