Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/export/export_lines.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/export/export_logs.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/export/export_search.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/search/import_filter.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions docs/exporting.md
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.

![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.
Copy link
Member

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


![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)

Comment on lines +39 to +44
Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe ### Exporting Streams' Logs or Export Logs from Streams could be a better fit


Chipmunk allows to render the streams of data from TCP or UDP.
Copy link
Member

Choose a reason for hiding this comment

The 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.
13 changes: 10 additions & 3 deletions docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)



Comment on lines +52 to +54
Copy link
Member

Choose a reason for hiding this comment

The 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.
Expand Down
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The 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
Copy link
Member

@AmmarAbouZor AmmarAbouZor Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's change the name of the file to export_logs.md to match its title here.
Also, the title has a typo in it Export instead of Expor

- Charts: charts.md
- Navigation: navigation.md
- Teamwork: teamwork.md
Expand Down
Loading