Merge pull request #1566 from microsoft/trask/otel-fork-updated

Update otel-fork

.github/workflows/build-grpc-smoke-dist.yaml

@@ -19,7 +19,7 @@ jobs:
           java-version: 11
 
       - name: Cache gradle dependencies
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: grpc-smoke
 

.github/workflows/build-play-smoke-dist.yaml

@@ -19,7 +19,7 @@ jobs:
           java-version: 11
 
       - name: Cache gradle dependencies
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: play-smoke
 

.github/workflows/build-smoke-dist-fakebackend.yaml

@@ -19,7 +19,7 @@ jobs:
           java-version: 11
 
       - name: Cache gradle dependencies
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: fakebackend-smoke
 

.github/workflows/build-springboot-smoke-dist.yaml

@@ -19,7 +19,7 @@ jobs:
           java-version: 11
 
       - name: Cache gradle dependencies
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: springboot-smoke
 

.github/workflows/build-test-matrix.yaml

@@ -5,11 +5,11 @@ on:
     paths:
       - 'smoke-tests/matrix/**'
       - '.github/workflows/build-test-matrix.yaml'
-    branches: 'main'
+    branches: ['main']
   workflow_dispatch:
 
 jobs:
-  publish:
+  buildLinux:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -19,7 +19,7 @@ jobs:
           java-version: 11
 
       - name: Cache gradle dependencies
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: matrix-smoke
 
@@ -34,5 +34,40 @@ jobs:
         run: |
           TAG="$(date '+%Y%m%d').$GITHUB_RUN_ID"
           echo "Using extra tag $TAG"
-          ./gradlew buildMatrix pushMatrix -PextraTag=$TAG
+          ./gradlew buildLinuxTestImages pushMatrix -PextraTag=$TAG
+        working-directory: smoke-tests/matrix
+
+  buildWindows:
+    runs-on: windows-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Support longpaths
+        run: git config --system core.longpaths true
+
+      - uses: actions/checkout@v2
+
+      - name: Set up JDK 11 for running Gradle
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+
+      - name: Cache gradle dependencies
+        uses: burrunan/gradle-cache-action@v1.10
+        with:
+          job-id: matrix-smoke
+
+      - name: Login to GitHub Package Registry
+        uses: azure/docker-login@v1
+        with:
+          login-server: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GHCR_TOKEN }}
+
+      - name: Build Docker Image
+        run: |
+          TAG="$(date '+%Y%m%d').$GITHUB_RUN_ID"
+          echo "Using extra tag $TAG"
+          ./gradlew buildWindowsTestImages pushMatrix -PextraTag=$TAG
         working-directory: smoke-tests/matrix

.github/workflows/ci.yaml

@@ -20,7 +20,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.5
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk11
 
@@ -43,7 +43,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk11
 
@@ -73,7 +73,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.5
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk${{ matrix.java }}
 

.github/workflows/nightly.yaml

@@ -20,7 +20,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk11
 
@@ -52,7 +52,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk${{ matrix.java }}
 
@@ -74,7 +74,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: latestDepTest
 
@@ -98,7 +98,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk11
 

.github/workflows/patch-release-build.yml

@@ -64,7 +64,7 @@ jobs:
               echo $word | sed 's/ *$//g' | sed 's/^ *//g' | git cherry-pick --stdin
           done
       - name: Build and publish artifacts
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk11
           remote-build-cache-proxy-enabled: false

.github/workflows/pr.yaml

@@ -16,7 +16,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk11
 
@@ -47,7 +47,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk11
 
@@ -77,7 +77,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk${{ matrix.java }}
 
@@ -108,7 +108,7 @@ jobs:
           java-version: 11
 
       - name: Restore cache
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: smokeTests
 

.github/workflows/release-build.yml

@@ -17,11 +17,11 @@ jobs:
         with:
           java-version: 11
       - name: Build and publish artifacts
-        uses: burrunan/gradle-cache-action@v1.6
+        uses: burrunan/gradle-cache-action@v1.10
         with:
           job-id: jdk11
           remote-build-cache-proxy-enabled: false
-          arguments: build final closeAndReleaseRepository --stacktrace -Prelease.version=${{ github.event.inputs.version }}
+          arguments: build final closeAndReleaseSonatypeStagingRepository --stacktrace -Prelease.version=${{ github.event.inputs.version }}
         env:
           BINTRAY_USER: ${{ secrets.BINTRAY_USER }}
           BINTRAY_API_KEY: ${{ secrets.BINTRAY_API_KEY }}

CONTRIBUTING.md

@@ -32,7 +32,7 @@ java -version
 
 and then you can find the java agent artifact at
 
-`javaagent/build/lib/opentelemetry-javaagent-<version>-all.jar`.
+`javaagent/build/libs/opentelemetry-javaagent-<version>-all.jar`.
 
 ### IntelliJ setup
 

README.md

@@ -74,21 +74,15 @@ configured to send data to
 at `http://localhost:4317`.
 
 Configuration parameters are passed as Java system properties (`-D` flags) or
-as environment variables. See below for a full list of environment variables. For example:
+as environment variables. See [the configuration documentation](/~https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/agent-config.md)
+for the full list of configuration items. For example:
 ```
 java -javaagent:path/to/opentelemetry-javaagent-all.jar \
+     -Dotel.resource.attributes=service.name=your-service-name \
      -Dotel.traces.exporter=zipkin \
      -jar myapp.jar
 ```
 
-Specify the external exporter JAR file using the `otel.exporter.jar` system property:
-```
-java -javaagent:path/to/opentelemetry-javaagent-all.jar \
-     -Dotel.exporter.jar=path/to/external-exporter.jar \
-     -jar myapp.jar
-```
-
-
 ## Configuring the Agent
 
 The agent is [highly configurable](docs/agent-config.md)!  Many aspects of the agent's behavior can be

benchmark-integration/run-perf-test.sh

@@ -126,7 +126,7 @@ header='Client Version'
 for label in "${test_order[@]}"; do
     header="$header,$label Latency,$label Throughput"
 done
-header="$header,Agent CPU Burn,Server CPU Burn,Agent RSS Delta,Server Max RSS,Server Start RSS,Server Load Increase RSS"
+header="$header,Server CPU Burn,Server Max RSS,Server Start RSS,Server Load Increase RSS"
 echo $header > $test_csv_file
 
 for agent_jar in $agent_jars; do

build.gradle

