[OpAMP.Client] WebSocket Transport #3064

RassK · 2025-09-03T11:36:11Z

Changes

Adds WebSockets support for .NET.

Leaving TODO:

WebSockets for .NET Framework
WebSockets sending large packages (WsTransmitter.cs)
Certification handling

Merge requirement checklist

CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes

codecov · 2025-09-03T11:38:08Z

Codecov Report

❌ Patch coverage is 87.50000% with 21 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.83%. Comparing base (263129e) to head (747d220).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
....Client/Internal/Transport/WebSocket/WsReceiver.cs	83.07%	11 Missing ⚠️
...nTelemetry.OpAmp.Client/Internal/Utils/Varint64.cs	85.18%	4 Missing ⚠️
...OpAmp.Client/Internal/Utils/OpAmpWsHeaderHelper.cs	70.00%	3 Missing ⚠️
...nTelemetry.OpAmp.Client/Internal/FrameProcessor.cs	88.88%	1 Missing ⚠️
...ient/Internal/Transport/WebSocket/WsTransmitter.cs	92.85%	1 Missing ⚠️
...etry.OpAmp.Client/Internal/Utils/SequenceHelper.cs	90.90%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3064      +/-   ##
==========================================
+ Coverage   69.77%   69.83%   +0.06%     
==========================================
  Files         410      426      +16     
  Lines       16272    16491     +219     
==========================================
+ Hits        11354    11517     +163     
- Misses       4918     4974      +56

