Added server.* attributes

JonasKunz · JonasKunz · commit 149ffbd06392 · 2025-04-11T12:55:17.000+02:00
diff --git a/exporters/common/src/main/java/io/opentelemetry/exporter/internal/ServerAttributesUtil.java b/exporters/common/src/main/java/io/opentelemetry/exporter/internal/ServerAttributesUtil.java
@@ -0,0 +1,46 @@
+package io.opentelemetry.exporter.internal;
+
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.sdk.internal.SemConvAttributes;
+import java.net.URI;
+import java.net.URISyntaxException;
+
+/**
+ * This class is internal and is hence not for public use. Its APIs are unstable and can change at
+ * any time.
+ */
+public class ServerAttributesUtil {
+
+  private ServerAttributesUtil() {}
+
+  public static Attributes extractServerAttributes(URI parsed) {
+    AttributesBuilder builder = Attributes.builder();
+    String host = parsed.getHost();
+    if (host != null) {
+      builder.put(SemConvAttributes.SERVER_ADDRESS, host);
+    }
+    int port = parsed.getPort();
+    if (port == -1) {
+      String scheme = parsed.getScheme();
+      if ("https".equals(scheme)) {
+        port = 443;
+      } else if ("http".equals(scheme)) {
+        port = 80;
+      }
+    }
+    if (port != -1) {
+      builder.put(SemConvAttributes.SERVER_PORT, port);
+    }
+    return builder.build();
+  }
+
+  public static Attributes extractServerAttributes(String httpEndpoint) {
+    try {
+      URI parsed = new URI(httpEndpoint);
+      return extractServerAttributes(parsed);
+    } catch (URISyntaxException e) {
+      return Attributes.empty();
+    }
+  }
+}
diff --git a/exporters/common/src/main/java/io/opentelemetry/exporter/internal/grpc/GrpcExporter.java b/exporters/common/src/main/java/io/opentelemetry/exporter/internal/grpc/GrpcExporter.java
@@ -8,6 +8,7 @@
 import static io.opentelemetry.exporter.internal.grpc.GrpcExporterUtil.GRPC_STATUS_UNAVAILABLE;
 import static io.opentelemetry.exporter.internal.grpc.GrpcExporterUtil.GRPC_STATUS_UNIMPLEMENTED;
 
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.exporter.internal.ExporterMetrics;
 import io.opentelemetry.exporter.internal.ExporterMetricsAdapter;
@@ -49,17 +50,17 @@ public GrpcExporter(
       GrpcSender<T> grpcSender,
       HealthMetricLevel healthMetricLevel,
       ComponentId componentId,
-      Supplier<MeterProvider> meterProviderSupplier) {
+      Supplier<MeterProvider> meterProviderSupplier,
+      Attributes healthMetricAttributes) {
     this.type = type.toString();
     this.grpcSender = grpcSender;
-    // TODO: add a way of extracting the server.address and server.port attributes from GrpcSender
     this.exporterMetrics =
         new ExporterMetricsAdapter(
             healthMetricLevel,
             meterProviderSupplier,
             type,
             componentId,
-            null,
+            healthMetricAttributes,
             legacyExporterName,
             "grpc");
   }
diff --git a/exporters/common/src/main/java/io/opentelemetry/exporter/internal/grpc/GrpcExporterBuilder.java b/exporters/common/src/main/java/io/opentelemetry/exporter/internal/grpc/GrpcExporterBuilder.java
@@ -12,6 +12,7 @@
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.exporter.internal.ExporterBuilderUtil;
 import io.opentelemetry.exporter.internal.ExporterMetrics;
+import io.opentelemetry.exporter.internal.ServerAttributesUtil;
 import io.opentelemetry.exporter.internal.TlsConfigHelper;
 import io.opentelemetry.exporter.internal.compression.Compressor;
 import io.opentelemetry.exporter.internal.marshal.Marshaler;
