[HFT Benchmark]: Add benchmark suite for Countersyncd #4016

Janetxxx · 2025-11-23T23:40:44Z

What I did

Why I did it

How I verified it

Details if related

Signed-off-by: Janet Cui <[email protected]>

mssonicbld · 2025-11-23T23:40:53Z

/azp run

azure-pipelines · 2025-11-23T23:41:02Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull request overview

This PR adds OpenTelemetry metrics export functionality and a comprehensive benchmark suite to Countersyncd. The implementation enables SAI statistics to be converted to OpenTelemetry gauge formats and exported to OTLP collectors, along with extensive performance benchmarking capabilities to validate the HFT (High-Frequency Trading) requirements.

Key Changes:

New OpenTelemetry message types and conversion pipeline (SAI → OTel → Protobuf)
OtelActor for handling metric export with configurable console output and collector endpoints
Comprehensive benchmark suite covering message conversions, actor throughput, IPFIX parsing, export performance, memory efficiency, and end-to-end pipelines
CLI integration with optional OTel export flags and channel capacity configuration

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`crates/countersyncd/src/message/otel.rs`	Defines OpenTelemetry data structures and conversion logic from SAI statistics
`crates/countersyncd/src/actor/otel.rs`	Implements OtelActor for metrics export with protobuf conversion and gRPC client
`crates/countersyncd/src/main.rs`	Integrates OTel export with CLI arguments and actor orchestration
`crates/countersyncd/benches/*.rs`	Five comprehensive benchmark suites covering all aspects of the pipeline
`crates/countersyncd/Cargo.toml`	Adds OpenTelemetry, gRPC, and benchmarking dependencies
`Cargo.toml`	Workspace-level dependency additions
`Cargo.lock`	Dependency resolution with version locks

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

Copilot · 2025-11-23T23:42:43Z

crates/countersyncd/benches/actor_throughput.rs

