Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/y-scope/clp
Compressed Log Processor (CLP) is a free log management tool capable of compressing text logs and searching the compressed logs without decompression.
https://github.com/y-scope/clp
analytics compression log-management log-parser logging search
Last synced: about 2 months ago
JSON representation
Compressed Log Processor (CLP) is a free log management tool capable of compressing text logs and searching the compressed logs without decompression.
- Host: GitHub
- URL: https://github.com/y-scope/clp
- Owner: y-scope
- License: apache-2.0
- Created: 2021-05-31T08:35:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T01:38:06.000Z (7 months ago)
- Last Synced: 2024-05-28T02:32:02.120Z (7 months ago)
- Topics: analytics, compression, log-management, log-parser, logging, search
- Language: C++
- Homepage: https://yscope.com
- Size: 2.84 MB
- Stars: 726
- Watchers: 16
- Forks: 60
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/y-scope/clp/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
[](https://github.com/y-scope/clp/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
[](https://yscope-clp.zulipchat.com/)
YScope's Compressed Log Processor (CLP) compresses your logs, and allows you to search the
compressed logs without decompression. CLP supports both JSON logs and unstructured (i.e., free
text) logs. It also supports real-time log compression within several logging libraries. CLP also
includes purpose-built web interfaces for searching and viewing the compressed logs. To learn more
about it, read our [2021 paper][clp-paper-21] about handling unstructured logs and our
[2024 paper][clp-paper-24] on extending it to JSON logs.
# Benchmarks
The figures above show CLP's compression and search performance compared to other tools. We separate
the experiments between JSON and unstructured logs because (1) some tools can only handle one type
of logs, and (2) tools that can handle both types often have different designs for each type (such
as CLP).
Compression ratio is measured as the average across a variety of log datasets. Some of these
datasets can be found [here][datasets]. Search performance is measured using queries on the
MongoDB logs (for JSON) and the Hadoop logs (for unstructured logs). Note that CLP uses an
index-less design, so for a fair comparison, we disabled MongoDB and PostgreSQL's indexes; If we
left them enabled, MongoDB and PostgreSQL's compression ratio would be worse. We didn't disable
indexing for Elasticsearch or Splunk since these tools are fundamentally index-based (i.e., logs
cannot be searched without indexes). More details about our experimental methodology can be found in
the [2021 paper][clp-paper-21] and the [2024 paper][clp-paper-24].
# System Overview
CLP provides an end-to-end log management pipeline consisting of compression, search, analytics, and
viewing. The figure above shows the CLP ecosystem architecture. It consists of the following
features:
- **Compression and Search**: CLP compresses logs into archives, which can be searched and analyzed
in a [web UI](components/webui). The input can either be raw logs or CLP's compressed IR
(intermediate representation) produced by CLP's logging libraries.
- **Real-time Compression with CLP Logging Libraries**: CLP provides logging libraries for
[Python][clp-loglib-py] and Java ([Log4j][log4j1-appenders] and [Logback][logback-appenders]). The
logging libraries compress logs in real-time, so only compressed logs are written to disk or
transmitted over the network. The compressed logs use CLP's intermediate representation (IR)
format which achieves a higher compression ratio than general purpose compressors like Zstandard.
Compressing IR into archives can further double the compression ratio and enable global search,
but this requires more memory usage as it needs to buffer enough logs. More details on IR versus
archives can be found in this [Uber Engineering Blog][uber-blog].
- **[Log Viewer][log-viewer]**: the compressed IR can be viewed in a web-based log viewer. Compared
to viewing the logs in an editor, CLP's log viewer supports advanced features like filtering logs
based on log level verbosity (e.g., only displaying logs with log level equal or higher than
ERROR). These features are possible because CLP's logging libraries parse the logs before
compressing them into IR.
- **IR Analytics Libraries**: we also provide a [Python library][clp-ffi-py] and a
[Go library][clp-ffi-go] that can analyze compressed IR.
- **[Log parser][log-surgeon]**: CLP also includes a custom pushdown-automata-based log parser that
is 3x faster than state-of-the-art regular expression engines like [RE2][re2]. The log parser is
available as a library that can be used by other applications.
# Getting Started
You can download a [release package](https://github.com/y-scope/clp/releases) which includes support
for distributed compression and search. Or, to quickly try CLP's *core* compression and search, you
can use a [prebuilt container][core-container].
We also have guides for building the [package][build-package] and [CLP core][core] from source.
For some logs you can use to test CLP, check out our open-source [datasets][datasets].
# Docs
You can find our docs [online][clp-docs] or view the source in `docs/src`.
# Providing Feedback
You can use GitHub issues to [report a bug][bug-report] or [request a feature][feature-req].
Join us on [Zulip][zulip] to chat with developers and other community members.
# Next Steps
This is our open-source release which we will be constantly updating with bug fixes, features, etc.
If you would like a feature or want to report a bug, please file an issue and we'll be happy to engage.
[bug-report]: https://github.com/y-scope/clp/issues/new?assignees=&labels=bug&template=bug-report.yml
[build-package]: http://docs.yscope.com/clp/main/dev-guide/building-package
[clp-docs]: https://docs.yscope.com/clp/main
[clp-ffi-go]: https://github.com/y-scope/clp-ffi-go
[clp-ffi-py]: https://github.com/y-scope/clp-ffi-py
[clp-loglib-py]: https://github.com/y-scope/clp-loglib-py
[clp-paper-21]: https://www.usenix.org/system/files/osdi21-rodrigues.pdf
[clp-paper-24]: https://www.usenix.org/system/files/osdi24-wang-rui.pdf
[core]: http://docs.yscope.com/clp/main/dev-guide/components-core
[core-container]: http://docs.yscope.com/clp/main/user-guide/core-container
[datasets]: https://docs.yscope.com/clp/main/user-guide/resources-datasets
[feature-req]: https://github.com/y-scope/clp/issues/new?assignees=&labels=enhancement&template=feature-request.yml
[log-surgeon]: https://github.com/y-scope/log-surgeon
[log-viewer]: https://github.com/y-scope/yscope-log-viewer
[log4j1-appenders]: https://github.com/y-scope/log4j1-appenders
[logback-appenders]: https://github.com/y-scope/logback-appenders
[re2]: https://github.com/google/re2
[uber-blog]: https://www.uber.com/en-US/blog/reducing-logging-cost-by-two-orders-of-magnitude-using-clp
[zulip]: https://yscope-clp.zulipchat.com/