log: bump logrotate dep, switch to zstd compressor #9017

jharveyb · 2024-08-19T15:13:35Z

Change Description

Description of change / link to associated issue.

Similar change to btcsuite/btcd#2238 . Updates the log rotation dependency s.t. we can use ZSTD compression for logs instead of GZIP.

Steps to Test

Steps for reviewers to follow to test the change.

Run this build outside of itests.
Generate enough logs to cause log rotation.
Try to unzip the logs with any zstd CLI tool. The upstream implementation, https://github.com/facebook/zstd , is packaged for many distributions.

Pull Request Checklist

Testing

Your PR passes all CI checks.
Tests covering the positive and negative (error paths) are included.
Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
Commits follow the Ideal Git Commit Structure.
Any new logging statements use an appropriate subsystem and logging level.
Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

coderabbitai · 2024-08-19T15:13:46Z

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)

llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

jharveyb · 2024-08-19T15:29:00Z

Tested on a node running on testnet with debuglevel=trace, successfully decompressed the rotated logs. Compressed log size looks like ~3.8 MB, though that could differ depending on debug level.

guggero · 2024-08-19T15:45:36Z

build/logrotator.go

+		return fmt.Errorf("failed to create zstd compressor: %w", err)
+	}
+
+	r.logRotator.SetCompressor(c, "zst")


As mentioned offline: How widely available are tools like zgrep, zcat and zless that support this format in the main Unix variants?
Maybe it would make sense to allow users to configure this.

zutils (which provides zgrep and zcat) added zstd support in version 1.11 in January 2022:

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1009305

Which is in Debian Bookworm (current stable), as well as the backports repos for oldstable.

The zstd package is in the oldoldstable, oldstable, and stable repos. That provides equivalent commands like zstdgrep, zstdcat, and zstdless.

On my system (debian testing), zless is a shell script wrapper around less that only supports gzip. It seems like that command is compressor-specific, as there is also xzless (and zstdless).

Given that Debian normally lags other distros or package repos, I'd say it should be available on any system being kept reasonably up-to-date.

Maybe it would make sense to allow users to configure this.

Fair, in that case we could leave the default as GZIP but add ZSTD as an option. Given how well-distributed zstd is I don't see a large benefit but happy to add it as a config flag.

Darwin / macOS 14.6 zgrep, zless support .zst file inputs
zcat is unsupported

Worth noting that on Debian I had to install an explicit package zutils to get newer versions of these programs - not sure what the source package was for the older versions.

jharveyb · 2024-08-26T23:17:06Z

Performed testing similar to btcsuite/btcd#2238 (comment) , but only with CLI flags.

Invalid compressor names are rejected.
The gzip compressor is used if logcompressor is unset.
The rotated log file is searchable with zgrep in all valid cases (omitting the flag, specifying gzip, and specifying zstd).

lightninglabs-deploy · 2024-09-02T23:26:13Z

@guggero: review reminder
@jharveyb, remember to re-request review from reviewers when ready

guggero

Needs a change log entry for 0.19. Other than that looks pretty good, just a couple of suggestions.

config.go

build/logrotator.go

build/log.go

guggero

tACK, LGTM 🎉

build/log.go

build/logrotator.go

yyforyongyu

Think it's missing a release note since there's a new config option introduced, otherwise LGTM🦾

jharveyb · 2024-09-12T16:31:31Z

Rebased + added release note, should be g2g.

yyforyongyu

LGTM🫡

guggero reviewed Aug 19, 2024

View reviewed changes

jharveyb force-pushed the log_comress_zstd branch from 902ca80 to 66f4b3c Compare August 26, 2024 23:15

guggero self-requested a review August 27, 2024 09:06

jharveyb marked this pull request as ready for review August 27, 2024 18:23

guggero reviewed Sep 9, 2024

View reviewed changes

config.go Outdated Show resolved Hide resolved

build/logrotator.go Show resolved Hide resolved

build/log.go Outdated Show resolved Hide resolved

jharveyb force-pushed the log_comress_zstd branch from 66f4b3c to 418f27c Compare September 11, 2024 16:41

guggero approved these changes Sep 12, 2024

View reviewed changes

build/log.go Outdated Show resolved Hide resolved

build/logrotator.go Outdated Show resolved Hide resolved

yyforyongyu reviewed Sep 12, 2024

View reviewed changes

jharveyb force-pushed the log_comress_zstd branch from 418f27c to e3ca662 Compare September 12, 2024 15:27

jharveyb added 4 commits September 12, 2024 12:31

lnd+build: add logcompressor flag

f360532

mod: bump logrotate to v1.1.2

2f71822

build+mod: add zstd compressor support

b3c2516

docs: add release notes

0a451b6

jharveyb force-pushed the log_comress_zstd branch from 3b70b9e to 0a451b6 Compare September 12, 2024 16:31

jharveyb requested a review from yyforyongyu September 12, 2024 16:31

yyforyongyu approved these changes Sep 15, 2024

View reviewed changes

guggero added this to the v0.19.0 milestone Sep 15, 2024

guggero merged commit edd9ade into lightningnetwork:master Sep 15, 2024
27 of 33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

log: bump logrotate dep, switch to zstd compressor #9017

log: bump logrotate dep, switch to zstd compressor #9017

jharveyb commented Aug 19, 2024

coderabbitai bot commented Aug 19, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

jharveyb commented Aug 19, 2024

guggero Aug 19, 2024

jharveyb Aug 19, 2024 •

edited

Loading

dstadulis Aug 24, 2024

jharveyb Aug 26, 2024

jharveyb commented Aug 26, 2024

lightninglabs-deploy commented Sep 2, 2024

guggero left a comment

guggero left a comment

yyforyongyu left a comment

jharveyb commented Sep 12, 2024

yyforyongyu left a comment

log: bump logrotate dep, switch to zstd compressor #9017

log: bump logrotate dep, switch to zstd compressor #9017

Conversation

jharveyb commented Aug 19, 2024

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

coderabbitai bot commented Aug 19, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

jharveyb commented Aug 19, 2024

guggero Aug 19, 2024

Choose a reason for hiding this comment

jharveyb Aug 19, 2024 • edited Loading

Choose a reason for hiding this comment

dstadulis Aug 24, 2024

Choose a reason for hiding this comment

jharveyb Aug 26, 2024

Choose a reason for hiding this comment

jharveyb commented Aug 26, 2024

lightninglabs-deploy commented Sep 2, 2024

guggero left a comment

Choose a reason for hiding this comment

guggero left a comment

Choose a reason for hiding this comment

yyforyongyu left a comment

Choose a reason for hiding this comment

jharveyb commented Sep 12, 2024

yyforyongyu left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Aug 19, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

jharveyb Aug 19, 2024 •

edited

Loading