leyoda/pop-launcher
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add instructions for logging

Browse source
This commit is contained in:
Christoph Kröppl 2024-01-24 00:22:05 +01:00 • committed by GitHub
parent b1f6002ab1
commit 0205007463
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 23 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -95,6 +95,29 @@ nmcli connection up "vpn-name"
</pre> </pre>
</details> </details>
## Logging
Available for the launcher itself and all plugins, logging is implemented with the [tracing](https://docs.rs/tracing/latest/tracing/) crate. It has been pre-configured and re-exported as part of this crate. The standard **info!**, **warn!**, **error!**, and **debug!** macros can be used, after this use statement:
```rust
use pop_launcher_toolkit::plugin_trait::tracing::*;
```
Per-plugin, a log file will be created in this directory: `~/.local/state/`
<details>
<summary>Example log file paths:</summary>
```bash
~/.local/state/pop-launcher.log
your-plugin.log
...
```
</details>
The log level of the launcher and all its plugins (official and community) can be changed per-user in the GNOME extension settings: **Extensions** > **Pop Shell** > **Settings** > **Log Level**
## JSON IPC ## JSON IPC
Whether implementing a frontend or a plugin, the JSON codec used by pop-launcher is line-based. Every line will contain a single JSON message That will be serialized or decoded as a `Request`, `PluginResponse`, or `Response`. These types can be referenced in [docs.rs](https://docs.rs/pop-launcher). IPC is based on standard input/output streams, so you should take care not to write logs to stdout. Whether implementing a frontend or a plugin, the JSON codec used by pop-launcher is line-based. Every line will contain a single JSON message That will be serialized or decoded as a `Request`, `PluginResponse`, or `Response`. These types can be referenced in [docs.rs](https://docs.rs/pop-launcher). IPC is based on standard input/output streams, so you should take care not to write logs to stdout.