semconv 1.27.0 update for deployment (#584)

* semconv 1.27.0 update for deployment

* fix missing occurences

* implement automatic fallback + test

* provide new resource attribute when old is set

* spotless

Author: SylvainJuge

custom/src/main/java/co/elastic/otel/ElasticAutoConfigurationCustomizerProvider.java

@@ -24,13 +24,16 @@
 import co.elastic.otel.dynamicconfig.DynamicConfiguration;
 import co.elastic.otel.dynamicconfig.DynamicInstrumentation;
 import com.google.auto.service.AutoService;
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer;
 import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
 import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.resources.Resource;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.BiFunction;
 
 @AutoService(AutoConfigurationCustomizerProvider.class)
 public class ElasticAutoConfigurationCustomizerProvider
@@ -52,6 +55,11 @@ public class ElasticAutoConfigurationCustomizerProvider
   static final String STACKTRACE_LEGACY2_DURATION =
       "elastic.otel.java.span.stacktrace.min.duration";
 
+  private static final AttributeKey<String> DEPLOYMENT_LEGACY =
+      AttributeKey.stringKey("deployment.environment");
+  private static final AttributeKey<String> DEPLOYMENT =
+      AttributeKey.stringKey("deployment.environment.name");
+
   @Override
   public void customize(AutoConfigurationCustomizer autoConfiguration) {
     autoConfiguration.addMetricExporterCustomizer(
@@ -72,6 +80,7 @@ public void customize(AutoConfigurationCustomizer autoConfiguration) {
               providerBuilder, DynamicConfiguration.UpdatableConfigurator.INSTANCE);
           return providerBuilder;
         });
+    autoConfiguration.addResourceCustomizer(resourceProviders());
   }
 
   static Map<String, String> propertiesCustomizer(ConfigProperties configProperties) {
@@ -85,6 +94,19 @@ static Map<String, String> propertiesCustomizer(ConfigProperties configPropertie
     return config;
   }
 
+  static BiFunction<Resource, ConfigProperties, Resource> resourceProviders() {
+    return (resource, configProperties) -> {
+
+      // duplicate deprecated deployment.environment to deployment.environment.name as a convenience
+      String deploymentLegacy = resource.getAttribute(DEPLOYMENT_LEGACY);
+      if (deploymentLegacy != null && resource.getAttribute(DEPLOYMENT) == null) {
+        resource = resource.toBuilder().put(DEPLOYMENT, deploymentLegacy).build();
+      }
+
+      return resource;
+    };
+  }
+
   private static void experimentalTelemetry(
       Map<String, String> config, ConfigProperties configProperties) {
     // enable experimental telemetry metrics by default if not explicitly disabled

custom/src/main/java/co/elastic/otel/config/LegacyConfigurations.java

@@ -70,7 +70,7 @@ private void addAllOptions() {
         "The Elastic [`service_version`](https://www.elastic.co/guide/en/apm/agent/java/current/config-core.html#config-service-version) option corresponds to setting the `service.version` key in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes). For example: `OTEL_RESOURCE_ATTRIBUTES=service.version=1.2.3`.");
     addDocumentationOption(
         "environment",
-        "The Elastic [`environment`](https://www.elastic.co/guide/en/apm/agent/java/current/config-core.html#config-environment) option corresponds to setting the `deployment.environment` key in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes). For example: `OTEL_RESOURCE_ATTRIBUTES=deployment.environment=testing`.");
+        "The Elastic [`environment`](https://www.elastic.co/guide/en/apm/agent/java/current/config-core.html#config-environment) option corresponds to setting the `deployment.environment.name` key in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes). For example: `OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=testing`.");
     addDocumentationOption(
         "global_labels",
         "The Elastic [`global_labels`](https://www.elastic.co/guide/en/apm/agent/java/current/config-core.html#config-global-labels) option corresponds to adding `key=value` comma separated pairs in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes). For example: `OTEL_RESOURCE_ATTRIBUTES=alice=first,bob=second`. Such labels will result in labels.key=value attributes on the server, e.g. labels.alice=first");

custom/src/test/java/co/elastic/otel/ElasticAutoConfigurationCustomizerProviderTest.java

@@ -19,10 +19,13 @@
 package co.elastic.otel;
 
 import static co.elastic.otel.ElasticAutoConfigurationCustomizerProvider.propertiesCustomizer;
-import static org.assertj.core.api.Assertions.assertThat;
+import static co.elastic.otel.ElasticAutoConfigurationCustomizerProvider.resourceProviders;
+import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
 
 import io.opentelemetry.javaagent.tooling.EmptyConfigProperties;
 import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.semconv.incubating.DeploymentIncubatingAttributes;
 import java.util.HashMap;
 import java.util.Map;
 import org.junit.jupiter.api.Test;
@@ -84,4 +87,38 @@ void customizeMetricTemporalityPreference() {
     String value = config.get("otel.exporter.otlp.metrics.temporality.preference");
     assertThat(value).isEqualTo("LOWMEMORY");
   }
+
+  @Test
+  void legacyDeploymentEnvironment() {
+    Resource input =
+        Resource.builder()
+            .put(DeploymentIncubatingAttributes.DEPLOYMENT_ENVIRONMENT, "test")
+            .put("other", "other")
+            .build();
+    Resource resource = resourceProviders().apply(input, null);
+
+    assertThat(resource.getAttributes())
+        .hasSize(3)
+        .describedAs("when legacy attribute set agent should send both")
+        .containsEntry(DeploymentIncubatingAttributes.DEPLOYMENT_ENVIRONMENT, "test")
+        .containsEntry(DeploymentIncubatingAttributes.DEPLOYMENT_ENVIRONMENT_NAME, "test")
+        .containsEntry("other", "other");
+  }
+
+  @Test
+  void legacyDeploymentRemoveLegacyWhenBothSet() {
+    Resource input =
+        Resource.builder()
+            .put(DeploymentIncubatingAttributes.DEPLOYMENT_ENVIRONMENT, "legacy")
+            .put(DeploymentIncubatingAttributes.DEPLOYMENT_ENVIRONMENT_NAME, "new")
+            .put("other", "other")
+            .build();
+    Resource resource = resourceProviders().apply(input, null);
+    assertThat(resource.getAttributes())
+        .hasSize(3)
+        .describedAs("when both attributes are set, agent should send them as-is")
+        .containsEntry(DeploymentIncubatingAttributes.DEPLOYMENT_ENVIRONMENT, "legacy")
+        .containsEntry(DeploymentIncubatingAttributes.DEPLOYMENT_ENVIRONMENT_NAME, "new")
+        .containsEntry("other", "other");
+  }
 }

