diff --git a/docs/assets/export/export_lines.gif b/docs/assets/export/export_lines.gif new file mode 100644 index 000000000..1db9fd03f Binary files /dev/null and b/docs/assets/export/export_lines.gif differ diff --git a/docs/assets/export/export_logs.gif b/docs/assets/export/export_logs.gif new file mode 100644 index 000000000..5a6f557e1 Binary files /dev/null and b/docs/assets/export/export_logs.gif differ diff --git a/docs/assets/export/export_search.gif b/docs/assets/export/export_search.gif new file mode 100644 index 000000000..3d7e63260 Binary files /dev/null and b/docs/assets/export/export_search.gif differ diff --git a/docs/assets/search/import_filter.gif b/docs/assets/search/import_filter.gif new file mode 100644 index 000000000..697ec5caa Binary files /dev/null and b/docs/assets/search/import_filter.gif differ diff --git a/docs/exporting.md b/docs/exporting.md new file mode 100644 index 000000000..cdaac9788 --- /dev/null +++ b/docs/exporting.md @@ -0,0 +1,52 @@ +Chipmunk supports flexible import and export of log files, allowing users +to save, share, archive, or analyze logs with ease. +Once log files are imported into Chipmunk, users can export them as plain +text logs or binary files. + +![Export plain text logs](assets/export/export_logs.gif) + +### Exporting Search Results + +Chipmunk allows user to search specific string or value in the logs and create +a search filter for logs. These filters can also be exported as CSV or just +plain raw logs. + +When exporting a filtered view, Chipmunk supports two formats: + +**Table** + +1. The search results are exported as a structured text, or in other words CSV file. +2. This format is useful when you want to process logs with spreadsheets or +data analysis tools (Excel, pandas, etc.). + +**Raw** + +1. The filtered results are exported as a binary file. +2. Useful when user wants to share only filtered logs from Chipmunk. + +![Export Search Results](assets/export/export_search.gif) + +### Exporting Selected Log Lines + +In addition to exporting filtered logs, Chipmunk also allows users to manually +select specific lines from the log view and export only those entries. +This feature is particularly useful when you need to share or analyze a small +subset of log messages without exporting the entire file or applying complex +filters. + +![Export Lines](assets/export/export_lines.gif) + +### Exporting filters and presets + +Along with the logs user can also export the filters for later use and sharing, +find out more how user can export the filters from Chipmunk +[here](../search/#importing-exporting-presets) + +### Exporting Streams + +Chipmunk allows to render the streams of data from TCP or UDP. +User can also search through these streams and also can select particular lines +to export. + +Please not that, exporting binary from streamed data is not yet possible in +Chipmunk. diff --git a/docs/search.md b/docs/search.md index 915e7224e..4068b7f39 100644 --- a/docs/search.md +++ b/docs/search.md @@ -34,17 +34,24 @@ Checked/Unchecked/Disabled filters ![Filters manipulation](assets/search/filters_enable_disable.gif) -### Importing / Exporting +### Importing / Exporting Presets Filters/charts will be associated with an opened file (or stream). Next time the same file (or stream) is opened, filters/charts will be restored. -At the same time, there are a couple of ways to export/import filters: +At the same time, there are a couple of ways to export filters: - via the context menu on the list of filters/charts -- via tab "History/Profiles" to export/import different collections of filters/charts +- via tab "History/Profiles" to export different collections of filters/charts ![Import/Export](assets/search/importing.gif) +Just like the exorting the filter from the Chipmunk, user can also import the +filters in the Chipmunk. + +![Import Filter](assets/search/import_filter.gif) + + + ### Breadcrumbs Breadcrumbs mode allows mixed search results and other content. It's very useful in cases when it's essential to understand what was logged before/after the target occasion. diff --git a/mkdocs.yml b/mkdocs.yml index aead8f4a6..ca316ea0c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,10 +3,15 @@ site_url: https://esrlabs.github.io/chipmunk/ docs_dir: docs theme: name: material + icon: + admonition: + note: material/note + alert: material/alert nav: - Overview: index.md - Installation: installation.md - Search: search.md + - Expor Logs: exporting.md - Charts: charts.md - Navigation: navigation.md - Teamwork: teamwork.md