[resource host+process] Allow host name and process owner attributes to be excluded

src/OpenTelemetry.Resources.Host/.publicApi/PublicAPI.Unshipped.txt

@@ -1,2 +1,3 @@
 OpenTelemetry.Resources.HostResourceBuilderExtensions
 static OpenTelemetry.Resources.HostResourceBuilderExtensions.AddHostDetector(this OpenTelemetry.Resources.ResourceBuilder! builder) -> OpenTelemetry.Resources.ResourceBuilder!
+static OpenTelemetry.Resources.HostResourceBuilderExtensions.AddHostDetector(this OpenTelemetry.Resources.ResourceBuilder! builder, bool includeHostName) -> OpenTelemetry.Resources.ResourceBuilder!

src/OpenTelemetry.Resources.Host/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+* Making the inclusion of `host.name` to the `Resource` configurable.
+  Use the `AddHostDetector(bool includeHostName)` overload to control this behavior.
+  ([#2084](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2084))
+
 ## 0.1.0-beta.3
 
 Released 2024-Aug-30

src/OpenTelemetry.Resources.Host/HostDetector.cs

@@ -24,31 +24,36 @@ internal sealed class HostDetector : IResourceDetector
     private readonly Func<IEnumerable<string>> getFilePaths;
     private readonly Func<string?> getMacOsMachineId;
     private readonly Func<string?> getWindowsMachineId;
+    private readonly bool includeHostName;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="HostDetector"/> class.
     /// </summary>
-    public HostDetector()
+    /// <param name="includeHostName">Determines whether to include host name in the resource attributes.</param>
+    public HostDetector(bool includeHostName = true)
         : this(
 #if NET
         RuntimeInformation.IsOSPlatform,
 #endif
         GetFilePaths,
         GetMachineIdMacOs,
-        GetMachineIdWindows)
+        GetMachineIdWindows,
+        includeHostName)
     {
     }
 
 #if NET
     public HostDetector(
         Func<IEnumerable<string>> getFilePaths,
         Func<string?> getMacOsMachineId,
-        Func<string?> getWindowsMachineId)
+        Func<string?> getWindowsMachineId,
+        bool includeHostName = true)
         : this(
             RuntimeInformation.IsOSPlatform,
             getFilePaths,
             getMacOsMachineId,
-            getWindowsMachineId)
+            getWindowsMachineId,
+            includeHostName)
     {
     }
 #endif
