build+config: move file logger specific options to `logging.file` #9233

ellemouton · 2024-10-29T16:16:56Z

This PR:

moves the logcompressor option to logging.file.compressor (this is not a breaking change since the logcompressor option has not yet been included in a release.
adds logging.file.max-file-size and logging.file.max-files options and deprecates the old maxlogfiles and maxlogfilesize options. Both will work for the time being.

coderabbitai · 2024-10-29T16:17:06Z

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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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.

guggero

Very nice, LGTM 🎉

guggero · 2024-10-30T10:14:10Z

build/log.go

@@ -52,9 +52,9 @@ var logCompressors = map[string]string{
 	Zstd: "zst",
 }

-// SuportedLogCompressor returns whether or not logCompressor is a supported
+// supportedLogCompressor returns whether or not logCompressor is a supported


I think these will be used in other projects (e.g. tapd), so we shouldn't un-export them.

guggero · 2024-10-30T10:17:22Z

build/config.go

+
+	// DefaultMaxLogFiles is the default maximum number of log files to
+	// keep.
+	DefaultMaxLogFiles = 3


If we touch these, I also feel like it would be a good idea to slightly increase those numbers... Maybe 10 and 20 respectively? It just seems to happen often that users don't have what we need in their logs anymore. Or perhaps we could make it dependent on the log level? If they're running with DBG or higher, increase the numbers? That would probably be out of scope for this PR, just brain storming a bit here.

cool - updated the defaults in a commit at the end (just to keep this commit a refactor) :)

guggero · 2024-10-30T10:18:13Z

config.go

