build+lnd+docs: start using slog and add commit_hash to log lines by ellemouton · Pull Request #9314 · lightningnetwork/lnd

ellemouton · 2024-11-27T08:26:31Z

This PR does a few things:

adds a custom lll linter implementation that ignores log lines.
Adds documentation for structured log lines
adds an lll linter exception for log lines.
Adds a new --logging.build-info option which can be used to toggle if build info (currently only a commit hash fingerprint) should be included in log lines. NOTE: default is on for prod and off for dev. Keep this in mind when testing :)
updates the lnd Main function to add build info to its context & use structured logging for all its logs.

Example:

[INF] LTND: Network Info commit_hash=cf6617c8e9f7 active_chain=Bitcoin network=regtest
[INF] LTND: Waiting for chain backend to finish sync commit_hash=cf6617c8e9f7 start_height=473
[DBG] LTND: Syncing to block chain commit_hash=cf6617c8e9f7 best_block_time="2024-11-25 15:59:04 +0200 SAST" is_synced=false

coderabbitai · 2024-11-27T08:26:38Z

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.

ellemouton · 2024-11-28T08:05:02Z

damn - looks like the linter exclusion rule only works for single-line logs...

gonna see if i can write a linter plugin

guggero

Very nice! The age of structured logs has finally arrived 🚀

docs/code_formatting_rules.md

build/config.go

lnd.go

In this commit, we copy the implementation of the golangci-lint lll linter which we currently use in our CI flow during the `make lint` check. This commit copies the code mostly as is (the only exception being the line which trims white space before checking if a line starts with "import"), and formats it to fit our codebase guidelines. A test is also added so that we can be sure that the following commits which adjust the implementation have the intended results. The custom linter is put into its own module as this is requied by the `golangci-lint custom` when building the custom linter binary which includes the plugin.

This commit introduces the `LLPlugin` type and converts the existing lll code such that the LLPlugin implements the register.LinterPlugin interface. This will allow us to plug it into golangci-linter as a plugin.

ellemouton

Thanks @guggero 🙏

I've updated the PR with a custom lll linter implementation (let me know if you would prefer if I moved it to its own PR).

build/config.go

lnd.go

docs/code_formatting_rules.md

tools/linters/go.mod

tools/linters/ll.go

guggero

Two suggestions, otherwise LGTM 🎉

Super nice features 💯

tools/linters/ll.go

.golangci.yml

build/version.go

This commit adds a feature to our custom lll linter which will ignore log lines (both single and multi-lined log lines) for the lll linter.

Add this file both to the main LND directory so that devs can use it for local linter runs and also add it to the `tools` directory so that the docker environment used to run the linter in CI has access to it. A custom linter binary can be built via `golangci-lint custom`. This will pull in and register all the plugins listed in the new config file when building the new binary. The new binary can then be run using `custom-gcl run`.

Find and replace all nolint instances refering to the `lll` linter and replace with `ll` which is the name of our custom version of the `lll` linter which can be used to ignore log lines during linting. The next commit will do the configuration of the custom linter and disable the default one.

It can be disabled via the new `logging.no-commit-hash` config option.

lnd.go

bhandras

LGTM, very nice work! 🥇

ellemouton force-pushed the slog1 branch 2 times, most recently from 3d20b6a to aba4afd Compare November 27, 2024 08:45

guggero self-requested a review November 27, 2024 09:11

ellemouton force-pushed the slog1 branch 4 times, most recently from 7f5afd3 to 984988b Compare November 27, 2024 13:00

guggero reviewed Nov 28, 2024

View reviewed changes

docs/code_formatting_rules.md Show resolved Hide resolved

build/config.go Outdated Show resolved Hide resolved

lnd.go Show resolved Hide resolved

lnd.go Show resolved Hide resolved

lnd.go Outdated Show resolved Hide resolved

lnd.go Outdated Show resolved Hide resolved

ellemouton added 2 commits November 29, 2024 10:44

tools/linters: convert to LinterPlugin implementation

9637a81

This commit introduces the `LLPlugin` type and converts the existing lll code such that the LLPlugin implements the register.LinterPlugin interface. This will allow us to plug it into golangci-linter as a plugin.

ellemouton force-pushed the slog1 branch from 984988b to cac1988 Compare November 29, 2024 10:09

ellemouton commented Nov 29, 2024

View reviewed changes

build/config.go Outdated Show resolved Hide resolved

lnd.go Outdated Show resolved Hide resolved

lnd.go Show resolved Hide resolved

lnd.go Show resolved Hide resolved

docs/code_formatting_rules.md Show resolved Hide resolved

ellemouton force-pushed the slog1 branch from cac1988 to dabc7b6 Compare November 29, 2024 10:13

ellemouton requested a review from guggero November 29, 2024 10:25

ellemouton commented Nov 29, 2024

View reviewed changes

tools/linters/go.mod Show resolved Hide resolved

tools/linters/ll.go Show resolved Hide resolved

ellemouton self-assigned this Nov 29, 2024

ellemouton added logging Related to the logging / debug output functionality CI continuous integration docs labels Nov 29, 2024

guggero approved these changes Nov 29, 2024

View reviewed changes

tools/linters/ll.go Outdated Show resolved Hide resolved

.golangci.yml Outdated Show resolved Hide resolved

build/version.go Outdated Show resolved Hide resolved

ellemouton added 3 commits December 2, 2024 09:14

tools/linters: ignore log lines

bd55b27

This commit adds a feature to our custom lll linter which will ignore log lines (both single and multi-lined log lines) for the lll linter.

ellemouton force-pushed the slog1 branch from dabc7b6 to 6a8d225 Compare December 2, 2024 07:14

ellemouton added 4 commits December 2, 2024 09:23

.golangci: Replace lll with custom ll

c5d849e

lnd: pass ctx to rest proxy

a04f8df

docs: add structured logging docs in code formatting rules doc

efe08b8

build: Append commit hash to the main LND context

755ad49

It can be disabled via the new `logging.no-commit-hash` config option.

ellemouton added 4 commits December 2, 2024 09:23

lnd: use structured logs in mkErr helper

32fbea2

lnd: update Main logs to use structured logging

ed4279b

lnd: use errors.Is for error comparison

8862ce9

docs: add release note entry

afbb9aa

ellemouton force-pushed the slog1 branch from 6a8d225 to afbb9aa Compare December 2, 2024 07:23

ellemouton commented Dec 2, 2024

View reviewed changes

lnd.go Show resolved Hide resolved

bhandras approved these changes Dec 2, 2024

View reviewed changes

guggero merged commit 0474b4f into lightningnetwork:master Dec 2, 2024

ellemouton deleted the slog1 branch December 2, 2024 08:54

Conversation

ellemouton commented Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Nov 27, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

ellemouton commented Nov 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ellemouton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bhandras left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ellemouton commented Nov 27, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

ellemouton commented Nov 28, 2024 •

edited

Loading