From 876373800f749cecb0a11272a5034c2cb851f1b0 Mon Sep 17 00:00:00 2001 From: Jack Luo Date: Mon, 16 Dec 2024 02:29:47 +0800 Subject: [PATCH 1/6] chore(docs): Add log4j2-appenders repo to the docs. --- docs/src/index.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index aa1e4e066..f54cd96e7 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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 @@ -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 From 9ec2e279bc5228e5fde959773c39c2307bf55c27 Mon Sep 17 00:00:00 2001 From: Jack Luo Date: Wed, 18 Dec 2024 16:13:39 +0800 Subject: [PATCH 2/6] Add lgo4j2 repo to the root README.md --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4a5c4a81d..82ec6a868 100644 --- a/README.md +++ b/README.md @@ -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]. - **[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 @@ -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 From 4fe8b110655e762e6b85355660162c1ade2e0298 Mon Sep 17 00:00:00 2001 From: Jack Luo Date: Sat, 11 Jan 2025 00:43:27 +0800 Subject: [PATCH 3/6] Add final refactor and reflow of README section. --- README.md | 13 +++++++------ docs/src/index.md | 11 ++++++----- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 82ec6a868..3ec90a3a9 100644 --- a/README.md +++ b/README.md @@ -44,12 +44,13 @@ features: - **Real-time Compression with CLP Logging Libraries**: CLP provides logging libraries for [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]. + [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 diff --git a/docs/src/index.md b/docs/src/index.md index f54cd96e7..2c63185c8 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -49,11 +49,12 @@ features: - **Real-time Compression with CLP Logging Libraries**: CLP provides logging libraries for [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]. + 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 From f8b984acb4e7f1994127b75d95293dfc8e82a5e9 Mon Sep 17 00:00:00 2001 From: Jack Luo Date: Sat, 11 Jan 2025 01:28:13 +0800 Subject: [PATCH 4/6] Update README.md Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ec90a3a9..9023e90f3 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ 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 ([Log4j1][log4j1-appenders], [Log4j2][logj42-appenders] and + [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 From 81a832cc77bffe1f3bf8be8e317fa331b892d02b Mon Sep 17 00:00:00 2001 From: Jack Luo Date: Sat, 11 Jan 2025 01:34:04 +0800 Subject: [PATCH 5/6] Update README.md Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9023e90f3..b40b3b38b 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,9 @@ features: - **Real-time Compression with CLP Logging Libraries**: CLP provides logging libraries for [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 + 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]. From 29d2fd9c6c639b0a2400d9be76d27a35ba46ddbb Mon Sep 17 00:00:00 2001 From: Jack Luo Date: Sat, 11 Jan 2025 01:34:11 +0800 Subject: [PATCH 6/6] Update docs/src/index.md Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> --- docs/src/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 2c63185c8..be8e355c9 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -49,9 +49,9 @@ features: - **Real-time Compression with CLP Logging Libraries**: CLP provides logging libraries for [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 + 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].