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.
49 changes: 49 additions & 0 deletions docs/export_logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
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
Copy Markdown
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

3. This is also useful when user wants to combine the results from two files,
and then export only filtered results. This filtered export will contain
data from both 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 Logs from Streams

Chipmunk allows to rendering and analyzing logs from multiple stream sources.
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.
2 changes: 1 addition & 1 deletion docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Checked/Unchecked/Disabled filters

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:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why we are removing import here?


- via the context menu on the list of filters/charts
- via tab "History/Profiles" to export/import different collections of filters/charts
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ nav:
- Overview: index.md
- Installation: installation.md
- Search: search.md
- Export Logs: export_logs.md
- Charts: charts.md
- Navigation: navigation.md
- Teamwork: teamwork.md
Expand Down
Loading