mirror of
https://github.com/bec-project/bec_widgets.git
synced 2025-07-13 11:11:49 +02:00
docs: add docs for LogPanel
This commit is contained in:
39
docs/user/widgets/log_panel/log_panel.md
Normal file
39
docs/user/widgets/log_panel/log_panel.md
Normal file
@ -0,0 +1,39 @@
|
||||
(user.widgets.log_panel)=
|
||||
|
||||
# LogPanel widget
|
||||
|
||||
The LogPanel widget can be used to view logs:
|
||||
|
||||

|
||||
|
||||
It automatically subscribes to log updates. You can fetch the log history with the "Fetch history" button.
|
||||
|
||||
## Filtering based on log level
|
||||
|
||||
If you select a dropdown box, only logs of that priority level or higher will be displayed:
|
||||
|
||||

|
||||
|
||||
|
||||
## Filtering based on a search string
|
||||
|
||||
If you type in a search string into the box in the toolbar, and hit enter or press the update button, that filter will be applied:
|
||||
|
||||

|
||||
|
||||
This search uses the [Python regular expression syntax](https://docs.python.org/3/library/re.html) if the checkbox for this option is selected:
|
||||
|
||||

|
||||
|
||||
|
||||
## Filtering based on time range
|
||||
|
||||
You may filter the logs to those occurring within a given time range.
|
||||
|
||||

|
||||
|
||||
## Filtering based on service
|
||||
|
||||
You can select which services to show logs from.
|
||||
|
||||

|
BIN
docs/user/widgets/log_panel/logpanel.png
Normal file
BIN
docs/user/widgets/log_panel/logpanel.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 213 KiB |
BIN
docs/user/widgets/log_panel/logpanel_level.png
Normal file
BIN
docs/user/widgets/log_panel/logpanel_level.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 159 KiB |
BIN
docs/user/widgets/log_panel/logpanel_regex.png
Normal file
BIN
docs/user/widgets/log_panel/logpanel_regex.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 396 KiB |
BIN
docs/user/widgets/log_panel/logpanel_services.png
Normal file
BIN
docs/user/widgets/log_panel/logpanel_services.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 303 KiB |
BIN
docs/user/widgets/log_panel/logpanel_text.png
Normal file
BIN
docs/user/widgets/log_panel/logpanel_text.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 184 KiB |
BIN
docs/user/widgets/log_panel/logpanel_timerange.png
Normal file
BIN
docs/user/widgets/log_panel/logpanel_timerange.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 34 KiB |
Reference in New Issue
Block a user