Skip to content
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.

Sign up for GitHub

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

docs: Add log4j2-appenders repo to system overview. #638

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Add log4j2-appenders repo to system overview. #638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8763738
chore(docs): Add log4j2-appenders repo to the docs.
jackluo923 Dec 15, 2024
9ec2e27
Add lgo4j2 repo to the root README.md
jackluo923 Dec 18, 2024
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
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ features:
(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].
[Python][clp-loglib-py] and Java ([Log4j1][log4j1-appenders], [Log4j2][logj42-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].
jackluo923 marked this conversation as resolved.
Show resolved Hide resolved

- **[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
Expand Down Expand Up @@ -104,6 +104,7 @@ If you would like a feature or want to report a bug, please file an issue and we
[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
[log4j2-appenders]: https://github.com/y-scope/log4j2-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
Expand Down
15 changes: 8 additions & 7 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ features:
(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].
[Python][clp-loglib-py] and Java ([Log4j1][log4j1-appenders], [Log4j2][log4j2-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
Expand Down Expand Up @@ -113,6 +113,7 @@ dev-guide/index
[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
[log4j2-appenders]: https://github.com/y-scope/log4j2-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
Expand Down
Loading