Skip to content

Conversation

@Sophie-Ag00001
Copy link
Collaborator

PR Description: Implement Health Check Endpoint for Node Types

Summary of Changes

This pull request introduces a health check endpoint across multiple node types within the network. The following changes have been made:

  1. Implemented the health_check function in handlers.rs.
  2. Updated routes.rs to add the .or(...) block for the health_check handler in the routing logic for each node type: User, Storage, Mempool, Miner, and Miner+User.

Motivation

The addition of a health check endpoint allows for better monitoring and stability of the network. It provides developers and operators insight into the operational status of various node types and improves overall system reliability.

Relevant Context

Health checks are vital in distributed systems to ensure that each component is functioning correctly. Integrating this endpoint across all node types enables centralized health monitoring and aids in troubleshooting potential issues.

Testing Instructions

To verify the implementation:

  1. Start the server.

  2. Send GET requests to the /health endpoint for each node type:

    • User: /health/user
    • Storage: /health/storage
    • Mempool: /health/mempool
    • Miner: /health/miner
    • Miner+User: /health/miner_user
  3. Ensure that the expected health check response is received from each endpoint.

Known Issues/Limitations

  • No known issues at this time. Please report any anomalies encountered during testing for further investigation.

We appreciate any feedback on this implementation to enhance the health monitoring capabilities of our network. Thank you!

2. In routes.rs, for each node type (User, Storage, Mempool, Miner, Miner+User):
   a. Add the provided .or(...) block with the health_check handler.
3. Test the /health route for each node type and verify the expected response. ONLY work on these files, no others
@Sophie-Ag00001 Sophie-Ag00001 requested a review from a team as a code owner January 9, 2025 10:14
@BHouwens BHouwens closed this Jan 9, 2025
@BHouwens BHouwens deleted the feature/add-provided-function-type branch January 9, 2025 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants