-
Notifications
You must be signed in to change notification settings - Fork 41
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
Open
sudeeptarlekar
wants to merge
5
commits into
esrlabs:master
Choose a base branch
from
sudeeptarlekar:task/2417/add_import_export_docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f46f9ee
Add documentation for import and export functionality in Chipmunk
sudeeptarlekar 4c5b227
Add import export entry in the mkdocs
sudeeptarlekar 63dd8c4
Fix import export documentation
sudeeptarlekar 776f1bc
Remove filter details from export logs
sudeeptarlekar cc12d6c
Resolve PR comments
sudeeptarlekar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
|
|
||
|  | ||
|
|
||
| ### 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. | ||
| 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. | ||
|
|
||
|  | ||
|
|
||
| ### 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 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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: | ||
|
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. 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 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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