-
Notifications
You must be signed in to change notification settings - Fork 39
Add import and export documentation #2422
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
base: master
Are you sure you want to change the base?
Changes from all commits
e196672
6b5eb9c
cddce71
dc5ef20
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
|  | ||
|
|
||
| ### 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. | ||
|
|
||
|  | ||
|
|
||
| ### 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. | ||
|
|
||
|  | ||
|
|
||
| ### 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) | ||
|
|
||
|
Comment on lines
+39
to
+44
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Filters don't belong to this document. I thought that this document is just for exporting logs only |
||
| ### Exporting Streams | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe |
||
|
|
||
| Chipmunk allows to render the streams of data from TCP or UDP. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This isn't 100% correct. I would replace it with something like Chipmunk supports parsing and analyzing logs from multiple stream sources. We don't need to start mentioning the sources because we have many TCP, UDP, The output of process commands and serial ports |
||
| 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. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,17 +34,24 @@ Checked/Unchecked/Disabled filters | |
|
|
||
|  | ||
|
|
||
| ### 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 | ||
|
|
||
|  | ||
|
|
||
| Just like the exorting the filter from the Chipmunk, user can also import the | ||
| filters in the Chipmunk. | ||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
|
Comment on lines
+52
to
+54
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Too many line-breaks |
||
| ### 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. | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
Comment on lines
+6
to
+9
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm curious why we need to add this here? |
||
| nav: | ||
| - Overview: index.md | ||
| - Installation: installation.md | ||
| - Search: search.md | ||
| - Expor Logs: exporting.md | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's change the name of the file to |
||
| - Charts: charts.md | ||
| - Navigation: navigation.md | ||
| - Teamwork: teamwork.md | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be used to combine logs from different file sources into one binary files. This can be achieved when you add multiple file sources in one session, then the filter results will be from them all and the export will be a combination from concatenated files