Merge pull request #2 from cyrille-leclerc/1874-transfer-listener

Iterate on OtelTransferListener

Author: smurf667

maven-extension/README.md

@@ -61,14 +61,15 @@ Without this setting, the traces won't be exported and the OpenTelemetry Maven E
 
 The Maven OpenTelemetry Extension supports a subset of the [OpenTelemetry autoconfiguration environment variables and JVM system properties](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure).
 
-| System property                           <br /> Environment variable                      | Default value           | Description                                                                                                                                     |
-|--------------------------------------------------------------------------------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
-| `otel.traces.exporter`                    <br /> `OTEL_TRACES_EXPORTER`                    | `none`                  | Select the OpenTelemetry exporter for tracing, the currently only supported values are `none` and `otlp`. `none` makes the instrumentation NoOp |
-| `otel.exporter.otlp.endpoint`             <br /> `OTEL_EXPORTER_OTLP_ENDPOINT`             | `http://localhost:4317` | The OTLP traces and metrics endpoint to connect to. Must be a URL with a scheme of either `http` or `https` based on the use of TLS.            |
-| `otel.exporter.otlp.headers`              <br /> `OTEL_EXPORTER_OTLP_HEADERS`              |                         | Key-value pairs separated by commas to pass as request headers on OTLP trace and metrics requests.                                              |
-| `otel.exporter.otlp.timeout`              <br /> `OTEL_EXPORTER_OTLP_TIMEOUT`              | `10000`                 | The maximum waiting time, in milliseconds, allowed to send each OTLP trace and metric batch.                                                    |
-| `otel.resource.attributes`                <br /> `OTEL_RESOURCE_ATTRIBUTES`                |                         | Specify resource attributes in the following format: key1=val1,key2=val2,key3=val3                                                              |
-| `otel.instrumentation.maven.mojo.enabled` <br /> `OTEL_INSTRUMENTATION_MAVEN_MOJO_ENABLED` | `true`                  | Whether to create spans for mojo goal executions, `true` or `false`. Can be configured to reduce the number of spans created for large builds.  |
+| System property                           <br /> Environment variable                              | Default value           | Description                                                                                                                                     |
+|----------------------------------------------------------------------------------------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
+| `otel.traces.exporter`                    <br /> `OTEL_TRACES_EXPORTER`                            | `none`                  | Select the OpenTelemetry exporter for tracing, the currently only supported values are `none` and `otlp`. `none` makes the instrumentation NoOp |
+| `otel.exporter.otlp.endpoint`             <br /> `OTEL_EXPORTER_OTLP_ENDPOINT`                     | `http://localhost:4317` | The OTLP traces and metrics endpoint to connect to. Must be a URL with a scheme of either `http` or `https` based on the use of TLS.            |
+| `otel.exporter.otlp.headers`              <br /> `OTEL_EXPORTER_OTLP_HEADERS`                      |                         | Key-value pairs separated by commas to pass as request headers on OTLP trace and metrics requests.                                              |
+| `otel.exporter.otlp.timeout`              <br /> `OTEL_EXPORTER_OTLP_TIMEOUT`                      | `10000`                 | The maximum waiting time, in milliseconds, allowed to send each OTLP trace and metric batch.                                                    |
+| `otel.resource.attributes`                <br /> `OTEL_RESOURCE_ATTRIBUTES`                        |                         | Specify resource attributes in the following format: key1=val1,key2=val2,key3=val3                                                              |
+| `otel.instrumentation.maven.mojo.enabled` <br /> `OTEL_INSTRUMENTATION_MAVEN_MOJO_ENABLED`         | `true`                  | Whether to create spans for mojo goal executions, `true` or `false`. Can be configured to reduce the number of spans created for large builds.  |
+| `otel.instrumentation.maven.transfer.enabled` <br /> `OTEL_INSTRUMENTATION_MAVEN_TRANSFER_ENABLED` | `false`                 | Whether to create spans for artifact transfers, `true` or `false`. Can be activated to understand impact of artifact transfers on performances. |
 
 ℹ️ The `service.name` is set to `maven` and the `service.version` to the version of the Maven runtime in use.
 

maven-extension/src/main/java/io/opentelemetry/maven/OpenTelemetrySdkService.java

