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

lnd/healthcheck: add checks after initialization + success/failure callbacks #8504

Merged
merged 4 commits into from
Mar 13, 2024
Merged

lnd/healthcheck: add checks after initialization + success/failure callbacks #8504

merged 4 commits into from
Mar 13, 2024

Conversation

calvinrzachman
Copy link
Contributor

@calvinrzachman calvinrzachman commented Feb 28, 2024 •
edited
Loading

Change Description

This PR expands the healthcheck package such that it can support:

  • the ability to specify callbacks to fire on success and reaching failure threshold.
  • the ability to dynamically add observations (health check routines) after initializing the monitor.

The idea is to use this in the payment service to health check a collection of lnd backends. Such an application would like to spin up health checks as backends come online and then take some action on health check success/failure beyond just exiting. If these changes are not desired here, then we can always write a custom health checking library which suits these needs.

This change should be transparent to existing users of the package. The callbacks default to no-ops and are configurable via functional option.

Steps to Test

Steps for reviewers to follow to test the change.

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 Feb 28, 2024 •
edited
Loading

Important

Auto Review Skipped

Auto reviews are limited to the following labels: llm-review. Please add one of these labels to enable auto reviews.

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.

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

guggero
guggero reviewed Feb 28, 2024
View reviewed changes
Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Looks really good, nice work!
Mostly nits from my end.

healthcheck/healthcheck.go Show resolved Hide resolved
healthcheck/healthcheck.go Outdated Show resolved Hide resolved
healthcheck/healthcheck.go Outdated Show resolved Hide resolved
healthcheck/healthcheck.go Show resolved Hide resolved
healthcheck/healthcheck_test.go Show resolved Hide resolved
healthcheck/healthcheck_test.go Show resolved Hide resolved
@calvinrzachman calvinrzachman force-pushed the healthcheck branch 2 times, most recently from bcd1143 to ee1913f Compare February 28, 2024 17:34
guggero
guggero approved these changes Feb 29, 2024
View reviewed changes
Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Nice, LGTM 🎉

yyforyongyu
yyforyongyu reviewed Mar 11, 2024
View reviewed changes
Copy link
Member

@yyforyongyu yyforyongyu left a comment

Choose a reason for hiding this comment

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

Very nice! Just a few nits, pending a release notes and should be good to go!

healthcheck/healthcheck.go Show resolved Hide resolved
healthcheck/healthcheck_test.go Show resolved Hide resolved
healthcheck/healthcheck.go Show resolved Hide resolved
@calvinrzachman
lnd/healthcheck: add health checks dynamically
80c2ac8 
Allow health checks to be added to our monitor after
the initial startup.
@calvinrzachman
lnd/healthcheck: add healthcheck onSuccess/onFailure callbacks
6a3a2ee 
Allow package users to provide custom callback which will
execute whenever a healthcheck fails.

Allow package users to provide custom callback which will
execute whenever a healthcheck succeeds.
@calvinrzachman
lnd/healthcheck: add tests for callbacks and dynamic checks
39f94a1
@calvinrzachman
docs: release notes for healthcheck package changes
add2b29
@yyforyongyu yyforyongyu merged commit d9887f3 into lightningnetwork:master Mar 13, 2024
26 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@guggero guggero guggero approved these changes

@yyforyongyu yyforyongyu yyforyongyu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@calvinrzachman @guggero @yyforyongyu