@@ -248,7 +249,8 @@ public GrpcExporter<T> build() {
         grpcSender,
         healthMetricLevel,
         ComponentId.generateLazy(componentType),
-        meterProviderSupplier);
+        meterProviderSupplier,
+        ServerAttributesUtil.extractServerAttributes(endpoint));
   }
 
   public String toString(boolean includePrefixAndSuffix) {
diff --git a/exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporter.java b/exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporter.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.exporter.internal.http;
 
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.exporter.internal.ExporterMetrics;
 import io.opentelemetry.exporter.internal.ExporterMetricsAdapter;
@@ -47,7 +48,8 @@ public HttpExporter(
       HttpSender httpSender,
       Supplier<MeterProvider> meterProviderSupplier,
       HealthMetricLevel healthMetricLevel,
-      boolean exportAsJson) {
+      boolean exportAsJson,
+      Attributes healthMetricAttributes) {
     this.type = type.toString();
     this.httpSender = httpSender;
     // TODO: extract server.address and server.port here
@@ -57,7 +59,7 @@ public HttpExporter(
             meterProviderSupplier,
             type,
             componentId,
-            null,
+            healthMetricAttributes,
             legacyExporterName,
             exportAsJson ? "http-json" : "http");
   }
diff --git a/exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporterBuilder.java b/exporters/common/src/main/java/io/opentelemetry/exporter/internal/http/HttpExporterBuilder.java
@@ -10,6 +10,7 @@
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.exporter.internal.ExporterBuilderUtil;
 import io.opentelemetry.exporter.internal.ExporterMetrics;
+import io.opentelemetry.exporter.internal.ServerAttributesUtil;
 import io.opentelemetry.exporter.internal.TlsConfigHelper;
 import io.opentelemetry.exporter.internal.compression.Compressor;
 import io.opentelemetry.exporter.internal.marshal.Marshaler;
@@ -238,7 +239,8 @@ public HttpExporter<T> build() {
         httpSender,
         meterProviderSupplier,
         healthMetricLevel,
-        exportAsJson);
+        exportAsJson,
+        ServerAttributesUtil.extractServerAttributes(endpoint));
   }
 
   public String toString(boolean includePrefixAndSuffix) {
diff --git a/exporters/common/src/test/java/io/opentelemetry/exporter/internal/grpc/GrpcExporterTest.java b/exporters/common/src/test/java/io/opentelemetry/exporter/internal/grpc/GrpcExporterTest.java
@@ -81,6 +81,7 @@ void testHealthMetrics(ExporterMetrics.Signal signal) {
           Attributes.builder()
               .put(SemConvAttributes.OTEL_COMPONENT_TYPE, "test_exporter")
               .put(SemConvAttributes.OTEL_COMPONENT_NAME, id.getComponentName())
+              .put("foo", "bar")
               .build();
 
       GrpcSender<Marshaler> mockSender = Mockito.mock(GrpcSender.class);
@@ -93,7 +94,8 @@ void testHealthMetrics(ExporterMetrics.Signal signal) {
               mockSender,
               HealthMetricLevel.ON,
               id,
-              () -> meterProvider
+              () -> meterProvider,
+              Attributes.builder().put("foo", "bar").build()
           );
 
       doAnswer(
@@ -221,7 +223,8 @@ void testHealthMetricsDisabled() {
               mockSender,
               HealthMetricLevel.OFF,
               id,
-              () -> meterProvider
+              () -> meterProvider,
+              Attributes.empty()
           );
 
       doAnswer(
diff --git a/exporters/common/src/test/java/io/opentelemetry/exporter/internal/http/HttpExporterTest.java b/exporters/common/src/test/java/io/opentelemetry/exporter/internal/http/HttpExporterTest.java
@@ -73,6 +73,7 @@ void testHealthMetrics(ExporterMetrics.Signal signal) {
           Attributes.builder()
               .put(SemConvAttributes.OTEL_COMPONENT_TYPE, "test_exporter")
               .put(SemConvAttributes.OTEL_COMPONENT_NAME, id.getComponentName())
+              .put("foo", "bar")
               .build();
 
       HttpSender mockSender = Mockito.mock(HttpSender.class);
@@ -86,7 +87,8 @@ void testHealthMetrics(ExporterMetrics.Signal signal) {
               mockSender,
               () -> meterProvider,
               HealthMetricLevel.ON,
-              false);
+              false,
+              Attributes.builder().put("foo", "bar").build());
 
       doAnswer(
               invoc -> {
@@ -213,7 +215,8 @@ void testHealthMetricsDisabled() {
               mockSender,
               () -> meterProvider,
               HealthMetricLevel.OFF,
-              false);
+              false,
+              Attributes.empty());
 
       doAnswer(
           invoc -> {
diff --git a/exporters/otlp/all/src/jmh/java/io/opentelemetry/exporter/otlp/trace/OltpExporterBenchmark.java b/exporters/otlp/all/src/jmh/java/io/opentelemetry/exporter/otlp/trace/OltpExporterBenchmark.java
@@ -11,6 +11,7 @@
 import io.grpc.ManagedChannel;
 import io.grpc.ManagedChannelBuilder;
 import io.grpc.stub.StreamObserver;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.exporter.internal.ExporterMetrics;
 import io.opentelemetry.exporter.internal.grpc.GrpcExporter;
@@ -95,7 +96,8 @@ public void setUp() {
                 null),
             HealthMetricLevel.OFF,
             ComponentId.generateLazy("upstream_grpc_exporter"),
-            MeterProvider::noop);
+            MeterProvider::noop,
+            Attributes.empty());
 
     okhttpGrpcSender =
         new GrpcExporter<>(
@@ -115,7 +117,8 @@ public void setUp() {
                 null),
             HealthMetricLevel.OFF,
             ComponentId.generateLazy("okhttp_grpc_exporter"),
-            MeterProvider::noop);
+            MeterProvider::noop,
+            Attributes.empty());
 
     httpExporter =
         new HttpExporterBuilder<TraceRequestMarshaler>(
diff --git a/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporter.java b/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporter.java
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.exporter.zipkin;
 
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.internal.InstrumentationUtil;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.exporter.internal.ExporterMetrics;
@@ -54,6 +55,7 @@ public final class ZipkinSpanExporter implements SpanExporter {
       BytesMessageSender sender,
       Supplier<MeterProvider> meterProviderSupplier,
       HealthMetricLevel healthMetricLevel,
+      Attributes additonalHealthAttributes,
       OtelToZipkinSpanTransformer transformer) {
     this.builder = builder;
     this.encoder = encoder;
@@ -76,7 +78,7 @@ public final class ZipkinSpanExporter implements SpanExporter {
             meterProviderSupplier,
             ExporterMetrics.Signal.SPAN,
             ComponentId.generateLazy(componentType),
-            null,
+            additonalHealthAttributes,
             "zipkin",
             transportName);
   }
diff --git a/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporterBuilder.java b/exporters/zipkin/src/main/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporterBuilder.java
@@ -10,6 +10,7 @@
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.api.metrics.MeterProvider;
+import io.opentelemetry.exporter.internal.ServerAttributesUtil;
 import io.opentelemetry.sdk.common.HealthMetricLevel;
 import java.net.InetAddress;
 import java.time.Duration;
@@ -234,6 +235,7 @@ public ZipkinSpanExporter build() {
     OtelToZipkinSpanTransformer transformer =
         OtelToZipkinSpanTransformer.create(localIpAddressSupplier);
     return new ZipkinSpanExporter(
-        this, encoder, sender, meterProviderSupplier, healthMetricLevel, transformer);
+        this, encoder, sender, meterProviderSupplier, healthMetricLevel, ServerAttributesUtil.extractServerAttributes(endpoint),
+        transformer);
   }
 }
diff --git a/exporters/zipkin/src/test/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporterTest.java b/exporters/zipkin/src/test/java/io/opentelemetry/exporter/zipkin/ZipkinSpanExporterTest.java
@@ -15,6 +15,7 @@
 import static org.mockito.Mockito.when;
 
 import io.github.netmikey.logunit.api.LogCapturer;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.internal.InstrumentationUtil;
 import io.opentelemetry.api.metrics.MeterProvider;
 import io.opentelemetry.context.Context;
@@ -62,6 +63,7 @@ void testExport() throws IOException {
             mockSender,
             MeterProvider::noop,
             HealthMetricLevel.OFF,
+            Attributes.empty(),
             mockTransformer);
 
     byte[] someBytes = new byte[0];
@@ -92,6 +94,7 @@ void testExport_failed() throws IOException {
             mockSender,
             MeterProvider::noop,
             HealthMetricLevel.OFF,
+            Attributes.empty(),
             mockTransformer);
 
     byte[] someBytes = new byte[0];
@@ -280,6 +283,7 @@ void suppressInstrumentation() {
             suppressCatchingSender,
             MeterProvider::noop,
             HealthMetricLevel.OFF,
+            Attributes.empty(),
             mockTransformer);
 
     byte[] someBytes = new byte[0];
diff --git a/sdk/common/src/main/java/io/opentelemetry/sdk/internal/SemConvAttributes.java b/sdk/common/src/main/java/io/opentelemetry/sdk/internal/SemConvAttributes.java
@@ -26,4 +26,7 @@ private SemConvAttributes() {}
       AttributeKey.stringKey("otel.component.name");
   // TODO: add semconv test
   public static final AttributeKey<String> ERROR_TYPE = AttributeKey.stringKey("error.type");
+
+  public static final AttributeKey<String> SERVER_ADDRESS = AttributeKey.stringKey("server.address");
+  public static final AttributeKey<Long> SERVER_PORT = AttributeKey.longKey("server.port");
 }
