[Discussion] Add deployment.environment support

.cspell/company-terms.txt

@@ -1 +1,2 @@
-OTEL
+OTEL
+SIGNALFX

CHANGELOG.md

@@ -14,6 +14,7 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 * Add `SPLUNK_ACCESS_TOKEN` configuration key to authorize direct ingest.
 * Add `SPLUNK_TRACE_RESPONSE_HEADER_ENABLED` configuration key
   to support Splunk RUM.
+* Add `SIGNALFX_ENV` configuration key to specify environment name.
 
 ### Changed
 

docs/advanced-config.md

@@ -47,6 +47,7 @@ Note: .NET Framework apps can read settings also from `Web.config` and `App.conf
 
 | Environment variable                   | Default | Description                                |
 |----------------------------------------|---------|--------------------------------------------|
+| `SIGNALFX_ENV`                         |         | Specifies environment name.                |
 | `SPLUNK_REALM`                         | `none`  | Specifies direct OTLP ingest realm. [1]    |
 | `SPLUNK_ACCESS_TOKEN`                  |         | Specifies direct OTLP ingest access token. |
 | `SPLUNK_TRACE_RESPONSE_HEADER_ENABLED` | `true`  | Enables Splunk RUM integration.            |

src/Splunk.OpenTelemetry.AutoInstrumentation/ConfigurationKeys.cs

@@ -18,6 +18,14 @@ namespace Splunk.OpenTelemetry.AutoInstrumentation;
 
 internal static class ConfigurationKeys
 {
+    public static class SignalFx
+    {
+        /// <summary>
+        /// Configuration key for current environment name.
+        /// </summary>
+        public const string Environment = "SIGNALFX_ENV";
+    }
+
     public static class Splunk
     {
         /// <summary>

src/Splunk.OpenTelemetry.AutoInstrumentation/Logs.cs

@@ -22,10 +22,16 @@ namespace Splunk.OpenTelemetry.AutoInstrumentation;
 internal class Logs
 {
     private readonly ILogger _log = new Logger();
+    private readonly PluginSettings _settings;
+
+    public Logs(PluginSettings settings)
+    {
+        _settings = settings;
+    }
 
     public void ConfigureLogsOptions(OpenTelemetryLoggerOptions options)
     {
         ServiceNameWarning.Instance.SendOnMissingServiceName(_log);
-        options.ConfigureResource(ResourceConfigurator.Configure);
+        options.ConfigureResource(b => ResourceConfigurator.Configure(b, _settings));
     }
 }

src/Splunk.OpenTelemetry.AutoInstrumentation/Metrics.cs

@@ -34,7 +34,7 @@ internal Metrics(PluginSettings settings)
     public MeterProviderBuilder ConfigureMeterProvider(MeterProviderBuilder builder)
     {
         ServiceNameWarning.Instance.SendOnMissingServiceName(_log);
-        return builder.ConfigureResource(ResourceConfigurator.Configure);
+        return builder.ConfigureResource(b => ResourceConfigurator.Configure(b, _settings));
     }
 
     public void ConfigureMetricsOptions(OtlpExporterOptions options)

src/Splunk.OpenTelemetry.AutoInstrumentation/Plugin.cs

@@ -36,7 +36,7 @@ public class Plugin
 
     private readonly Metrics _metrics = new(Settings);
     private readonly Traces _traces = new(Settings);
-    private readonly Logs _logs = new();
+    private readonly Logs _logs = new(Settings);
 
     /// <summary>
     /// Configures Metrics

src/Splunk.OpenTelemetry.AutoInstrumentation/PluginSettings.cs

@@ -35,6 +35,7 @@ internal PluginSettings(IConfigurationSource source)
 
         Realm = source.GetString(ConfigurationKeys.Splunk.Realm);
         AccessToken = source.GetString(ConfigurationKeys.Splunk.AccessToken);
+        EnvironmentName = source.GetString(ConfigurationKeys.SignalFx.Environment);
         TraceResponseHeaderEnabled = source.GetBool(ConfigurationKeys.Splunk.TraceResponseHeaderEnabled) ?? true;
         IsOtlpEndpointSet = !string.IsNullOrEmpty(source.GetString(ConfigurationKeys.OpenTelemetry.OtlpEndpoint));
     }
@@ -43,6 +44,8 @@ internal PluginSettings(IConfigurationSource source)
 
     public string? AccessToken { get; }
 
+    public string? EnvironmentName { get; }
+
     public bool TraceResponseHeaderEnabled { get; }
 
     public bool IsOtlpEndpointSet { get; }

src/Splunk.OpenTelemetry.AutoInstrumentation/ResourceConfigurator.cs

@@ -23,6 +23,7 @@ namespace Splunk.OpenTelemetry.AutoInstrumentation;
 internal static class ResourceConfigurator
 {
     private const string SplunkDistroVersionName = "splunk.distro.version";
+    private const string DeploymentEnvironment = "deployment.environment";
     private static readonly string Version;
 
     static ResourceConfigurator()
@@ -32,9 +33,18 @@ static ResourceConfigurator()
         Version = version.FileVersion ?? "unknown";
     }
 
-    public static void Configure(ResourceBuilder resourceBuilder)
+    public static void Configure(ResourceBuilder resourceBuilder, PluginSettings settings)
     {
-        resourceBuilder
-            .AddAttributes(new KeyValuePair<string, object>[] { new(SplunkDistroVersionName, Version) });
+        var attributes = new List<KeyValuePair<string, object>>
+        {
+            new(SplunkDistroVersionName, Version)
+        };
+
+        if (!string.IsNullOrEmpty(settings.EnvironmentName))
+        {
+            attributes.Add(new(DeploymentEnvironment, settings.EnvironmentName!));
+        }
+
+        resourceBuilder.AddAttributes(attributes);
     }
 }

src/Splunk.OpenTelemetry.AutoInstrumentation/Traces.cs

@@ -42,7 +42,7 @@ internal Traces(PluginSettings settings)
     public TracerProviderBuilder ConfigureTracerProvider(TracerProviderBuilder builder)
     {
         ServiceNameWarning.Instance.SendOnMissingServiceName(_log);
-        return builder.ConfigureResource(ResourceConfigurator.Configure);
+        return builder.ConfigureResource(b => ResourceConfigurator.Configure(b, _settings));
     }
 
     public void ConfigureTracesOptions(OtlpExporterOptions options)

test/Splunk.OpenTelemetry.AutoInstrumentation.Tests/ResourceConfiguratorTests.cs

@@ -14,30 +14,43 @@
 // limitations under the License.
 // </copyright>
 
+using System.Collections.Specialized;
 using System.Linq;
 using System.Reflection;
 using FluentAssertions.Execution;
 using OpenTelemetry.Resources;
+using Splunk.OpenTelemetry.AutoInstrumentation.Configuration;
 
 namespace Splunk.OpenTelemetry.AutoInstrumentation.Tests;
 
 public class ResourceConfiguratorTests
 {
     [Fact]
-    public void ConfigureSplunkDistributionVersion()
+    public void ResourceConfiguratorConfigure()
     {
+        var configuration = new NameValueCollection
+        {
+            { "SIGNALFX_ENV", "test" },
+        };
+
+        var settings = new PluginSettings(new NameValueConfigurationSource(configuration));
         var resourceBuilder = ResourceBuilder.CreateEmpty();
 
-        ResourceConfigurator.Configure(resourceBuilder);
+        ResourceConfigurator.Configure(resourceBuilder, settings);
 
         var resource = resourceBuilder.Build();
 
         using (new AssertionScope())
         {
-            resource.Attributes.Count().Should().Be(1);
-            var attribute = resource.Attributes.First();
-            attribute.Key.Should().Be("splunk.distro.version");
-            (attribute.Value as string).Should().Be(typeof(Plugin).Assembly.GetCustomAttribute<AssemblyFileVersionAttribute>()?.Version);
+            resource.Attributes.Count().Should().Be(2);
+
+            var versionAttribute = resource.Attributes.First();
+            versionAttribute.Key.Should().Be("splunk.distro.version");
+            (versionAttribute.Value as string).Should().Be(typeof(Plugin).Assembly.GetCustomAttribute<AssemblyFileVersionAttribute>()?.Version);
+
+            var envAttribute = resource.Attributes.Last();
+            envAttribute.Key.Should().Be("deployment.environment");
+            (envAttribute.Value as string).Should().Be("test");
         }
     }
 }

test/Splunk.OpenTelemetry.AutoInstrumentation.Tests/SettingsTests.cs

@@ -40,12 +40,14 @@ internal void TracerSettings_DefaultValues()
             {
                 settings.Realm.Should().BeNull();
                 settings.AccessToken.Should().BeNull();
+                settings.EnvironmentName.Should().BeNull();
                 settings.TraceResponseHeaderEnabled.Should().BeTrue();
             }
         }
 
         private static void ClearEnvVars()
         {
+            Environment.SetEnvironmentVariable(ConfigurationKeys.SignalFx.Environment, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.Realm, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.AccessToken, null);
             Environment.SetEnvironmentVariable(ConfigurationKeys.Splunk.TraceResponseHeaderEnabled, null);