Detail LND's debug procedures. #9138

ziggie1984 · 2024-09-25T07:54:57Z

Update the logging description of LND (also include a small code change which returns all the logging levels of the subsystems when the logger is updated)
Describe LND's internal profiler so that people can easily provide profile dumps when needed.
Also create its own config for the profiler to make it more clean.
Add proper logging to the HTLCModifier.

coderabbitai · 2024-09-25T07:56:31Z

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.

ziggie1984 · 2024-09-25T08:23:10Z

cc @Liongrass

ziggie1984 · 2024-09-25T08:29:04Z

@coderabbitai review

coderabbitai · 2024-09-25T08:29:24Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

config.go

rpcserver.go

docs/debugging_lnd.md

saubyk

Ack

lightninglabs-deploy · 2024-10-17T15:38:11Z

@yyforyongyu: review reminder

docs/debugging_lnd.md

yyforyongyu · 2024-10-18T09:55:20Z

docs/debugging_lnd.md

+The subsystem names are case-sensitive and must be all uppercase.
+
+To identify the subsystems defined by an abbreviated name, you can search for 
+the abbrieviation in the [log.go](/log.go) file. Each subsystem 


I think we can just do lncli debuglevel --show instead - doesn't need to visit the file?

I described it because when I started, I really had no idea what the names really mean so I find it quite useful to mention how you can find the package which represent them.

docs/debugging_lnd.md

lncfg/pprof.go

lnd.go

Describe the basics of the LND profiler so that node runners can easily provide profile dumps to analyse faulty behaviour more quickly. Also update the description of LND's logging system.

During testing of this PR I figured out the the htlc interceptor was not shutdown and started properly in terms of closing the quit channel but also in terms of the relevant logs.

ziggie1984

Thanks a lot for this review @yyforyongyu ❤️

ziggie1984 · 2024-10-18T11:07:49Z

config.go

 	if !build.SuportedLogCompressor(cfg.LogCompressor) {
 		return nil, mkErr("invalid log compressor: %v",
 			cfg.LogCompressor)
 	}

 	// Initialize logging at the default logging level.
 	SetupLoggers(cfg.LogWriter, interceptor)
+


This is the fix, we need to first SetupLoggers, before we can print all the available ones.

We need to setup the loggers before we are able to show the complete list of available subsystems.

yyforyongyu

tACK, LGTM🦾

ziggie1984 added the no-changelog label Sep 25, 2024

ziggie1984 force-pushed the detail_debug_process branch from 869bfd0 to 7c6d487 Compare September 25, 2024 08:18

ziggie1984 marked this pull request as ready for review September 25, 2024 08:21

ziggie1984 force-pushed the detail_debug_process branch from 7c6d487 to a2e6057 Compare September 25, 2024 08:28

ziggie1984 force-pushed the detail_debug_process branch 2 times, most recently from b0ca0d3 to 956b0f1 Compare September 25, 2024 08:39

ziggie1984 added the no-itest label Sep 25, 2024

ziggie1984 requested a review from saubyk September 25, 2024 08:39

ziggie1984 force-pushed the detail_debug_process branch 4 times, most recently from 2618859 to 1ea9391 Compare September 25, 2024 13:54

ziggie1984 added the size/micro small bug fix or feature, less than 15 mins of review, less than 250 label Sep 25, 2024

ziggie1984 force-pushed the detail_debug_process branch 2 times, most recently from f17347f to 483a06b Compare September 25, 2024 14:17

ziggie1984 added this to the v0.19.0 milestone Sep 25, 2024

yyforyongyu requested changes Sep 26, 2024

View reviewed changes

config.go Show resolved Hide resolved

rpcserver.go Show resolved Hide resolved

docs/debugging_lnd.md Outdated Show resolved Hide resolved

ziggie1984 force-pushed the detail_debug_process branch 2 times, most recently from a4d50ff to ead2cea Compare September 26, 2024 08:54

ziggie1984 added bug fix docs and removed no-itest no-changelog labels Sep 26, 2024

ziggie1984 requested a review from yyforyongyu September 26, 2024 08:56

ziggie1984 force-pushed the detail_debug_process branch 2 times, most recently from 7999da4 to de6c5f2 Compare September 26, 2024 11:21

saubyk reviewed Oct 3, 2024

View reviewed changes

docs/debugging_lnd.md Show resolved Hide resolved

docs/debugging_lnd.md Outdated Show resolved Hide resolved

docs/debugging_lnd.md Outdated Show resolved Hide resolved

docs/debugging_lnd.md Outdated Show resolved Hide resolved

saubyk assigned ziggie1984 Oct 3, 2024

ziggie1984 force-pushed the detail_debug_process branch from de6c5f2 to 33406a0 Compare October 3, 2024 07:31

saubyk approved these changes Oct 3, 2024

View reviewed changes

yyforyongyu reviewed Oct 18, 2024

View reviewed changes

ziggie1984 added 4 commits October 18, 2024 13:03

rpc: return loglevels of the current subsystems

8d4d3e0

docs: Detail LND's debug possibilities

64c20ca

Describe the basics of the LND profiler so that node runners can easily provide profile dumps to analyse faulty behaviour more quickly. Also update the description of LND's logging system.

multi: separate profiler config

448193b

invoices: add proper startup for the interceptor

027de0a

During testing of this PR I figured out the the htlc interceptor was not shutdown and started properly in terms of closing the quit channel but also in terms of the relevant logs.

ziggie1984 force-pushed the detail_debug_process branch from 33406a0 to cbd9f10 Compare October 18, 2024 11:04

ziggie1984 commented Oct 18, 2024

View reviewed changes

ziggie1984 requested a review from yyforyongyu October 18, 2024 11:09

ziggie1984 added 2 commits October 18, 2024 13:11

lnd: fix debuglevel bug.

8bb79d1

We need to setup the loggers before we are able to show the complete list of available subsystems.

docs: add release notes.

f73504a

ziggie1984 force-pushed the detail_debug_process branch from cbd9f10 to f73504a Compare October 18, 2024 11:11

yyforyongyu approved these changes Oct 22, 2024

View reviewed changes

yyforyongyu merged commit caff5a0 into lightningnetwork:master Oct 22, 2024
29 of 34 checks passed

Detail LND's debug procedures. #9138

Detail LND's debug procedures. #9138

Uh oh!

Conversation

ziggie1984 commented Sep 25, 2024 • edited by saubyk Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Sep 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

ziggie1984 commented Sep 25, 2024

Uh oh!

ziggie1984 commented Sep 25, 2024

Uh oh!

coderabbitai bot commented Sep 25, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

saubyk left a comment

Choose a reason for hiding this comment

Uh oh!

lightninglabs-deploy commented Oct 17, 2024

Uh oh!

Uh oh!

yyforyongyu Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

ziggie1984 Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ziggie1984 left a comment

Choose a reason for hiding this comment

Uh oh!

ziggie1984 Oct 18, 2024

Choose a reason for hiding this comment

Uh oh!

yyforyongyu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ziggie1984 commented Sep 25, 2024 •

edited by saubyk

Loading

coderabbitai bot commented Sep 25, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)