+
+        // Test Arc cloning cost
+        group.bench_with_input(
+            BenchmarkId::new("arc_cloning", format("{}stats", message_size)),


Missing exclamation mark in format macro call. Should be format! instead of format.

Suggested change

BenchmarkId::new("arc_cloning", format("{}stats", message_size)),

BenchmarkId::new("arc_cloning", format!("{}stats", message_size)),

Copilot · 2025-11-23T23:42:44Z

crates/countersyncd/src/actor/otel.rs

+pub struct OtelActor {
+    stats_receiver: Receiver<SAIStatsMessage>,
+    config: OtelActorConfig,
+    shutdown_notifier: Option<oneshot::Sender<()>>,


The client field lacks documentation. Consider adding a doc comment explaining that this is a reusable gRPC client for exporting metrics to the OTLP collector.

Suggested change

shutdown_notifier: Option<oneshot::Sender<()>>,

shutdown_notifier: Option<oneshot::Sender<()>>,

/// Reusable gRPC client for exporting metrics to the OTLP collector.

Copilot · 2025-11-23T23:42:44Z

crates/countersyncd/src/message/otel.rs

+        let observation_time_nano = 0u64; // 1970-01-01 00:00:00 UTC
+        let data_point = OtelDataPoint::from_sai_stat(&sai_stat, observation_time_nano);


The comment '1970-01-01 00:00:00 UTC' is misleading since this is in the test. Consider using a more meaningful test timestamp constant or clarifying this is intentionally epoch zero for testing.

Suggested change

let observation_time_nano = 0u64; // 1970-01-01 00:00:00 UTC

let data_point = OtelDataPoint::from_sai_stat(&sai_stat, observation_time_nano);

// Intentionally using epoch zero (1970-01-01 00:00:00 UTC) as test timestamp.

const TEST_OBSERVATION_TIME_NANO_EPOCH: u64 = 0;

let data_point = OtelDataPoint::from_sai_stat(&sai_stat, TEST_OBSERVATION_TIME_NANO_EPOCH);

Copilot · 2025-11-23T23:42:44Z

crates/countersyncd/src/message/otel.rs

+            counter: 5000,
+        };
+
+        let observation_time_nano = 0u64; // 1970-01-01 00:00:00 UTC


Same misleading comment as line 235. Consider defining a test constant like TEST_EPOCH_TIMESTAMP to make the intent clearer.

Copilot · 2025-11-23T23:42:45Z

crates/countersyncd/src/actor/otel.rs

+        }
+    }
+
+    pub fn print_conversion_report(sai_stats: &SAIStats, otel_metrics: &OtelMetrics) {


This function is declared as pub but is never called in the main code (only used in tests implicitly). Consider making it private or documenting its intended public use case.

Suggested change

pub fn print_conversion_report(sai_stats: &SAIStats, otel_metrics: &OtelMetrics) {

fn print_conversion_report(sai_stats: &SAIStats, otel_metrics: &OtelMetrics) {

Copilot · 2025-11-23T23:42:45Z

crates/countersyncd/src/main.rs

+    /// Enable OpenTelemetry console output
+    #[arg(
+        long,
+        default_value = "true",


[nitpick] Default value for otel_console is 'true', which means console output is enabled by default when OTel is enabled. This could generate excessive log output in production. Consider defaulting to 'false' for production readiness.

Suggested change

default_value = "true",

default_value = "false",

prsunny · 2025-11-24T22:58:08Z

@Janetxxx , please fix the description per template and give details of the change

mssonicbld · 2025-11-25T12:47:19Z

/azp run

azure-pipelines · 2025-11-25T12:47:29Z

Azure Pipelines successfully started running 1 pipeline(s).

Janetxxx added 8 commits November 10, 2025 08:34

add OTEL actor

ae2af08

Signed-off-by: Janet Cui <[email protected]>

test CLA Auth

e5e2a1a

Signed-off-by: Janet Cui <[email protected]>

update otel dependencies

666fd23

Signed-off-by: Janet Cui <[email protected]>

update observation timestamp

c9d168c

Signed-off-by: Janet Cui <[email protected]>

remove println

ed4d815

Signed-off-by: Janet Cui <[email protected]>

upload cargo.lock and use log

b9d7cc3

Signed-off-by: Janet Cui <[email protected]>

Fix OTel tests and optimize otel actor, add cargo.lock

e7276ca

Signed-off-by: Janet Cui <[email protected]>

Add comprehensive benchmark suite for countersyncd

b95e736

Signed-off-by: Janet Cui <[email protected]>

Janetxxx requested a review from prsunny as a code owner November 23, 2025 23:40

Copilot AI review requested due to automatic review settings November 23, 2025 23:40

Copilot started reviewing on behalf of Janetxxx November 23, 2025 23:41 View session

Copilot finished reviewing on behalf of Janetxxx November 23, 2025 23:41

Copilot AI reviewed Nov 23, 2025

View reviewed changes

prsunny requested a review from Pterosaur November 24, 2025 22:57

Janetxxx marked this pull request as draft November 24, 2025 23:16

Merge branch 'master' into dev/jc/hft-benchmark

5da59fc

	BenchmarkId::new("arc_cloning", format("{}stats", message_size)),
	BenchmarkId::new("arc_cloning", format!("{}stats", message_size)),

	shutdown_notifier: Option<oneshot::Sender<()>>,
	shutdown_notifier: Option<oneshot::Sender<()>>,
	/// Reusable gRPC client for exporting metrics to the OTLP collector.

		let observation_time_nano = 0u64; // 1970-01-01 00:00:00 UTC
		let data_point = OtelDataPoint::from_sai_stat(&sai_stat, observation_time_nano);

-        let observation_time_nano = 0u64; // 1970-01-01 00:00:00 UTC
-        let data_point = OtelDataPoint::from_sai_stat(&sai_stat, observation_time_nano);
+        // Intentionally using epoch zero (1970-01-01 00:00:00 UTC) as test timestamp.
+        const TEST_OBSERVATION_TIME_NANO_EPOCH: u64 = 0;
+        let data_point = OtelDataPoint::from_sai_stat(&sai_stat, TEST_OBSERVATION_TIME_NANO_EPOCH);

	pub fn print_conversion_report(sai_stats: &SAIStats, otel_metrics: &OtelMetrics) {
	fn print_conversion_report(sai_stats: &SAIStats, otel_metrics: &OtelMetrics) {

[HFT Benchmark]: Add benchmark suite for Countersyncd #4016

Are you sure you want to change the base?

[HFT Benchmark]: Add benchmark suite for Countersyncd #4016

Uh oh!

Conversation

Janetxxx commented Nov 23, 2025

Uh oh!

mssonicbld commented Nov 23, 2025

Uh oh!

azure-pipelines bot commented Nov 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

prsunny commented Nov 24, 2025

Uh oh!

mssonicbld commented Nov 25, 2025

Uh oh!

azure-pipelines bot commented Nov 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants