semconv 1.41.0 update (#1093)

* make semconv version in catalog have priority over upstream

* migreate to stable telemetry semconv

* deployment.environment.name is now stable

* add changelog entry

* spotless

Author: SylvainJuge

buildSrc/src/main/kotlin/elastic-otel.java-conventions.gradle.kts

@@ -19,6 +19,18 @@ repositories {
 
 //https://github.com/gradle/gradle/issues/15383
 val catalog = extensions.getByType<VersionCatalogsExtension>().named("catalog")
+
+configurations.all {
+  resolutionStrategy {
+    // Force the semconv version to be the one we explicitly set into version catalog and override
+    // the upstream version, hence allowing to use a different version than upstream.
+    force(
+      "io.opentelemetry.semconv:opentelemetry-semconv:${catalog.findVersion("opentelemetrySemconv").get()}",
+      "io.opentelemetry.semconv:opentelemetry-semconv-incubating:${catalog.findVersion("opentelemetrySemconvAlpha").get()}"
+    )
+  }
+}
+
 dependencies {
 
   implementation(platform(catalog.findLibrary("opentelemetryInstrumentationAlphaBom").get()))

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

@@ -18,6 +18,8 @@
  */
 package co.elastic.otel;
 
+import static io.opentelemetry.semconv.DeploymentAttributes.DEPLOYMENT_ENVIRONMENT_NAME;
+
 import co.elastic.otel.config.ConfigLoggingAgentListener;
 import co.elastic.otel.dynamicconfig.BlockableLogRecordExporter;
 import co.elastic.otel.dynamicconfig.BlockableMetricExporter;
@@ -59,8 +61,6 @@ public class ElasticAutoConfigurationCustomizerProvider
 
   private static final AttributeKey<String> DEPLOYMENT_LEGACY =
       AttributeKey.stringKey("deployment.environment");
-  private static final AttributeKey<String> DEPLOYMENT =
-      AttributeKey.stringKey("deployment.environment.name");
   private static final String OTEL_JAVAAGENT_EXPERIMENTAL_INDY = "otel.javaagent.experimental.indy";
 
   @Override
@@ -118,8 +118,8 @@ static BiFunction<Resource, ConfigProperties, Resource> resourceProviders() {
 
       // 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();
+      if (deploymentLegacy != null && resource.getAttribute(DEPLOYMENT_ENVIRONMENT_NAME) == null) {
+        resource = resource.toBuilder().put(DEPLOYMENT_ENVIRONMENT_NAME, deploymentLegacy).build();
       }
 
       return resource;

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

@@ -21,7 +21,7 @@
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.javaagent.tooling.AgentVersion;
 import io.opentelemetry.sdk.resources.Resource;
-import io.opentelemetry.semconv.incubating.TelemetryIncubatingAttributes;
+import io.opentelemetry.semconv.TelemetryAttributes;
 
 public class ElasticDistroResource {
 
@@ -40,9 +40,9 @@ public static Resource get() {
     }
     return Resource.create(
         Attributes.of(
-            TelemetryIncubatingAttributes.TELEMETRY_DISTRO_NAME,
+            TelemetryAttributes.TELEMETRY_DISTRO_NAME,
             "elastic",
-            TelemetryIncubatingAttributes.TELEMETRY_DISTRO_VERSION,
+            TelemetryAttributes.TELEMETRY_DISTRO_VERSION,
             AgentVersion.VERSION));
   }
 }

custom/src/main/java/co/elastic/otel/dynamicconfig/CentralConfig.java

@@ -18,6 +18,8 @@
  */
 package co.elastic.otel.dynamicconfig;
 
+import static io.opentelemetry.semconv.DeploymentAttributes.DEPLOYMENT_ENVIRONMENT_NAME;
+
 import co.elastic.otel.compositesampling.DynamicCompositeParentBasedTraceIdRatioBasedSampler;
 import co.elastic.otel.config.ConfigLoggingAgentListener;
 import co.elastic.otel.dynamicconfig.internal.OpampManager;
@@ -138,7 +140,7 @@ static String getServiceName(ConfigProperties properties) {
   @Nullable
   static String getServiceEnvironment(ConfigProperties properties) {
     Map<String, String> resourceMap = properties.getMap("otel.resource.attributes");
-    String environment = resourceMap.get("deployment.environment.name"); // semconv
+    String environment = resourceMap.get(DEPLOYMENT_ENVIRONMENT_NAME.getKey());
     if (environment != null) {
       return environment;
     }

custom/src/main/java/co/elastic/otel/dynamicconfig/internal/OpampManager.java

@@ -18,6 +18,8 @@
  */
 package co.elastic.otel.dynamicconfig.internal;
 
+import static io.opentelemetry.semconv.DeploymentAttributes.DEPLOYMENT_ENVIRONMENT_NAME;
+
 import com.dslplatform.json.DslJson;
 import com.dslplatform.json.JsonReader;
 import com.dslplatform.json.MapConverter;
@@ -85,7 +87,8 @@ public void start(CentralConfigurationProcessor processor) {
       builder.putIdentifyingAttribute("service.name", configuration.serviceName);
     }
     if (configuration.environment != null) {
-      builder.putIdentifyingAttribute("deployment.environment.name", configuration.environment);
+      builder.putIdentifyingAttribute(
+          DEPLOYMENT_ENVIRONMENT_NAME.getKey(), configuration.environment);
     }
     PeriodicDelay retryDelay = RetryPeriodicDelay.create(configuration.pollingInterval);
     builder.setRequestService(HttpRequestService.create(httpSender, pollingDelay, retryDelay));

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

@@ -0,0 +1,7 @@
+prs:
+- "1093"
+type: enhancement
+products:
+- product: edot-java
+  lifecycle: ga
+title: semconv 1.41.0 update

docs/changelog/1093.yaml

@@ -21,8 +21,8 @@ opentelemetryContribAlpha = "1.55.0-alpha"
 # updated from upstream agent with .ci/update-upstream.sh
 # While the semconv stable/incubating artifacts are provided as transitive dependencies, keeping
 # an explicit version here allows to easily override to a not-yet-released version.
-opentelemetrySemconv = "1.40.0"
-opentelemetrySemconvAlpha = "1.40.0-alpha"
+opentelemetrySemconv = "1.41.0"
+opentelemetrySemconvAlpha = "1.41.0-alpha"
 
 [libraries]
 

gradle/libs.versions.toml

@@ -20,15 +20,15 @@
 
 import static io.opentelemetry.semconv.ServiceAttributes.SERVICE_INSTANCE_ID;
 import static io.opentelemetry.semconv.ServiceAttributes.SERVICE_NAME;
+import static io.opentelemetry.semconv.TelemetryAttributes.TELEMETRY_DISTRO_NAME;
+import static io.opentelemetry.semconv.TelemetryAttributes.TELEMETRY_DISTRO_VERSION;
 import static io.opentelemetry.semconv.incubating.ContainerIncubatingAttributes.CONTAINER_ID;
 import static io.opentelemetry.semconv.incubating.HostIncubatingAttributes.HOST_ARCH;
 import static io.opentelemetry.semconv.incubating.HostIncubatingAttributes.HOST_NAME;
 import static io.opentelemetry.semconv.incubating.OsIncubatingAttributes.OS_TYPE;
 import static io.opentelemetry.semconv.incubating.OsIncubatingAttributes.OS_VERSION;
 import static io.opentelemetry.semconv.incubating.ProcessIncubatingAttributes.PROCESS_COMMAND_ARGS;
 import static io.opentelemetry.semconv.incubating.ProcessIncubatingAttributes.PROCESS_PID;
-import static io.opentelemetry.semconv.incubating.TelemetryIncubatingAttributes.TELEMETRY_DISTRO_NAME;
-import static io.opentelemetry.semconv.incubating.TelemetryIncubatingAttributes.TELEMETRY_DISTRO_VERSION;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.tuple;
 

smoke-tests/src/test/java/com/example/javaagent/smoketest/DeclarativeConfigSmokeTest.java

@@ -22,7 +22,7 @@
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
 import io.opentelemetry.sdk.resources.Resource;
-import io.opentelemetry.semconv.incubating.TelemetryIncubatingAttributes;
+import io.opentelemetry.semconv.TelemetryAttributes;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
@@ -43,16 +43,16 @@ public void checkDistroName() {
 
     if (isRunningDistro) {
       assertThat(resource.getAttributes())
-          .containsEntry(TelemetryIncubatingAttributes.TELEMETRY_DISTRO_NAME, "elastic");
+          .containsEntry(TelemetryAttributes.TELEMETRY_DISTRO_NAME, "elastic");
       assertThat(resource.getAttributes())
-          .containsKey(TelemetryIncubatingAttributes.TELEMETRY_DISTRO_VERSION);
+          .containsKey(TelemetryAttributes.TELEMETRY_DISTRO_VERSION);
     } else {
       // we are running with the vanilla agent as extension: we should not be setting the distro
       // name
       assertThat(resource.getAttributes())
-          .doesNotContainKey(TelemetryIncubatingAttributes.TELEMETRY_DISTRO_NAME);
+          .doesNotContainKey(TelemetryAttributes.TELEMETRY_DISTRO_NAME);
       assertThat(resource.getAttributes())
-          .doesNotContainKey(TelemetryIncubatingAttributes.TELEMETRY_DISTRO_VERSION);
+          .doesNotContainKey(TelemetryAttributes.TELEMETRY_DISTRO_VERSION);
     }
   }
 }