Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixing newline on "Shutdown complete" log message modified: lnd.go #8770

Closed
wants to merge 1 commit into from
Closed

Fixing newline on "Shutdown complete" log message modified: lnd.go #8770

wants to merge 1 commit into from

Conversation

MPins
Copy link
Contributor

@MPins MPins commented May 20, 2024 •
edited
Loading

Fixes #8713

Change Description

Insert a blank line log message after the "Shutdown complete" log message to ensure that a new line is printed.

This is actually a workaround as the '\n' character was not working properly in some situations. See the tests I did at #8713.

You can reproduce the bug starting and stopping the LND using the "systemctl start lnd" and "systemctl stop lnd".

Steps to Test

The bug fix was tested on Ubuntu using systemctl start/stop lnd, as the bug only manifested this way.

Original Flaw

2024-05-20 14:04:17.705 [WRN] LTND: Config 'bitcoin.active' is deprecated, please remove it
2024-05-20 14:04:17.705 [INF] LTND: Version: 0.18.0-beta.rc2 commit=v0.18.0-beta.rc1-48-g2a8ca878f, build=development, logging=default, debuglevel=info
.
.
.
2024-05-20 14:05:01.948 [INF] LTND: Shutdown complete2024-05-20 14:05:19.906 [WRN] LTND: Config 'bitcoin.active' is deprecated, please remove it
2024-05-20 14:05:19.907 [INF] LTND: Version: 0.18.0-beta.rc2 commit=v0.18.0-beta.rc1-48-g2a8ca878f, build=development, logging=default, debuglevel=info

Test After the PR

2024-05-20 15:59:47.298 [WRN] LTND: Config 'bitcoin.active' is deprecated, please remove it
2024-05-20 15:59:47.298 [INF] LTND: Version: 0.18.0-beta.rc2 commit=v0.18.0-beta.rc1-48-g2a8ca878f-dirty, build=development, logging=default, debuglevel=info
.
.
.
2024-05-20 16:00:29.366 [INF] LTND: Shutdown complete
2024-05-20 16:00:29.366 [INF] LTND:
2024-05-20 16:00:47.594 [WRN] LTND: Config 'bitcoin.active' is deprecated, please remove it
2024-05-20 16:00:47.594 [INF] LTND: Version: 0.18.0-beta.rc2 commit=v0.18.0-beta.rc1-48-g2a8ca878f-dirty, build=development, logging=default, debuglevel=info

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

📝 Please see our Contribution Guidelines for further guidance.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 20, 2024 •
edited
Loading

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@MPins MPins changed the title Fixing newline in "Shutdown complete" log message modified: lnd.go Fixing newline on "Shutdown complete" log message modified: lnd.go May 20, 2024
@Abdulkbk
Copy link
Contributor

Abdulkbk commented May 21, 2024 •
edited
Loading

Hi @MPins thanks for the PR.

I've reviewed your work and it seems a new empty line is not added after the log "Shutdown complete" message. It was though before your PR as can be seen in the shots below:

Before
b4

After
after

Abdulkbk
Abdulkbk reviewed May 21, 2024
View reviewed changes
Copy link
Contributor

@Abdulkbk Abdulkbk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems this doesn't add a new blank line after the final log statement

@Chinwendu20
Copy link
Contributor

I think @C-Otto was right, this "\n" should not be needed at the end of the shutdown complete message anyway because it should be added by the logging library. I was not able to reproduce it but from your test it seems only to occur with systemd? Maybe we should figure out first if this is an lnd an issue and why exactly the new line does not work?

@MPins
Copy link
Contributor Author

MPins commented May 27, 2024 •
edited
Loading

Hello @Abdulkbk and @Chinwendu20 ... thank you for your comments ... you only see the bug on the log file and you have to start and stop LND using "systemctl start lnd" and "systemctl stop lnd commands.

You can see a lot of tests I did before and after the PR at #8713

@MPins
Copy link
Contributor Author

MPins commented Jun 6, 2024

@Abdulkbk and @Chinwendu20 ... you can see some tests I did before and after the PR at #8713 ... to simulate the bug you have to start and stop the LND using the "systemctl start lnd" and "systemctl stop lnd" ... then you repeat the tests after the PR and can verify the log file the bug is solved

@saubyk saubyk added this to the v0.18.1 milestone Jun 15, 2024
@MPins MPins mentioned this pull request Jun 22, 2024
Closed
@saubyk saubyk added logging Related to the logging / debug output functionality P3 might get fixed, nice to have labels Jun 25, 2024
@MPins MPins requested a review from Abdulkbk July 6, 2024 04:13
@MPins
lnd: Add a newline after "Shutdown complete" log message
fdcc823 
This is a workaround to force a newline after "Shutdown complete"
log message. The "\n" was not working when use the 'systemctl start lnd'
and 'system stop lnd' on linux (tested using Ubuntu)
@MPins MPins force-pushed the issue-8713 branch 2 times, most recently from 1e34f1e to fdcc823 Compare July 10, 2024 18:03
@saubyk saubyk requested review from ellemouton and removed request for Abdulkbk and ellemouton July 11, 2024 15:20
@saubyk saubyk removed this from the v0.18.3 milestone Jul 11, 2024
@lightninglabs-deploy
Copy link

@MPins, remember to re-request review from reviewers when ready

@MPins
Copy link
Contributor Author

MPins commented Sep 12, 2024

Hello @saubyk this PR should be closed as the #9083 solve the issue #8713 .

@MPins MPins closed this Sep 12, 2024
@guggero
Copy link
Collaborator

guggero commented Sep 12, 2024

Replaced by #9083.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Abdulkbk Abdulkbk Abdulkbk left review comments

Assignees

@MPins MPins

Labels
logging Related to the logging / debug output functionality P3 might get fixed, nice to have
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[bug]: Regression: Missing newline in "Shutdown complete" log message
6 participants
@MPins @Abdulkbk @Chinwendu20 @lightninglabs-deploy @guggero @saubyk