@@ -1,8 +1,9 @@
+import java.time.Duration
+
 plugins {
   id 'idea'
 
-  id "de.marcphilipp.nexus-publish" version "0.4.0" apply false
-  id "io.codearte.nexus-staging" version "0.22.0"
+  id "io.github.gradle-nexus.publish-plugin" version "1.0.0"
 
   id 'org.gradle.test-retry' version '1.2.0' apply false
 
@@ -19,15 +20,25 @@ plugins {
   id "net.ltgt.errorprone" version "1.3.0" apply false
 }
 
-nexusStaging {
+nexusPublishing {
   packageGroup = "io.opentelemetry"
-  username = System.getenv('SONATYPE_USER')
-  password = System.getenv('SONATYPE_KEY')
 
-  // We have many artifacts so Maven Central takes a long time on its compliance checks. This sets
-  // the timeout for waiting for the repository to close to a comfortable 50 minutes.
-  numberOfRetries = 300
-  delayBetweenRetriesInMillis = 10000
+  repositories {
+    sonatype {
+      username = System.getenv('SONATYPE_USER')
+      password = System.getenv('SONATYPE_KEY')
+    }
+  }
+
+  connectTimeout = Duration.ofMinutes(5)
+  clientTimeout = Duration.ofMinutes(5)
+
+  transitionCheckOptions {
+    // We have many artifacts so Maven Central takes a long time on its compliance checks. This sets
+    // the timeout for waiting for the repository to close to a comfortable 50 minutes.
+    maxRetries.set(300)
+    delayBetween.set(Duration.ofSeconds(10))
+  }
 }
 
 // Enable after verifying Maven Central publishing once through manual closing

docs/agent-config.md

@@ -1,32 +1,47 @@
-# Configuration parameters
+# Agent Configuration
 
 ## NOTE: subject to change!
 
-Note: These parameter names are very likely to change over time, so please check
-back here when trying out a new version! Please report any bugs or unexpected
-behavior you find.
+Note: The environment variables/system properties in this document are very likely to change over time.
+Please check back here when trying out a new version!
+
+Please report any bugs or unexpected behavior you find.
 
 ## Contents
 
 * [SDK Autoconfiguration](#sdk-autoconfiguration)
 * [Peer service name](#peer-service-name)
 * [DB statement sanitization](#db-statement-sanitization)
-* [Customizing the OpenTelemetry SDK](#customizing-the-opentelemetry-sdk)
 * [Suppressing specific auto-instrumentation](#suppressing-specific-auto-instrumentation)
 
 ## SDK Autoconfiguration
 
 The SDK's autoconfiguration module is used for basic configuration of the agent. Read the
-[docs](/~https://github.com/open-telemetry/opentelemetry-java/tree/v1.0.0/sdk-extensions/autoconfigure#customizing-the-opentelemetry-sdk)
+[docs](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure)
 to find settings such as configuring export or sampling.
 
+Here are some quick links into those docs for the configuration options for specific portions of the SDK & agent:
+
+* [Exporters](#exporters)
+  + [OTLP exporter (both span and metric exporters)](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#otlp-exporter-both-span-and-metric-exporters)
+  + [Jaeger exporter](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#jaeger-exporter)
+  + [Zipkin exporter](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#zipkin-exporter)
+  + [Prometheus exporter](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#prometheus-exporter)
+  + [Logging exporter](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#logging-exporter)
+* [Trace context propagation](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#propagator)
+* [OpenTelemetry Resource and service name](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#opentelemetry-resource)
+* [Batch span processor](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#batch-span-processor)
+* [Sampler](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#sampler)
+* [Span limits](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#span-limits)
+* [Using SPI to further configure the SDK](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/README.md#customizing-the-opentelemetry-sdk)
+
 ## Peer service name
 
 The [peer service name](/~https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/semantic_conventions/span-general.md#general-remote-service-attributes) is the name of a remote service being connected to. It corresponds to `service.name` in the [Resource](/~https://github.com/open-telemetry/opentelemetry-specification/tree/master/specification/resource/semantic_conventions#service) for the local service.
 
 | System property                      | Environment variable                 | Description                                                                      |
 |--------------------------------------|--------------------------------------|----------------------------------------------------------------------------------|
-| `otel.endpoint.peer.service.mapping` | `OTEL_ENDPOINT_PEER_SERVICE_MAPPING` | Used to specify a mapping from hostnames or IP addresses to peer services, as a comma-separated list of host=name pairs. The peer service is added as an attribute to a span whose host or IP match the mapping. For example, if set to 1.2.3.4=cats-service,dogs-abcdef123.serverlessapis.com=dogs-api, requests to `1.2.3.4` will have a `peer.service` attribute of `cats-service` and requests to `dogs-abcdef123.serverlessapis.com` will have an attribute of `dogs-api`. |
+| `otel.instrumentation.common.peer-service-mapping` | `OTEL_INSTRUMENTATION_COMMON_PEER_SERVICE_MAPPING` | Used to specify a mapping from hostnames or IP addresses to peer services, as a comma-separated list of host=name pairs. The peer service is added as an attribute to a span whose host or IP match the mapping. For example, if set to 1.2.3.4=cats-service,dogs-abcdef123.serverlessapis.com=dogs-api, requests to `1.2.3.4` will have a `peer.service` attribute of `cats-service` and requests to `dogs-abcdef123.serverlessapis.com` will have an attribute of `dogs-api`. |
 
 ## DB statement sanitization
 
@@ -42,17 +57,7 @@ The following property may be used to disable it:
 
 | System property                                       | Environment variable                                  | Description                                                         |
 |-------------------------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------|
-| `otel.instrumentation.db-statement-sanitizer.enabled` | `OTEL_INSTRUMENTATION_DB_STATEMENT_SANITIZER_ENABLED` | Enables the DB statement sanitization. The default value is `true`. |
-
-## Customizing the OpenTelemetry SDK
-
-*Customizing the SDK is highly advanced behavior and is still in the prototyping phase. It may change drastically or be removed completely. Use
-with caution*
-
-The OpenTelemetry SDK exposes SPI [hooks](/~https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/spi)
-for customizing its behavior, such as the `Resource` attached to spans or the `Sampler`.
-
-Because the automatic instrumentation runs in a different classpath than the instrumented application, it is not possible for customization in the application to take advantage of this customization. In order to provide such customization, you can provide the path to a JAR file, including an SPI implementation using the system property `otel.initializer.jar`. Note that this JAR needs to shade the OpenTelemetry API in the same way as the agent does. The simplest way to do this is to use the same shading configuration as the agent from [here](/~https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/cfade733b899a2f02cfec7033c6a1efd7c54fd8b/java-agent/java-agent.gradle#L39). In addition, you must specify the `io.opentelemetry.javaagent.shaded.io.opentelemetry.api.trace.spi.TraceProvider` to the name of the class that implements the SPI.
+| `otel.instrumentation.common.db-statement-sanitizer.enabled` | `OTEL_INSTRUMENTATION_COMMON_DB_STATEMENT_SANITIZER_ENABLED` | Enables the DB statement sanitization. The default value is `true`. |
 
 ## Suppressing specific auto-instrumentation