👁 Image
OpenTelemetry.OpAmp.Client 0.4.0-alpha.1

OpAMP Client for OpenTelemetry .NET

👁 NuGet version badge
👁 NuGet download count badge
👁 codecov.io

Steps to use OpenTelemetry.OpAmp.Client

Step 1: Install Package

Add a reference to the OpenTelemetry.OpAmp.Client package.

dotnet add package --prerelease OpenTelemetry.OpAmp.Client

Step 2: Create the OpAMP Client at application startup

using OpenTelemetry.OpAmp.Client;
using OpenTelemetry.OpAmp.Client.Settings;

using var client = new OpAmpClient(opts =>
{
 // Set up the OpAMP server connection.
 // Supported options are HTTP (polling) and WebSocket connection.
 opts.ServerUrl = new Uri("wss://localhost:4320/v1/opamp");
 opts.ConnectionType = ConnectionType.WebSocket;

 // Add custom resources to help the server identify your client.
 opts.Identification.AddIdentifyingAttribute("application.name", "my-application");
 opts.Identification.AddNonIdentifyingAttribute("application.version", "1.0.0");
});

// Start the client to send the identification message and get ready to receive messages.
await client.StartAsync();

// The client also supports StopAsync() for proper shutdown and to unregister from the server.
await client.StopAsync();

Security Considerations

Effective Configuration Reporting

When effective configuration reporting is enabled, file contents are read in full and transmitted verbatim to the OpAMP server. There is no automatic redaction.

• Use TLS: Configure ServerUrl with a wss:// or https:// scheme so that configuration data is encrypted in transit.
• Avoid sensitive files: Do not report files that contain secrets such as passwords, API tokens, or private keys unless you fully trust the OpAMP server and the network path to it.

Call StopAsync() before disposal when the client should unregister cleanly from the server. Dispose() performs synchronous, best-effort cleanup of services and transport resources, but it does not send the agent disconnect message.

References

• Open Agent Management Protocol