Skip to content
Open
Show file tree
Hide file tree
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 May 29, 2025
f06a7b5
Fill out basic detail in SFA format section
gibber9809 Jun 2, 2025
c31407e
Draft header section docs
gibber9809 Jun 3, 2025
10e3bd2
Add headers for remainder of subsections
gibber9809 Jun 3, 2025
8c0921f
Add metadata section preamble
gibber9809 Jun 3, 2025
e93a22b
Write up ArchiveInfo and ArchiveFileInfo packets.
gibber9809 Jun 4, 2025
727f5b0
Add a figure describing the binary format of the timestamp dictionary
gibber9809 Jun 4, 2025
bd9774e
Add basic write-up for TimestampPattern packet
gibber9809 Jun 4, 2025
c6e19fd
Document the archive range index
gibber9809 Jun 5, 2025
975feb1
Small edit for consistency
gibber9809 Jun 5, 2025
abc7a29
Move up Figure 2 in doc
gibber9809 Jun 5, 2025
3229a3f
Address some rabbit comments
gibber9809 Jun 5, 2025
bd2a705
Apply suggestions from code review
gibber9809 Jun 16, 2025
3986176
Apply suggestions from code review
gibber9809 Jun 16, 2025
ffd31bb
Apply suggestions from code review
gibber9809 Jun 16, 2025
509c448
Address some more review comments
gibber9809 Jun 16, 2025
231bda4
Address more review comments
gibber9809 Jun 16, 2025
6b0c8fc
Fix sfa docs file formatting
gibber9809 Jun 16, 2025
3849efe
Rewrite header format with struct-like description
gibber9809 Jun 16, 2025
d5bebd6
Address more comments
gibber9809 Jun 17, 2025
87e0673
Merge remote-tracking branch 'upstream/main' into clp-s-sfa-format-doc
gibber9809 Jun 17, 2025
fe14725
Merge branch 'main' into clp-s-sfa-format-doc
gibber9809 Jun 25, 2025
cf6992c
Merge branch 'main' into clp-s-sfa-format-doc
gibber9809 Aug 21, 2025
b14e345
Merge branch 'main' into pr-961
kirkrodrigues Nov 12, 2025
088d483
Fixes after merging main.
kirkrodrigues Nov 12, 2025
c270b31
Merge branch 'main' into clp-s-sfa-format-doc
kirkrodrigues Nov 23, 2025
17b3621
Merge branch 'main' into clp-s-sfa-format-doc
gibber9809 Dec 10, 2025
e8b5cfe
Merge branch 'main' into clp-s-sfa-format-doc
kirkrodrigues Mar 2, 2026
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
8 changes: 8 additions & 0 deletions docs/src/dev-guide/design-clp-structured/background.md
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
Comment thread
gibber9809 marked this conversation as resolved.
Outdated
information about clp-s.

:::{warning}
🚧 This section is still under construction.
:::
40 changes: 40 additions & 0 deletions docs/src/dev-guide/design-clp-structured/index.md
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.
Comment thread
gibber9809 marked this conversation as resolved.
Outdated
Compared to the [KV-IR](../design-kv-ir-streams/index.md) streaming compression format clp-s
Comment thread
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.
Comment thread
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.
Comment thread
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
Loading