Skip to content

Conversation

@janhampe
Copy link

@janhampe janhampe commented Mar 15, 2025

This PR adds a ping functionality to the coordinator, allowing both regular automatic pings as well as manual pinging through coordinator_ctrl.
Its goal is to make detecting of failed endorsers safer and more convenient.
Also included is a test script to validate the function.
Changed benchmark scripts which seemed to be broken.

Blizzzard1234 and others added 30 commits November 3, 2024 18:28
- Removed __pycache__
- Added results
- Removed config.py
- Added cmake to shell.nix to compile endorser-openenclave
…running it, more difficult as we need to change a lot of paths in the instruction and also nix-shell is causing problems with PATH variables prob.
Dependencies for Azurite
MatheiANo and others added 25 commits January 31, 2025 14:05
@janhampe
Copy link
Author

@SirZayers please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

1. **Definitions**.
   **“Code”** means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   **“Project”** means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative ([www.opensource.org](http://www.opensource.org)).
   **“Submit”** is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   **“Submission”** means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.

2. **Your Submission**. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.

3. **Originality of Work**. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.

4. **Your Employer**. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.

5. **Licenses**.


* **Copyright License**. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.

* **Patent License**. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.

* **Other Rights Reserved**. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.


6. **Representations and Warranties**. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. **Notice to Microsoft**. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.

8. **Information about Submissions**. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.

9. **Governing Law/Jurisdiction**. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.

10. **Entire Agreement/Assignment**. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree

Copy link
Contributor

@sga001 sga001 left a comment

Choose a reason for hiding this comment

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

Leaving some comments.

},
_ => {},
}
let signature = self.private_key.sign(&nonce).unwrap();
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not safe. A malicious actor could abuse this method to trick the endorser into signing arbitrary data.

}