@@ -80,7 +80,7 @@ public OpenTelemetrySdkService() {
         configProperties.getBoolean("otel.instrumentation.maven.mojo.enabled", true);
     // TODO maybe default would be false
     this.transferInstrumentationEnabled =
-        configProperties.getBoolean("otel.instrumentation.maven.transfer.enabled", true);
+        configProperties.getBoolean("otel.instrumentation.maven.transfer.enabled", false);
 
     this.tracer = openTelemetrySdk.getTracer("io.opentelemetry.contrib.maven", VERSION);
   }

maven-extension/src/main/java/io/opentelemetry/maven/OtelTransferListener.java

@@ -50,7 +50,7 @@ public final class OtelTransferListener extends AbstractTransferListener {
 
   @Override
   public void transferInitiated(TransferEvent event) {
-    logger.info("OpenTelemetry: OtelTransferListener#transferInitiated({})", event);
+    logger.debug("OpenTelemetry: OtelTransferListener#transferInitiated({})", event);
 
     String httpRequestMethod;
     switch (event.getRequestType()) {
@@ -64,7 +64,7 @@ public void transferInitiated(TransferEvent event) {
         httpRequestMethod = "HEAD";
         break;
       default:
-        logger.warn("OpenTelemetry: Unknown request type {}", event.getRequestType());
+        logger.warn("OpenTelemetry: Unknown request type {} for event {}", event.getRequestType(), event);
         httpRequestMethod = event.getRequestType().name();
     }
 
@@ -74,6 +74,7 @@ public void transferInitiated(TransferEvent event) {
 
     String spanName = httpRequestMethod + " " + urlTemplate;
 
+    // Build an HTTP client span as the http call itself is not instrumented.
     SpanBuilder spanBuilder =
         this.openTelemetrySdkService
             .getTracer()
@@ -85,7 +86,8 @@ public void transferInitiated(TransferEvent event) {
                 event.getResource().getRepositoryUrl() + event.getResource().getResourceName())
             .setAttribute(UrlIncubatingAttributes.URL_TEMPLATE, urlTemplate)
             .setAttribute(
-                MavenOtelSemanticAttributes.MAVEN_TRANSFER_TYPE, event.getRequestType().name());
+                MavenOtelSemanticAttributes.MAVEN_TRANSFER_TYPE, event.getRequestType().name())
+            .setAttribute(MavenOtelSemanticAttributes.MAVEN_RESOURCE_NAME, event.getResource().getResourceName());
 
     repositoryUriMapping
         .computeIfAbsent(
@@ -113,7 +115,7 @@ public void transferInitiated(TransferEvent event) {
 
   @Override
   public void transferSucceeded(TransferEvent event) {
-    logger.info("OpenTelemetry: OtelTransferListener#transferSucceeded({})", event);
+    logger.debug("OpenTelemetry: OtelTransferListener#transferSucceeded({})", event);
 
     Optional.ofNullable(spanRegistry.removeSpan(event))
         .ifPresent(
@@ -125,14 +127,14 @@ public void transferSucceeded(TransferEvent event) {
 
   @Override
   public void transferFailed(TransferEvent event) {
-    logger.info("OpenTelemetry: OtelTransferListener#transferFailed({})", event);
+    logger.debug("OpenTelemetry: OtelTransferListener#transferFailed({})", event);
 
     Optional.ofNullable(spanRegistry.removeSpan(event)).ifPresent(span -> fail(span, event));
   }
 
   @Override
   public void transferCorrupted(TransferEvent event) {
-    logger.info("OpenTelemetry: OtelTransferListener#transferCorrupted({})", event);
+    logger.debug("OpenTelemetry: OtelTransferListener#transferCorrupted({})", event);
 
     Optional.ofNullable(spanRegistry.removeSpan(event)).ifPresent(span -> fail(span, event));
   }

maven-extension/src/main/java/io/opentelemetry/maven/semconv/MavenOtelSemanticAttributes.java

@@ -58,6 +58,9 @@ public class MavenOtelSemanticAttributes {
   /** See {@link TransferEvent.RequestType}. */
   public static final AttributeKey<String> MAVEN_TRANSFER_TYPE =
       AttributeKey.stringKey("maven.transfer.type");
+  /** See {@link org.eclipse.aether.transfer.TransferResource}. */
+  public static final AttributeKey<String> MAVEN_RESOURCE_NAME =
+      AttributeKey.stringKey("maven.resource.name");
 
   public static final String SERVICE_NAME_VALUE = "maven";