Flag	Coverage Δ
unittests-Contrib.Shared.Tests	`83.73% <ø> (ø)`
unittests-Exporter.Geneva	`53.33% <ø> (ø)`
unittests-Exporter.InfluxDB	`95.14% <ø> (ø)`
unittests-Exporter.Instana	`74.86% <ø> (ø)`
unittests-Exporter.OneCollector	`94.61% <ø> (ø)`
unittests-Extensions	`90.65% <ø> (ø)`
unittests-Extensions.Enrichment	`100.00% <ø> (ø)`
unittests-Extensions.Enrichment.AspNetCore	`94.11% <ø> (ø)`
unittests-Instrumentation.AWS	`83.80% <ø> (ø)`
unittests-Instrumentation.AspNet	`75.18% <ø> (+0.24%)`	⬆️
unittests-Instrumentation.AspNetCore	`70.76% <ø> (ø)`
unittests-Instrumentation.Cassandra	`23.52% <ø> (?)`
unittests-Instrumentation.ConfluentKafka	`14.10% <ø> (ø)`
unittests-Instrumentation.ElasticsearchClient	`80.12% <ø> (ø)`
unittests-Instrumentation.EntityFrameworkCore	`80.80% <ø> (ø)`
unittests-Instrumentation.EventCounters	`76.36% <ø> (ø)`
unittests-Instrumentation.GrpcCore	`91.42% <ø> (ø)`
unittests-Instrumentation.GrpcNetClient	`79.61% <ø> (ø)`
unittests-Instrumentation.Hangfire	`84.61% <ø> (ø)`
unittests-Instrumentation.Http	`74.18% <ø> (ø)`
unittests-Instrumentation.Owin	`88.62% <ø> (ø)`
unittests-Instrumentation.Process	`100.00% <ø> (ø)`
unittests-Instrumentation.Quartz	`78.76% <ø> (ø)`
unittests-Instrumentation.Runtime	`100.00% <ø> (ø)`
unittests-Instrumentation.ServiceFabricRemoting	`34.54% <ø> (ø)`
unittests-Instrumentation.SqlClient	`87.29% <ø> (ø)`
unittests-Instrumentation.StackExchangeRedis	`70.31% <ø> (ø)`
unittests-Instrumentation.Wcf	`78.95% <ø> (ø)`
unittests-OpAmp.Client	`73.93% <87.50%> (+12.85%)`	⬆️
unittests-PersistentStorage	`65.88% <ø> (+0.66%)`	⬆️
unittests-Resources.AWS	`74.42% <ø> (ø)`
unittests-Resources.Azure	`85.31% <ø> (ø)`
unittests-Resources.Container	`67.34% <ø> (ø)`
unittests-Resources.Gcp	`71.42% <ø> (ø)`
unittests-Resources.Host	`73.91% <ø> (ø)`
unittests-Resources.OperatingSystem	`76.98% <ø> (ø)`
unittests-Resources.Process	`100.00% <ø> (ø)`
unittests-Resources.ProcessRuntime	`79.59% <ø> (ø)`
unittests-Sampler.AWS	`88.25% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...Client/Internal/Transport/WebSocket/WsTransport.cs	`100.00% <100.00%> (ø)`
...metry.OpAmp.Client/Internal/Utils/BufferSegment.cs	`100.00% <100.00%> (ø)`
...nTelemetry.OpAmp.Client/Internal/FrameProcessor.cs	`83.05% <88.88%> (+1.05%)`	⬆️
...ient/Internal/Transport/WebSocket/WsTransmitter.cs	`92.85% <92.85%> (ø)`
...etry.OpAmp.Client/Internal/Utils/SequenceHelper.cs	`92.85% <90.90%> (+26.19%)`	⬆️
...OpAmp.Client/Internal/Utils/OpAmpWsHeaderHelper.cs	`70.00% <70.00%> (ø)`
...nTelemetry.OpAmp.Client/Internal/Utils/Varint64.cs	`85.18% <85.18%> (ø)`
....Client/Internal/Transport/WebSocket/WsReceiver.cs	`83.07% <83.07%> (ø)`

... and 12 files with indirect coverage changes

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

RassK · 2025-09-03T11:38:17Z

src/OpenTelemetry.OpAmp.Client/Internal/Transport/WebSocket/WsTransmitter.cs

+
+internal class WsTransmitter
+{
+    private const int BufferSize = 4096;


Need to choose realistic buffer size, anyone suggests what are the usuals?

4096 is common in things like Stream - you could benchmark to find if there's a better value.

May need to tune later then. Prob need to get full session up and have some stats based on different message sizes.
My theory is that the most common message size should be default. 4kB for small messages, maybe increase a new block size to 8kB if there are already 2-3 4kB blocks requested 🤔

RassK · 2025-09-03T11:38:41Z

src/OpenTelemetry.OpAmp.Client/Internal/Transport/WebSocket/WsReceiver.cs

+
+internal class WsReceiver : IDisposable
+{
+    private const int RentalBufferSize = 4096;


Need to choose realistic buffer size, anyone suggests what are the usuals?

test/OpenTelemetry.OpAmp.Client.Tests/Mocks/MockListener.cs

test/OpenTelemetry.OpAmp.Client.Tests/PlainHttpTransportTest.cs

test/OpenTelemetry.OpAmp.Client.Tests/SequenceHelperTests.cs

test/OpenTelemetry.OpAmp.Client.Tests/Tools/FrameGenerator.cs

test/OpenTelemetry.OpAmp.Client.Tests/Tools/OpAmpFakeWebSocketServer.cs

src/OpenTelemetry.OpAmp.Client/Internal/Transport/WebSocket/WsTransport.cs

martincostello · 2025-09-03T15:19:19Z

src/OpenTelemetry.OpAmp.Client/Internal/Transport/WebSocket/WsTransmitter.cs

+
+internal class WsTransmitter
+{
+    private const int BufferSize = 4096;


4096 is common in things like Stream - you could benchmark to find if there's a better value.

src/OpenTelemetry.OpAmp.Client/Internal/Transport/WebSocket/WsReceiver.cs

…Receiver.cs Co-authored-by: Martin Costello <[email protected]>

Co-authored-by: Martin Costello <[email protected]>

…per.cs Co-authored-by: Martin Costello <[email protected]>

src/OpenTelemetry.OpAmp.Client/Internal/Transport/WebSocket/WsReceiver.cs

src/OpenTelemetry.OpAmp.Client/Internal/Utils/SequenceHelper.cs

src/OpenTelemetry.OpAmp.Client/Internal/Utils/Varint64.cs

test/OpenTelemetry.OpAmp.Client.Tests/Tools/OpAmpFakeWebSocketServer.cs

test/OpenTelemetry.OpAmp.Client.Tests/WsTransportTest.cs

…Server.cs Co-authored-by: Martin Costello <[email protected]>

Co-authored-by: Martin Costello <[email protected]>

…Server.cs Co-authored-by: Martin Costello <[email protected]>

Kielek

Some NITs

src/OpenTelemetry.OpAmp.Client/Internal/Utils/Varint64.cs

test/OpenTelemetry.OpAmp.Client.Tests/Varint64Tests.cs

src/OpenTelemetry.OpAmp.Client/Internal/Utils/Varint64.cs

Co-authored-by: Martin Costello <[email protected]>

Kielek

LGTMRS

RassK added 2 commits September 3, 2025 02:33

Add WS transport

2a8eefc

fix sln

5dcec99

github-actions bot added the comp:opamp.client Things related to OpenTelemetry.OpAmp.Client label Sep 3, 2025

update changelog

b8b270c

RassK commented Sep 3, 2025

View reviewed changes

refactor and add large packages testing

4601198

RassK marked this pull request as ready for review September 3, 2025 14:05

RassK requested a review from a team as a code owner September 3, 2025 14:05

martincostello reviewed Sep 3, 2025

View reviewed changes

Update src/OpenTelemetry.OpAmp.Client/Internal/Transport/WebSocket/Ws…

68a3ecb

…Receiver.cs Co-authored-by: Martin Costello <[email protected]>

github-actions bot assigned RassK Sep 3, 2025

RassK and others added 17 commits September 3, 2025 19:09

Update src/OpenTelemetry.OpAmp.Client/Internal/Transport/WebSocket/Ws…

b560d56

…Receiver.cs Co-authored-by: Martin Costello <[email protected]>

seal classes

aa1dc96

add disposable support

9135941

adjusts language

a8802db

Update test/OpenTelemetry.OpAmp.Client.Tests/WsTransportTest.cs

91dbbd1

Co-authored-by: Martin Costello <[email protected]>

Update src/OpenTelemetry.OpAmp.Client/Internal/Utils/BufferSegment.cs

01543ce

Co-authored-by: Martin Costello <[email protected]>

Update src/OpenTelemetry.OpAmp.Client/Internal/Utils/OpAmpWsHeaderHel…

2cf56b6

…per.cs Co-authored-by: Martin Costello <[email protected]>

replace separator

7f1aaef

refactor magic numbers from varint64 helper

75e706a

refactor sertification validator

59d9314

fix no cancellation token

7bac1e7

fix cts token

6bd280a

optimize varint encode

2424809

refactor header decode

de41721

add single buffer test

10b4be0

fix test namings

a730f72

Merge branch 'main' into opamp-client-wstransport

457c32c

martincostello reviewed Sep 5, 2025

View reviewed changes

RassK and others added 9 commits September 8, 2025 11:51

add shortcut for a single buffer

4cc4f0e

add thread name

45f0616

fix ws receiver loop

9729ffd

improve varint64 encode

1e50ffc

Update test/OpenTelemetry.OpAmp.Client.Tests/Tools/OpAmpFakeWebSocket…

9d359df

…Server.cs Co-authored-by: Martin Costello <[email protected]>

Update test/OpenTelemetry.OpAmp.Client.Tests/WsTransportTest.cs

4dd9658

Co-authored-by: Martin Costello <[email protected]>

Merge branch 'main' into opamp-client-wstransport

d1c54ce

Update test/OpenTelemetry.OpAmp.Client.Tests/Tools/OpAmpFakeWebSocket…

57d7480

…Server.cs Co-authored-by: Martin Costello <[email protected]>

limit max message size

75042e7

martincostello approved these changes Sep 8, 2025

View reviewed changes

Kielek reviewed Sep 9, 2025

View reviewed changes

src/OpenTelemetry.OpAmp.Client/Internal/Utils/Varint64.cs Outdated Show resolved Hide resolved

test/OpenTelemetry.OpAmp.Client.Tests/Varint64Tests.cs Outdated Show resolved Hide resolved

test/OpenTelemetry.OpAmp.Client.Tests/Varint64Tests.cs Outdated Show resolved Hide resolved

RassK added 3 commits September 9, 2025 12:43

fix tests parameters language

73491d0

use binary literals

eadbb09

Merge branch 'main' into opamp-client-wstransport

295c1a1

martincostello approved these changes Sep 9, 2025

View reviewed changes

src/OpenTelemetry.OpAmp.Client/Internal/Utils/Varint64.cs Outdated Show resolved Hide resolved

Update src/OpenTelemetry.OpAmp.Client/Internal/Utils/Varint64.cs

d68874b

Co-authored-by: Martin Costello <[email protected]>

Kielek mentioned this pull request Sep 9, 2025

Codecov to long lines? #3089

Closed

Merge branch 'main' into opamp-client-wstransport

747d220

Kielek approved these changes Sep 9, 2025

View reviewed changes

Kielek merged commit 0fb8d71 into open-telemetry:main Sep 9, 2025
233 checks passed

RassK deleted the opamp-client-wstransport branch September 9, 2025 10:20

[OpAMP.Client] WebSocket Transport #3064

[OpAMP.Client] WebSocket Transport #3064

Uh oh!

Conversation

RassK commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Merge requirement checklist

Uh oh!

codecov bot commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

RassK Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

martincostello Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

RassK Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

RassK Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

martincostello Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kielek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kielek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

RassK commented Sep 3, 2025 •

edited

Loading

codecov bot commented Sep 3, 2025 •

edited

Loading