/// Pings the endorser with the given nonce.
async fn ping(&self, req: Request<PingReq>) -> Result<Response<PingResp>, Status> {
Copy link
Contributor

Choose a reason for hiding this comment

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

This public API is not safe.


#[test]
pub fn check_endorser_new_ledger_and_get_tail() {
pub fn check_endorser_new_ledger_and_greceiptet_tail() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure what's going on here.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a ping functionality to the coordinator that enables both automatic periodic pinging and manual pinging of endorsers through the coordinator_ctrl tool. The goal is to make detection of failed endorsers safer and more convenient. The PR also includes fixes to previously broken benchmark scripts and adds a test script for validating the ping functionality.

Key changes:

  • Implemented periodic health checking of endorsers via a ping mechanism with configurable intervals and failure thresholds
  • Added new gRPC endpoints (PingAllEndorsers, GetTimeoutMap, AddEndorsers) to both coordinator and endpoint services
  • Fixed benchmark scripts that were using incorrect tool names (wrk vs wrk2) and had issues with command quoting

Reviewed changes

Copilot reviewed 28 out of 30 changed files in this pull request and generated 21 comments.

Show a summary per file
File Description
proto/endorser.proto Added Ping RPC and related message types; reformatted existing messages
proto/coordinator.proto Added PingAllEndorsers, GetTimeoutMap, and AddEndorsers RPCs with message types
proto/endpoint.proto Added same three new RPCs to endpoint service
coordinator/src/coordinator_state.rs Implemented core ping logic with failure tracking, auto-scheduler, and timeout management
coordinator/src/main.rs Added gRPC and REST handlers for new ping endpoints; added CLI arguments for ping configuration
coordinator/src/errors.rs Added FailedToGetTimeoutMap error variant
coordinator/Cargo.toml Added dependencies for clokwerk scheduler, time, log, and async-lock
endorser/src/endorser_state.rs Implemented ping method that signs nonces; added documentation and test
endorser/src/main.rs Added ping RPC handler; fixed typo in error message
endpoint/src/lib.rs Added client methods for new coordinator APIs
endpoint/src/errors.rs Added error variants for new operations
endpoint_rest/src/main.rs Added REST handlers for new endpoints
coordinator_ctrl/src/main.rs Added CLI options for pinging and getting timeout map
experiments/*.py Updated benchmark scripts to use wrk2, added logging, fixed command quoting issues
experiments/*.lua Changed uuid library import from "uuid" to "uuidgen"
experiments/testing_ping.py New test script for validating ping functionality
runNNTBenchmark.sh New benchmark script for Hadoop NameNode throughput testing
experiments/HadoodBenchmarks.py New Python-based Hadoop benchmark using pydoop
README.md Added documentation for new ping-related command-line arguments
.github/workflows/rust_build.yml Added GitHub Actions workflow for Rust CI
.gitignore Added Python cache directory
.gitattributes Added line ending normalization
SUPPORT.md Whitespace formatting changes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.default_value("10"),
)
.arg(
Arg::with_name("ping_inverval")
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

The argument name "ping_inverval" is misspelled - it should be "ping_interval".

Suggested change
Arg::with_name("ping_inverval")
Arg::with_name("ping_interval")

Copilot uses AI. Check for mistakes.
LISTEN_IP_COORDINATOR = "127.0.0.1"
PORT_COORDINATOR = "8080"
PORT_COORDINATOR_CTRL = "8090" # control plane
PORT_COORDINATOR_CTRL = "8090" # control pane
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

The comment contains a typo. "control pane" should be "control plane".

Suggested change
PORT_COORDINATOR_CTRL = "8090" # control pane
PORT_COORDINATOR_CTRL = "8090" # control plane

Copilot uses AI. Check for mistakes.
Comment on lines +2638 to +2641
/// * `min_alive_percentage` - The minimum percentage of alive endorsers.
/// * `quorum_size` - The desired quorum size.
/// * `ping_interval` - The interval for pinging endorsers in seconds.
/// * `deactivate_auto_reconfig` - Whether to deactivate auto reconfiguration.
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

The function parameter documentation contains a typo. The parameter name is listed as "min_alive_percentage" and "quorum_size" but these parameters are not actually present in the function signature. The documentation should only list the actual parameters: max_failures, request_timeout, and ping_interval.

Suggested change
/// * `min_alive_percentage` - The minimum percentage of alive endorsers.
/// * `quorum_size` - The desired quorum size.
/// * `ping_interval` - The interval for pinging endorsers in seconds.
/// * `deactivate_auto_reconfig` - Whether to deactivate auto reconfiguration.
/// * `ping_interval` - The interval for pinging endorsers in seconds.

Copilot uses AI. Check for mistakes.
let dead_endorsers_count = DEAD_ENDORSERS.load(SeqCst);
println!("Debug: active_endorsers_count = {}", active_endorsers_count);
println!("Debug: dead_endorsers_count = {}", dead_endorsers_count);
alive_endorser_percentage = 100 - ((dead_endorsers_count * 100) / active_endorsers_count);
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

The calculation for alive_endorser_percentage has a potential division by zero issue if active_endorsers_count is 0. This should be checked before performing the division.

Suggested change
alive_endorser_percentage = 100 - ((dead_endorsers_count * 100) / active_endorsers_count);
if active_endorsers_count > 0 {
alive_endorser_percentage =
100 - ((dead_endorsers_count * 100) / active_endorsers_count);
} else {
// No active endorsers; avoid division by zero and treat as 0% alive.
alive_endorser_percentage = 0;
}

Copilot uses AI. Check for mistakes.
_request: Request<PingAllReq>, // Accept the gRPC request
) -> Result<Response<PingAllResp>, Status> {
// Call the state method to perform the ping task (no return value)
println!("Pining all endorsers now from main.rs");
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

There's a typo in the comment. "Pining" should be "Pinging".

Suggested change
println!("Pining all endorsers now from main.rs");
println!("Pinging all endorsers now from main.rs");

Copilot uses AI. Check for mistakes.
#[derive(Debug, Serialize, Deserialize)]
struct GetTimeoutMapResp {
#[serde(rename = "timeout_map")]
pub timeout_map: HashMap<String, u64>,
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

The timeout_map field uses a redundant name pattern. Since it's already in GetTimeoutMapResp, the field could be simply named "map" or "timeouts" rather than "timeout_map".

Suggested change
pub timeout_map: HashMap<String, u64>,
pub timeouts: HashMap<String, u64>,

Copilot uses AI. Check for mistakes.
import subprocess
import logging
from datetime import datetime
from setup_nodes import *
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

Import pollutes the enclosing namespace, as the imported module setup_nodes does not define 'all'.

Suggested change
from setup_nodes import *
import time
from setup_nodes import setup_output_folder, teardown, setup, ssh_cmd, collect_results

Copilot uses AI. Check for mistakes.
import logging
from datetime import datetime
from setup_nodes import *
from config import * # Assuming your configuration is correctly set up
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

Import pollutes the enclosing namespace, as the imported module config does not define 'all'.

Copilot uses AI. Check for mistakes.
import subprocess
import logging
from datetime import datetime
from setup_nodes import *
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

Import pollutes the enclosing namespace, as the imported module setup_nodes does not define 'all'.

Copilot uses AI. Check for mistakes.
import logging
from datetime import datetime
from setup_nodes import *
from config import *
Copy link

Copilot AI Dec 21, 2025

Choose a reason for hiding this comment

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

Import pollutes the enclosing namespace, as the imported module config does not define 'all'.

Copilot uses AI. Check for mistakes.
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.

7 participants