+
+		cfg.LogConfig.File.MaxLogFiles = cfg.MaxLogFiles
+	}
+	if cfg.MaxLogFileSize != build.DefaultMaxLogFileSize {


yyforyongyu

Nice refactor! Just a new nits and should be good to go.

build/config.go

yyforyongyu · 2024-10-30T10:36:30Z

build/config.go

+
+// FileLoggerConfig extends LoggerConfig with specific log file options.
+//
+//nolint:lll


can be removed now?

Wanted to comment the same when going through it commit by commit. But longer lines are added to it later, so I think it's still needed.

oh yeah lol 🙃 will re-add (in correct commit)

oh ok didn't notice that😂

sample-lnd.conf

yyforyongyu · 2024-10-30T10:39:41Z

config.go

@@ -315,8 +313,8 @@ type Config struct {
 	ReadMacPath     string        `long:"readonlymacaroonpath" description:"Path to write the read-only macaroon for lnd's RPC and REST services if it doesn't exist"`
 	InvoiceMacPath  string        `long:"invoicemacaroonpath" description:"Path to the invoice-only macaroon for lnd's RPC and REST services if it doesn't exist"`
 	LogDir          string        `long:"logdir" description:"Directory to log output."`
-	MaxLogFiles     int           `long:"maxlogfiles" description:"Maximum logfiles to keep (0 for no rotation)"`
-	MaxLogFileSize  int           `long:"maxlogfilesize" description:"Maximum logfile size in MB"`
+	MaxLogFiles     int           `long:"maxlogfiles" description:"Maximum logfiles to keep (0 for no rotation). DEPRECATED: use --logging.file.max-files instead"`


add hidden flag?

oh yeah good idea

to config_prod.go in preparation for adding a shared config.go file.

Move all shared code to config.go which has no build tags.

In preparation for extending LoggerConfig with file specific config.

ellemouton

Thanks for the quick reviews ya'll! 🌊

ellemouton · 2024-10-30T11:19:58Z

config.go

@@ -315,8 +313,8 @@ type Config struct {
 	ReadMacPath     string        `long:"readonlymacaroonpath" description:"Path to write the read-only macaroon for lnd's RPC and REST services if it doesn't exist"`
 	InvoiceMacPath  string        `long:"invoicemacaroonpath" description:"Path to the invoice-only macaroon for lnd's RPC and REST services if it doesn't exist"`
 	LogDir          string        `long:"logdir" description:"Directory to log output."`
-	MaxLogFiles     int           `long:"maxlogfiles" description:"Maximum logfiles to keep (0 for no rotation)"`
-	MaxLogFileSize  int           `long:"maxlogfilesize" description:"Maximum logfile size in MB"`
+	MaxLogFiles     int           `long:"maxlogfiles" description:"Maximum logfiles to keep (0 for no rotation). DEPRECATED: use --logging.file.max-files instead"`


oh yeah good idea

ellemouton · 2024-10-30T11:24:07Z

build/config.go

+
+	// DefaultMaxLogFiles is the default maximum number of log files to
+	// keep.
+	DefaultMaxLogFiles = 3


cool - updated the defaults in a commit at the end (just to keep this commit a refactor) :)

This is not a breaking change since the logcompressor config option has not been released yet.

Add deprecation notices but continue to read both.

yyforyongyu

LGTM⛵️

ellemouton · 2024-10-30T13:01:29Z

the race caught in the CI is unrelated and is fixed here

so i think we can override and merge @guggero ?

ellemouton force-pushed the moveLoggingCompressorOption branch 2 times, most recently from 6159f79 to 4f38b2c Compare October 29, 2024 16:27

ellemouton requested a review from guggero October 29, 2024 18:50

guggero approved these changes Oct 30, 2024

View reviewed changes

yyforyongyu reviewed Oct 30, 2024

View reviewed changes

ellemouton added 3 commits October 30, 2024 13:15

build: rename config.go file

4c5e565

to config_prod.go in preparation for adding a shared config.go file.

build: dedup logging config

0512357

Move all shared code to config.go which has no build tags.

build: extract File logging options into own struct

1886d38

In preparation for extending LoggerConfig with file specific config.

ellemouton force-pushed the moveLoggingCompressorOption branch from 4f38b2c to f1b900a Compare October 30, 2024 11:24

ellemouton commented Oct 30, 2024

View reviewed changes

ellemouton added 4 commits October 30, 2024 13:30

multi: move logcompressor to logging.file.compressor

3adbdbb

This is not a breaking change since the logcompressor config option has not been released yet.

build+config: move maxlogfiles and maxfilesize to logger config

22c1379

Add deprecation notices but continue to read both.

docs: add release notes

8106810

multi: update log file max num and size defaults

e547d21

ellemouton force-pushed the moveLoggingCompressorOption branch from f1b900a to e547d21 Compare October 30, 2024 11:30

yyforyongyu approved these changes Oct 30, 2024

View reviewed changes

guggero merged commit 684041b into lightningnetwork:master Oct 30, 2024
27 of 34 checks passed

ellemouton deleted the moveLoggingCompressorOption branch October 30, 2024 13:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build+config: move file logger specific options to `logging.file` #9233

build+config: move file logger specific options to `logging.file` #9233

ellemouton commented Oct 29, 2024

coderabbitai bot commented Oct 29, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

guggero left a comment

guggero Oct 30, 2024

guggero Oct 30, 2024

ellemouton Oct 30, 2024

guggero Oct 30, 2024

yyforyongyu left a comment

yyforyongyu Oct 30, 2024

guggero Oct 30, 2024

ellemouton Oct 30, 2024

yyforyongyu Oct 30, 2024

yyforyongyu Oct 30, 2024

ellemouton Oct 30, 2024

ellemouton left a comment

ellemouton Oct 30, 2024

ellemouton Oct 30, 2024

yyforyongyu left a comment

ellemouton commented Oct 30, 2024

build+config: move file logger specific options to logging.file #9233

build+config: move file logger specific options to logging.file #9233

Conversation

ellemouton commented Oct 29, 2024

coderabbitai bot commented Oct 29, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

guggero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yyforyongyu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ellemouton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yyforyongyu left a comment

Choose a reason for hiding this comment

ellemouton commented Oct 30, 2024

build+config: move file logger specific options to `logging.file` #9233

build+config: move file logger specific options to `logging.file` #9233

CodeRabbit Configuration File (`.coderabbit.yaml`)