[OpAMP] Expose public RemoteConfigMessage

src/OpenTelemetry.OpAmp.Client/.publicApi/PublicAPI.Unshipped.txt

@@ -1,7 +1,19 @@
 OpenTelemetry.OpAmp.Client.Listeners.IOpAmpListener<TMessage>
 OpenTelemetry.OpAmp.Client.Listeners.IOpAmpListener<TMessage>.HandleMessage(TMessage! message) -> void
+OpenTelemetry.OpAmp.Client.Messages.AgentConfigFile
+OpenTelemetry.OpAmp.Client.Messages.AgentConfigFile.BodyLength.get -> int
+OpenTelemetry.OpAmp.Client.Messages.AgentConfigFile.ContentType.get -> string?
+OpenTelemetry.OpAmp.Client.Messages.AgentConfigFile.GetBodyBytes() -> byte[]!
+OpenTelemetry.OpAmp.Client.Messages.AgentConfigFile.Name.get -> string!
+OpenTelemetry.OpAmp.Client.Messages.AgentConfigFile.TryGetBody(System.Span<byte> destination, out int bytesWritten) -> bool
 OpenTelemetry.OpAmp.Client.Messages.OpAmpMessage
 OpenTelemetry.OpAmp.Client.Messages.OpAmpMessage.OpAmpMessage() -> void
+OpenTelemetry.OpAmp.Client.Messages.RemoteConfigMessage
+OpenTelemetry.OpAmp.Client.Messages.RemoteConfigMessage.AgentConfigMap.get -> System.Collections.Generic.IReadOnlyDictionary<string!, OpenTelemetry.OpAmp.Client.Messages.AgentConfigFile!>!
+OpenTelemetry.OpAmp.Client.Messages.RemoteConfigMessage.GetConfigHashBytes() -> byte[]!
+OpenTelemetry.OpAmp.Client.Messages.RemoteConfigMessage.GetConfigHashUtf8String() -> string!
+OpenTelemetry.OpAmp.Client.Messages.RemoteConfigMessage.HashLength.get -> int
+OpenTelemetry.OpAmp.Client.Messages.RemoteConfigMessage.TryGetConfigHash(System.Span<byte> destination, out int bytesWritten) -> bool
 OpenTelemetry.OpAmp.Client.OpAmpClient
 OpenTelemetry.OpAmp.Client.OpAmpClient.Dispose() -> void
 OpenTelemetry.OpAmp.Client.OpAmpClient.OpAmpClient(System.Action<OpenTelemetry.OpAmp.Client.Settings.OpAmpClientSettings!>? configure = null) -> void

src/OpenTelemetry.OpAmp.Client/CHANGELOG.md

@@ -5,11 +5,16 @@
 * 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))
