Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.ConnectionType.get -> Op
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.ConnectionType.set -> void
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.Heartbeat.get -> OpenTelemetry.OpAmp.Client.Settings.HeartbeatSettings!
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.Heartbeat.set -> void
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.HttpClientFactory.get -> System.Func<System.Net.Http.HttpClient!>!
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.HttpClientFactory.set -> void
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.Identification.get -> OpenTelemetry.OpAmp.Client.Settings.IdentificationSettings!
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.Identification.set -> void
OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings.InstanceUid.get -> System.Guid
Expand Down
4 changes: 4 additions & 0 deletions src/OpenTelemetry.OpAmp.Client/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

* Add setting to configure the factory used to create `HttpClient` instances
used for the OpAMP Plain HTTP transport.
([#3589](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3589))

## 0.1.0-alpha.3

Released 2025-Nov-13
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,24 @@
using Google.Protobuf;
using OpenTelemetry.Internal;
using OpenTelemetry.OpAmp.Client.Internal.Utils;
using OpenTelemetry.OpAmp.Client.Settings;

namespace OpenTelemetry.OpAmp.Client.Internal.Transport.Http;

internal sealed class PlainHttpTransport : IOpAmpTransport, IDisposable
{
private readonly Uri uri;
private readonly HttpClient httpClient;
private readonly HttpClientHandler handler;
private readonly FrameProcessor processor;

public PlainHttpTransport(Uri serverUrl, FrameProcessor processor)
public PlainHttpTransport(OpAmpClientSettings settings, FrameProcessor processor)
{
Guard.ThrowIfNull(serverUrl, nameof(serverUrl));
Guard.ThrowIfNull(settings, nameof(settings));
Guard.ThrowIfNull(processor, nameof(processor));

this.uri = serverUrl;
this.uri = settings.ServerUrl;
this.processor = processor;
this.handler = new HttpClientHandler
{
// Trust all certificates
ServerCertificateCustomValidationCallback = (message, cert, chain, errors) => true,
};

this.httpClient = new HttpClient(this.handler);
this.httpClient = settings.HttpClientFactory();
}

public async Task SendAsync<T>(T message, CancellationToken token)
Expand Down Expand Up @@ -62,6 +56,5 @@ public async Task SendAsync<T>(T message, CancellationToken token)
public void Dispose()
{
this.httpClient?.Dispose();
this.handler?.Dispose();
}
}
2 changes: 1 addition & 1 deletion src/OpenTelemetry.OpAmp.Client/OpAmpClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ private static IOpAmpTransport ConstructTransport(OpAmpClientSettings settings,
return settings.ConnectionType switch
{
ConnectionType.WebSocket => new WsTransport(settings.ServerUrl, processor),
ConnectionType.Http => new PlainHttpTransport(settings.ServerUrl, processor),
ConnectionType.Http => new PlainHttpTransport(settings, processor),
_ => throw new NotSupportedException("Unsupported transport type"),
};
}
Expand Down
31 changes: 31 additions & 0 deletions src/OpenTelemetry.OpAmp.Client/Settings/OpAmpClientSettings.cs
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

#if NETFRAMEWORK
using System.Net.Http;
#endif

using OpenTelemetry.Internal;

namespace OpenTelemetry.OpAmp.Client.Settings;

/// <summary>
/// OpAMP client settings.
/// </summary>
public sealed class OpAmpClientSettings
{
private readonly Func<HttpClient> defaultHttpClientFactory = () => new HttpClient();

private Uri? serverUrl;

/// <summary>
Expand Down Expand Up @@ -91,4 +99,27 @@ public Uri ServerUrl
/// Gets or sets the heartbeat settings.
/// </summary>
public HeartbeatSettings Heartbeat { get; set; } = new();

/// <summary>
/// Gets or sets the factory function called to create the <see
/// cref="HttpClient"/> instance that will be used at runtime to
/// transmit OpAmp messages over HTTP. The returned instance will
/// be reused for all communication.
/// </summary>
/// <remarks>
/// Notes:
/// <list type="bullet">
/// <item>This is only invoked for the <see
/// cref="ConnectionType.Http"/> protocol.</item>
/// </list>
/// </remarks>
public Func<HttpClient> HttpClientFactory
{
get => field ?? this.defaultHttpClientFactory;
set
{
Guard.ThrowIfNull(value);
field = value;
}
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

#if NETFRAMEWORK
using System.Net.Http;
#endif

using OpenTelemetry.OpAmp.Client.Internal;
using OpenTelemetry.OpAmp.Client.Internal.Transport.Http;
using OpenTelemetry.OpAmp.Client.Settings;
using OpenTelemetry.OpAmp.Client.Tests.Mocks;
using OpenTelemetry.OpAmp.Client.Tests.Tools;
using Xunit;
Expand All @@ -19,12 +24,13 @@ public async Task PlainHttpTransport_SendReceiveCommunication(bool useSmallPacke
// Arrange
using var opAmpServer = new OpAmpFakeHttpServer(useSmallPackets);
var opAmpEndpoint = opAmpServer.Endpoint;
var settings = new OpAmpClientSettings { ServerUrl = opAmpEndpoint };

using var mockListener = new MockListener();
var frameProcessor = new FrameProcessor();
frameProcessor.Subscribe(mockListener);

var httpTransport = new PlainHttpTransport(opAmpEndpoint, frameProcessor);
var httpTransport = new PlainHttpTransport(settings, frameProcessor);

var mockFrame = FrameGenerator.GenerateMockAgentFrame(useSmallPackets);

Expand All @@ -42,4 +48,37 @@ public async Task PlainHttpTransport_SendReceiveCommunication(bool useSmallPacke
Assert.Single(clientReceivedFrames);
Assert.StartsWith("This is a mock server frame for testing purposes.", receivedTextData);
}

[Fact]
public async Task PlainHttpTransport_UsesConfiguredHttpClientFactory()
{
// Arrange
using var opAmpServer = new OpAmpFakeHttpServer(false);
var opAmpEndpoint = opAmpServer.Endpoint;
var settings = new OpAmpClientSettings
{
ServerUrl = opAmpEndpoint,
HttpClientFactory = () =>
{
var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Custom-Header", "CustomValue");
return client;
},
};

using var mockListener = new MockListener();
var frameProcessor = new FrameProcessor();
frameProcessor.Subscribe(mockListener);

var httpTransport = new PlainHttpTransport(settings, frameProcessor);

var mockFrame = FrameGenerator.GenerateMockAgentFrame(false);

// Act
await httpTransport.SendAsync(mockFrame.Frame, CancellationToken.None);

// Assert
var serverReceivedHeaders = opAmpServer.GetHeaders();
Assert.Contains(serverReceivedHeaders, headers => headers["X-Custom-Header"] == "CustomValue");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// SPDX-License-Identifier: Apache-2.0

using System.Collections.Concurrent;
using System.Collections.Specialized;
using System.Net;
using OpAmp.Proto.V1;
using OpenTelemetry.Tests;
Expand All @@ -12,6 +13,7 @@ internal class OpAmpFakeHttpServer : IDisposable
{
private readonly IDisposable httpServer;
private readonly BlockingCollection<AgentToServer> frames = [];
private readonly List<NameValueCollection> receivedHeaders = [];

public OpAmpFakeHttpServer(bool useSmallPackets)
{
Expand All @@ -21,6 +23,14 @@ public OpAmpFakeHttpServer(bool useSmallPackets)
var frame = ProcessReceive(context.Request);
this.frames.Add(frame);

var headersCopy = new NameValueCollection();
foreach (var key in context.Request.Headers.AllKeys)
{
headersCopy.Add(key, context.Request.Headers[key]);
}

this.receivedHeaders.Add(headersCopy);

var response = GenerateResponse(frame, useSmallPackets);

context.Response.StatusCode = (int)HttpStatusCode.OK;
Expand All @@ -40,6 +50,11 @@ public IReadOnlyCollection<AgentToServer> GetFrames()
return this.frames.ToArray();
}

public IReadOnlyList<NameValueCollection> GetHeaders()
{
return this.receivedHeaders.AsReadOnly();
}

public void Dispose()
{
this.httpServer.Dispose();
Expand Down