@@ -59,7 +64,8 @@ internal HostDetector(
 #endif
         Func<IEnumerable<string>> getFilePaths,
         Func<string?> getMacOsMachineId,
-        Func<string?> getWindowsMachineId)
+        Func<string?> getWindowsMachineId,
+        bool includeHostName = true)
     {
 #if NET
         Guard.ThrowIfNull(isOsPlatform);
@@ -74,6 +80,7 @@ internal HostDetector(
         this.getFilePaths = getFilePaths;
         this.getMacOsMachineId = getMacOsMachineId;
         this.getWindowsMachineId = getWindowsMachineId;
+        this.includeHostName = includeHostName;
     }
 
     /// <summary>
@@ -84,10 +91,13 @@ public Resource Detect()
     {
         try
         {
-            var attributes = new List<KeyValuePair<string, object>>(2)
+            var attributes = new List<KeyValuePair<string, object>>(2);
+
+            if (this.includeHostName)
             {
-                new(HostSemanticConventions.AttributeHostName, Environment.MachineName),
-            };
+                attributes.Add(new(HostSemanticConventions.AttributeHostName, Environment.MachineName));
+            }
+
             var machineId = this.GetMachineId();
 
             if (machineId != null && !string.IsNullOrEmpty(machineId))

src/OpenTelemetry.Resources.Host/HostResourceBuilderExtensions.cs

@@ -17,8 +17,19 @@ public static class HostResourceBuilderExtensions
     /// <param name="builder">The <see cref="ResourceBuilder"/> being configured.</param>
     /// <returns>The instance of <see cref="ResourceBuilder"/> being configured.</returns>
     public static ResourceBuilder AddHostDetector(this ResourceBuilder builder)
+    {
+        return AddHostDetector(builder, includeHostName: true);
+    }
+
+    /// <summary>
+    /// Enables host resource detector.
+    /// </summary>
+    /// <param name="builder">The <see cref="ResourceBuilder"/> being configured.</param>
+    /// <param name="includeHostName">Determines whether to include host name in the resource attributes.</param>
+    /// <returns>The instance of <see cref="ResourceBuilder"/> being configured.</returns>
+    public static ResourceBuilder AddHostDetector(this ResourceBuilder builder, bool includeHostName)
     {
         Guard.ThrowIfNull(builder);
-        return builder.AddDetector(new HostDetector());
+        return builder.AddDetector(new HostDetector(includeHostName));
     }
 }

src/OpenTelemetry.Resources.Process/.publicApi/PublicAPI.Unshipped.txt

@@ -1,2 +1,3 @@
 OpenTelemetry.Resources.ProcessResourceBuilderExtensions
 static OpenTelemetry.Resources.ProcessResourceBuilderExtensions.AddProcessDetector(this OpenTelemetry.Resources.ResourceBuilder! builder) -> OpenTelemetry.Resources.ResourceBuilder!
+static OpenTelemetry.Resources.ProcessResourceBuilderExtensions.AddProcessDetector(this OpenTelemetry.Resources.ResourceBuilder! builder, bool includeProcessOwner) -> OpenTelemetry.Resources.ResourceBuilder!

src/OpenTelemetry.Resources.Process/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+* Making the inclusion of `process.owner` to the `Resource` configurable.
+  Use the `AddProcessDetector(bool includeProcessOwner)` overload to control
+  this behavior.
+  ([#2084](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2084))
+
 ## 0.1.0-beta.2
 
 Released 2024-Jun-18

src/OpenTelemetry.Resources.Process/ProcessDetector.cs

@@ -8,20 +8,36 @@ namespace OpenTelemetry.Resources.Process;
 /// </summary>
 internal sealed class ProcessDetector : IResourceDetector
 {
+    private readonly bool includeProcessOwner;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ProcessDetector"/> class.
+    /// </summary>
+    /// <param name="includeProcessOwner">Determines whether to include process owner in the resource attributes.</param>
+    public ProcessDetector(bool includeProcessOwner = true)
+    {
+        this.includeProcessOwner = includeProcessOwner;
+    }
+
     /// <summary>
     ///     Detects the resource attributes for process.
     /// </summary>
     /// <returns>Resource with key-value pairs of resource attributes.</returns>
     public Resource Detect()
     {
-        return new Resource(new List<KeyValuePair<string, object>>(2)
+        var attributes = new List<KeyValuePair<string, object>>(2);
+
+        if (this.includeProcessOwner)
         {
-            new(ProcessSemanticConventions.AttributeProcessOwner, Environment.UserName),
+            attributes.Add(new(ProcessSemanticConventions.AttributeProcessOwner, Environment.UserName));
+        }
+
 #if NET
-            new(ProcessSemanticConventions.AttributeProcessPid, Environment.ProcessId),
+        attributes.Add(new(ProcessSemanticConventions.AttributeProcessPid, Environment.ProcessId));
 #else
-            new(ProcessSemanticConventions.AttributeProcessPid, System.Diagnostics.Process.GetCurrentProcess().Id),
+        attributes.Add(new(ProcessSemanticConventions.AttributeProcessPid, System.Diagnostics.Process.GetCurrentProcess().Id));
 #endif
-        });
+
+        return new Resource(attributes);
     }
 }

src/OpenTelemetry.Resources.Process/ProcessResourceBuilderExtensions.cs

@@ -17,8 +17,19 @@ public static class ProcessResourceBuilderExtensions
     /// <param name="builder">The <see cref="ResourceBuilder"/> being configured.</param>
     /// <returns>The instance of <see cref="ResourceBuilder"/> being configured.</returns>
     public static ResourceBuilder AddProcessDetector(this ResourceBuilder builder)
+    {
+        return AddProcessDetector(builder, includeProcessOwner: true);
+    }
+
+    /// <summary>
+    /// Enables process resource detector.
+    /// </summary>
+    /// <param name="builder">The <see cref="ResourceBuilder"/> being configured.</param>
+    /// <param name="includeProcessOwner">A flag indicating whether or not to include the process owner in the resource.</param>
+    /// <returns>The instance of <see cref="ResourceBuilder"/> being configured.</returns>
+    public static ResourceBuilder AddProcessDetector(this ResourceBuilder builder, bool includeProcessOwner)
     {
         Guard.ThrowIfNull(builder);
-        return builder.AddDetector(new ProcessDetector());
+        return builder.AddDetector(new ProcessDetector(includeProcessOwner));
     }
 }

test/OpenTelemetry.Resources.Host.Tests/HostDetectorTests.cs

@@ -57,6 +57,18 @@ public void TestHostAttributes()
         Assert.NotEmpty(resourceAttributes[HostSemanticConventions.AttributeHostId]);
     }
 
+    [Fact]
+    public void TestHostAttributesWithoutHostName()
+    {
+        var resource = ResourceBuilder.CreateEmpty().AddHostDetector(includeHostName: false).Build();
+
+        var resourceAttributes = resource.Attributes.ToDictionary(x => x.Key, x => (string)x.Value);
+
+        Assert.Single(resourceAttributes);
+
+        Assert.NotEmpty(resourceAttributes[HostSemanticConventions.AttributeHostId]);
+    }
+
 #if NET
     [Fact]
     public void TestHostMachineIdLinux()

test/OpenTelemetry.Resources.Process.Tests/ProcessDetectorTests.cs

@@ -19,4 +19,17 @@ public void TestProcessAttributes()
         Assert.IsType<string>(resourceAttributes[ProcessSemanticConventions.AttributeProcessOwner]);
         Assert.IsType<long>(resourceAttributes[ProcessSemanticConventions.AttributeProcessPid]);
     }
+
+    [Fact]
+    public void TestProcessAttributes_ExcludeProcessOwner()
+    {
+        var resource = ResourceBuilder.CreateEmpty().AddProcessDetector(includeProcessOwner: false).Build();
+
+        var resourceAttributes = resource.Attributes.ToDictionary(x => x.Key, x => x.Value);
+
+        Assert.Single(resourceAttributes);
+
+        Assert.False(resourceAttributes.ContainsKey(ProcessSemanticConventions.AttributeProcessOwner));
+        Assert.IsType<long>(resourceAttributes[ProcessSemanticConventions.AttributeProcessPid]);
+    }
 }