+
 * Add support for subscribing and unsubscribing to messages from the OpAMP server.
   ([#3593](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3593))
+
 * Clean up directories and namespaces for public API.
   ([#3612](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3612))
 
+* Expose public `RemoteConfigMessage`.
+  ([#3614](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/3614))
+
 ## 0.1.0-alpha.3
 
 Released 2025-Nov-13

src/OpenTelemetry.OpAmp.Client/Messages/RemoteConfiguration/AgentConfigFile.cs

@@ -0,0 +1,70 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+using Google.Protobuf;
+
+namespace OpenTelemetry.OpAmp.Client.Messages;
+
+/// <summary>
+/// Represents an agent configuration file.
+/// </summary>
+public class AgentConfigFile
+{
+    private readonly ByteString body;
+
+    internal AgentConfigFile(string name, global::OpAmp.Proto.V1.AgentConfigFile agentConfigFile)
+    {
+        this.body = agentConfigFile.Body ?? ByteString.Empty;
+        this.ContentType = agentConfigFile.ContentType;
+        this.Name = name;
+    }
+
+    /// <summary>
+    /// Gets the length, in bytes, of the configuration file body.
+    /// </summary>
+    public int BodyLength => this.body.Length;
+
+    /// <summary>
+    /// Gets the MIME Content-Type that describes the data contained in the body of the remote configuration file.
+    /// </summary>
+    public string? ContentType { get; }
+
+    /// <summary>
+    /// Gets the name of this configuration file.
+    /// </summary>
+    public string Name { get; }
+
+    /// <summary>
+    /// Returns the configuration file body as a byte array.
+    /// </summary>
+    /// <returns>A byte array containing the contents of the message body. The array is empty if the body has no content.</returns>
+    public byte[] GetBodyBytes() => this.body.ToByteArray() ?? [];
+
+    /// <summary>
+    /// Attempts to copy the configuration file body to the specified destination buffer.
+    /// </summary>
+    /// <remarks>If the body is empty, no data is written and the method returns <c>true</c> with <paramref name="bytesWritten"/> set to
+    /// 0. If the destination buffer is too small to hold the body content, no data is written, <paramref name="bytesWritten"/> is set to
+    /// 0, and the method returns <c>false</c>.</remarks>
+    /// <param name="destination">The buffer that receives the body bytes. Must be large enough to hold the entire body content.</param>
+    /// <param name="bytesWritten">When this method returns, contains the number of bytes successfully written to the destination buffer.</param>
+    /// <returns><c>true</c> if the body was successfully copied to the destination buffer or if the body is empty; otherwise, <c>false</c>.</returns>
+    public bool TryGetBody(Span<byte> destination, out int bytesWritten)
+    {
+        if (this.body.IsEmpty)
+        {
+            bytesWritten = 0;
+            return true;
+        }
+
+        if (destination.Length < this.body.Length)
+        {
+            bytesWritten = 0;
+            return false;
+        }
+
+        this.body.Span.CopyTo(destination);
+        bytesWritten = this.body.Length;
+        return true;
+    }
+}

src/OpenTelemetry.OpAmp.Client/Messages/RemoteConfiguration/RemoteConfigMessage.cs

@@ -0,0 +1,87 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+using Google.Protobuf;
+using OpAmp.Proto.V1;
+
+namespace OpenTelemetry.OpAmp.Client.Messages;
+
+/// <summary>
+/// Represents an OpAMP server-to-agent remote configuration message.
+/// </summary>
+public class RemoteConfigMessage : OpAmpMessage
+{
+    private readonly Dictionary<string, AgentConfigFile> agentConfigMap;
+    private readonly ByteString configHash;
+
+    internal RemoteConfigMessage(AgentRemoteConfig agentRemoteConfig)
+    {
+        this.agentConfigMap = new Dictionary<string, AgentConfigFile>(agentRemoteConfig.Config.ConfigMap.Count, StringComparer.Ordinal);
+
+        foreach (var config in agentRemoteConfig.Config.ConfigMap)
+        {
+            if (config.Value is not null)
+            {
+                this.agentConfigMap[config.Key] = new AgentConfigFile(config.Key, config.Value);
+            }
+        }
+
+        this.configHash = agentRemoteConfig.ConfigHash;
+    }
+
+    /// <summary>
+    /// Gets a dictionary of agent configuration files, keyed by the name of the configuration file.
+    /// </summary>
+    public IReadOnlyDictionary<string, AgentConfigFile> AgentConfigMap => this.agentConfigMap;
+
+    /// <summary>
+    /// Gets the length, in bytes, of the configuration hash.
+    /// </summary>
+    public int HashLength => this.configHash.Length;
+
+    /// <summary>
+    /// Returns the configuration hash as a byte array.
+    /// </summary>
+    /// <returns>A <see cref="byte"/> array containing the hash of the remote configuration.</returns>
+    public byte[] GetConfigHashBytes() => this.configHash.ToByteArray();
+
+    /// <summary>
+    /// Returns the configuration hash as a UTF-8 string.
+    /// </summary>
+    /// <returns>A <see cref="string"/> representing the UTF-8 encoded configuration hash.</returns>
+    public string GetConfigHashUtf8String() => this.configHash.ToStringUtf8();
+
+    /// <summary>
+    /// Attempts to copy the configuration hash to the specified destination buffer.
+    /// </summary>
+    /// <remarks>If the hash is empty, no data is written and the method returns <c>true</c> with <paramref name="bytesWritten"/> set to
+    /// 0. If the destination buffer is too small to hold the hash, no data is written, <paramref name="bytesWritten"/> is set to
+    /// 0, and the method returns <c>false</c>.</remarks>
+    /// <param name="destination">The buffer that receives the hash bytes. Must be large enough to hold the entire hash content.</param>
+    /// <param name="bytesWritten">When this method returns, contains the number of bytes successfully written to the destination buffer.</param>
+    /// <returns><c>true</c> if the hash was successfully copied to the destination buffer or if the hash is empty; otherwise, <c>false</c>.</returns>
+    public bool TryGetConfigHash(Span<byte> destination, out int bytesWritten)
+    {
+        if (this.configHash is null)
+        {
+            bytesWritten = 0;
+            return false;
+        }
+
+        if (this.configHash.IsEmpty)
+        {
+            bytesWritten = 0;
+            return true;
+        }
+
+        if (destination.Length < this.configHash.Length)
+        {
+            bytesWritten = 0;
+            return false;
+        }
+
+        this.configHash.Span.CopyTo(destination);
+        bytesWritten = this.configHash.Length;
+        return true;
+    }
+}