add service.instance.id provider

instrumentation/resources/library/README.md

@@ -61,6 +61,16 @@ Implemented attributes:
 - `process.runtime.version`
 - `process.runtime.description`
 
+### Service Instance ID
+
+Implementation: `io.opentelemetry.instrumentation.resources.ServiceInstanceIdResource`
+
+Specification: <https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#service-experimental>
+
+Implemented attributes:
+
+- `service.instance.id`
+
 ## Platforms
 
 This package currently does not run on Android. It has been verified on OpenJDK and should work on

instrumentation/resources/library/src/main/java/io/opentelemetry/instrumentation/resources/ServiceInstanceIdResource.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.resources;
+
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;
+import java.util.Map;
+import java.util.UUID;
+
+/**
+ * In the spirit of <a
+ * href="https://docs.google.com/document/d/1BenPf9vsZHCf4JpHWGQBydKZAA4XdH38wuMD7JQnz9A/edit?pli=1#heading=h.lyyq7xqgpsj9">this
+ * proposal</a>
+ */
+public class ServiceInstanceIdResource {
+
+  public static final String RESOURCE_ATTRIBUTES = "otel.resource.attributes";
+  public static final String RANDOM_INSTANCE_ID = UUID.randomUUID().toString();
+
+  private ServiceInstanceIdResource() {}
+
+  public static Resource getResource(ConfigProperties config) {
+    Map<String, String> resourceAttributes = config.getMap(RESOURCE_ATTRIBUTES);
+    String k8s = k8sServiceInstanceId(resourceAttributes);
+    String value = k8s != null ? k8s : RANDOM_INSTANCE_ID;
+    return Resource.create(
+        Attributes.of(ResourceAttributes.SERVICE_INSTANCE_ID, value),
+        ResourceAttributes.SCHEMA_URL);
+  }
+
+  private static String k8sServiceInstanceId(Map<String, String> resource) {
+    String podName = resource.get(ResourceAttributes.K8S_POD_NAME.getKey());
+    String containerName = resource.get(ResourceAttributes.K8S_CONTAINER_NAME.getKey());
+    return podName != null && containerName != null ? podName + "/" + containerName : null;
+  }
+}

instrumentation/resources/library/src/main/java/io/opentelemetry/instrumentation/resources/ServiceInstanceIdResourceProvider.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.resources;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
+import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.ConditionalResourceProvider;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;
+
+/** {@link ResourceProvider} for automatically configuring {@link ServiceInstanceIdResource}. */
+@AutoService(ResourceProvider.class)
+public final class ServiceInstanceIdResourceProvider implements ConditionalResourceProvider {
+
+  @Override
+  public Resource createResource(ConfigProperties config) {
+    return ServiceInstanceIdResource.getResource(config);
+  }
+
+  @Override
+  public boolean shouldApply(ConfigProperties config, Resource existing) {
+    return !config
+        .getMap(ServiceInstanceIdResource.RESOURCE_ATTRIBUTES)
+        .containsKey(ResourceAttributes.SERVICE_INSTANCE_ID.getKey());
+  }
+}

instrumentation/resources/library/src/test/java/io/opentelemetry/instrumentation/resources/ServiceInstanceIdResourceTest.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.resources;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Named.named;
+
+import com.google.common.collect.ImmutableMap;
+import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
+import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.semconv.resource.attributes.ResourceAttributes;
+import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+class ServiceInstanceIdResourceTest {
+
+  private static class Parameter {
+    public final Map<String, String> resource;
+    public final String want;
+
+    public Parameter(Map<String, String> resource, String want) {
+      this.resource = resource;
+      this.want = want;
+    }
+  }
+
+  @ParameterizedTest(name = "{index}: {0}")
+  @MethodSource
+  void serviceInstanceId(Parameter parameter) {
+    Resource r =
+        ServiceInstanceIdResource.getResource(
+            DefaultConfigProperties.createForTest(
+                ImmutableMap.of(
+                    ServiceInstanceIdResource.RESOURCE_ATTRIBUTES,
+                    parameter.resource.entrySet().stream()
+                        .map(e -> e.getKey() + "=" + e.getValue())
+                        .collect(Collectors.joining(",")))));
+    assertThat(r.getAttribute(ResourceAttributes.SERVICE_INSTANCE_ID)).matches(parameter.want);
+  }
+
+  public static Stream<Arguments> serviceInstanceId() {
+    return Stream.of(
+        Arguments.of(
+            named(
+                "service instance id is not set, but pod name and container name are",
+                new Parameter(
+                    ImmutableMap.of(
+                        ResourceAttributes.K8S_POD_NAME.getKey(),
+                        "pod-12345",
+                        ResourceAttributes.K8S_CONTAINER_NAME.getKey(),
+                        "container-42"),
+                    "pod-12345/container-42"))),
+        Arguments.of(
+            named(
+                "fall back to random service instance id",
+                new Parameter(
+                    ImmutableMap.of(ResourceAttributes.K8S_POD_NAME.getKey(), "pod-12345"),
+                    "........-....-....-....-............"))));
+  }
+}