Repository navigation
docs(clp-s): Add skeleton for clp-s design documentation; Write first half of clp-s single-file archive design document. #961
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
gibber9809
wants to merge
28
commits into
y-scope:main
Choose a base branch
from
gibber9809:clp-s-sfa-format-doc
base: main
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 10 commits
Commits
Show all changes
28 commits
Select commit
Hold shift + click to select a range
3d2d34c
Add skeleton for clp-s design docs
gibber9809 f06a7b5
Fill out basic detail in SFA format section
gibber9809 c31407e
Draft header section docs
gibber9809 10e3bd2
Add headers for remainder of subsections
gibber9809 8c0921f
Add metadata section preamble
gibber9809 e93a22b
Write up ArchiveInfo and ArchiveFileInfo packets.
gibber9809 727f5b0
Add a figure describing the binary format of the timestamp dictionary
gibber9809 bd9774e
Add basic write-up for TimestampPattern packet
gibber9809 c6e19fd
Document the archive range index
gibber9809 975feb1
Small edit for consistency
gibber9809 abc7a29
Move up Figure 2 in doc
gibber9809 3229a3f
Address some rabbit comments
gibber9809 bd2a705
Apply suggestions from code review
gibber9809 3986176
Apply suggestions from code review
gibber9809 ffd31bb
Apply suggestions from code review
gibber9809 509c448
Address some more review comments
gibber9809 231bda4
Address more review comments
gibber9809 6b0c8fc
Fix sfa docs file formatting
gibber9809 3849efe
Rewrite header format with struct-like description
gibber9809 d5bebd6
Address more comments
gibber9809 87e0673
Merge remote-tracking branch 'upstream/main' into clp-s-sfa-format-doc
gibber9809 fe14725
Merge branch 'main' into clp-s-sfa-format-doc
gibber9809 cf6992c
Merge branch 'main' into clp-s-sfa-format-doc
gibber9809 b14e345
Merge branch 'main' into pr-961
kirkrodrigues 088d483
Fixes after merging main.
kirkrodrigues c270b31
Merge branch 'main' into clp-s-sfa-format-doc
kirkrodrigues 17b3621
Merge branch 'main' into clp-s-sfa-format-doc
gibber9809 e8b5cfe
Merge branch 'main' into clp-s-sfa-format-doc
kirkrodrigues 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
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,8 @@ | ||
| # Background | ||
|
|
||
| The [kv-ir background section](../design-kv-ir-streams/background.md) contains partial background | ||
| information about clp-s. | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: | ||
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,40 @@ | ||
| # clp-s | ||
|
|
||
| The compressed-log-processor-structured (abbreviated as clp-s and also known as [μSlope][μSlope]) | ||
| archive format is a storage format for large chunks of dynamically structured (e.g., JSON) logs. | ||
|
gibber9809 marked this conversation as resolved.
Outdated
|
||
| Compared to the [KV-IR](../design-kv-ir-streams/index.md) streaming compression format clp-s | ||
|
gibber9809 marked this conversation as resolved.
Outdated
|
||
| achieves higher compression ratios and significantly faster search speeds at the cost of needing to | ||
| aggregate log data before compressing the data into archives and requiring memory proportional to | ||
| archive size for both compression and search. This makes clp-s unsuitable for real-time or severely | ||
| resource-constrained usage but ideal for long-term archival and search. | ||
|
gibber9809 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ::::{grid} 1 1 1 1 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} | ||
| :link: background | ||
| Background | ||
| ^^^ | ||
| Any necessary information to understand clp-s' format. | ||
|
gibber9809 marked this conversation as resolved.
Outdated
|
||
| ::: | ||
|
|
||
| :::{grid-item-card} | ||
| :link: single-file-archive-format | ||
| Single-file archive format | ||
| ^^^ | ||
| A detailed reference for the single-file archive format. | ||
| ::: | ||
| :::: | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: | ||
|
|
||
| :::{toctree} | ||
| :hidden: | ||
|
|
||
| background | ||
| single-file-archive-format | ||
| ::: | ||
|
|
||
| [μSlope]: https://www.usenix.org/conference/osdi24/presentation/wang-rui | ||
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.
Uh oh!
There was an error while loading. Please reload this page.