custom/src/test/java/co/elastic/otel/SemconvTest.java

@@ -0,0 +1,37 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package co.elastic.otel;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import io.opentelemetry.semconv.incubating.DeploymentIncubatingAttributes;
+import org.junit.jupiter.api.Test;
+
+public class SemconvTest {
+
+  @Test
+  void checkIncubatingAttributes() {
+    // Some of the incubating attributes are important, and we need to ensure that their definition
+    // do not change or breaks. Doing a basic name check is the bare minimum we can do to easily
+    // detect when something is getting deprecated or promoted to stable.
+
+    assertThat(DeploymentIncubatingAttributes.DEPLOYMENT_ENVIRONMENT_NAME.getKey())
+        .isEqualTo("deployment.environment.name");
+  }
+}

docs/migrate.md

@@ -83,7 +83,7 @@ This file is auto-generated. Please make changes in *Configuration.java (for exa
 
 ### `environment`
 
-The Elastic [`environment`](https://www.elastic.co/guide/en/apm/agent/java/current/config-core.html#config-environment) option corresponds to setting the `deployment.environment` key in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes). For example: `OTEL_RESOURCE_ATTRIBUTES=deployment.environment=testing`.
+The Elastic [`environment`](https://www.elastic.co/guide/en/apm/agent/java/current/config-core.html#config-environment) option corresponds to setting the `deployment.environment.name` key in [OTEL_RESOURCE_ATTRIBUTES](https://opentelemetry.io/docs/concepts/sdk-configuration/general-sdk-configuration/#otel_resource_attributes). For example: `OTEL_RESOURCE_ATTRIBUTES=deployment.environment.name=testing`.
 
 <!--
 This file is auto-generated. Please make changes in *Configuration.java (for example, CoreConfiguration.java) and execute ConfigurationExporter.