Merge branch 'main' into feat/custom-client-resources

Author: 123liuziming

.github/copilot-instructions.md

@@ -0,0 +1,52 @@
+# OpenTelemetry Java Instrumentation
+
+## Testing
+
+Tests use AssertJ for assertions and JUnit 5 as the testing framework
+
+Test classes and methods should not be public
+
+When registering tests in gradle configurations, if using `val testName by registering(Test::class) {`...
+then you need to include `testClassesDirs` and `classpath` like so:
+
+```
+val testExperimental by registering(Test::class) {
+  testClassesDirs = sourceSets.test.get().output.classesDirs
+  classpath = sourceSets.test.get().runtimeClasspath
+  ...
+}
+```
+
+## General Java guidelines
+
+* Always import classes when possible (i.e. don't use fully qualified class names in code).
+
+## Gradle CLI
+
+Never use the `--rerun-tasks` flag unless explicitly asked to use this option.
+
+Gradle automatically detects changes and re-runs tasks automatically when needed. Using `--rerun-tasks`
+is wasteful and slows down builds unnecessarily.
+
+## Throwing exceptions
+
+When writing instrumentation, you have to be really careful about throwing exceptions. For library
+instrumentations it might be acceptable, but in javaagent code you shouldn't throw exceptions
+(keep in mind that javaagent instrumentations sometimes use library instrumentations).
+
+In javaagent instrumentations we try not to break applications. If there are changes in the instrumented
+library that are not compatible with the instrumentation we disable the instrumentation instead of letting
+it fail. This is handled by muzzle. In javaagent instrumentations you should not fail if the methods
+that you need don't exist.
+
+## Javaagent Instrumentation
+
+### Java8BytecodeBridge
+
+When to use `Java8BytecodeBridge.currentContext()` vs `Context.current()` ?
+
+Using `Context.current()` is preferred. `Java8BytecodeBridge.currentContext()` is for using inside
+advice. We need this method because advice code is inlined in the instrumented method as it is.
+Since `Context.current()` is a static interface method it will cause a bytecode verification error
+when it is inserted into a pre 8 class. `Java8BytecodeBridge.currentContext()` is a regular class
+static method and can be used in any class version.

.github/scripts/check-javaagent-suppression-keys.sh

@@ -1,6 +1,5 @@
 #!/bin/bash -e
 
-# shellcheck disable=SC2044
 for file in $(find instrumentation -name "*Module.java"); do
 
   if ! grep -q "extends InstrumentationModule" "$file"; then
@@ -11,9 +10,7 @@ for file in $(find instrumentation -name "*Module.java"); do
     continue
   fi
 
-  # shellcheck disable=SC2001
   module_name=$(echo "$file" | sed 's#.*/\([^/]*\)/javaagent/src/.*#\1#')
-  # shellcheck disable=SC2001
   simple_module_name=$(echo "$module_name" | sed 's/-[0-9.]*$//')
 
   if [[ "$simple_module_name" == *jaxrs* ]]; then

.github/scripts/check-package-names.sh

@@ -1,7 +1,5 @@
 #!/bin/bash -e
 
-# shellcheck disable=SC2001
-
 for dir in $(find instrumentation -name "*.java" | grep library/src/main/java | sed 's#/[^/]*$##' | sort -u); do
 
   module_name=$(echo "$dir" | sed 's#.*/\([^/]*\)/library/src/main/java/.*#\1#')

.github/scripts/diff-suppression-keys-with-docs.sh

@@ -9,7 +9,6 @@ curl https://raw.githubusercontent.com/open-telemetry/opentelemetry.io/main/cont
 
 comm -3 \
   <(
-    # shellcheck disable=SC2016 # "Expressions don't expand in single quotes"
     sed -n '/----------------------/,${p;/^$/q}' agent-config.md \
       | sed '1d;$d' \
       | cut -d '|' -f 3 \

.github/scripts/generate-release-contributors.sh

@@ -15,7 +15,6 @@ from=$(git log --reverse --pretty=format:"%cI" "$from_version..HEAD" | head -1)
 # get the last commit on main that was included in the release
 to=$(git merge-base origin/main HEAD | xargs git log -1 --pretty=format:"%cI")
 
-# shellcheck disable=SC2016 # "Expressions don't expand in single quotes"
 contributors1=$(gh api graphql --paginate -F q="repo:$GITHUB_REPOSITORY is:pr base:main is:merged merged:$from..$to" -f query='
 query($q: String!, $endCursor: String) {
   search(query: $q, type: ISSUE, first: 100, after: $endCursor) {
@@ -53,7 +52,6 @@ query($q: String!, $endCursor: String) {
 
 # this query captures authors of issues which have had PRs in the current range reference the issue
 # but not necessarily through closingIssuesReferences (e.g. addressing just a part of an issue)
-# shellcheck disable=SC2016 # "Expressions don't expand in single quotes"
 contributors2=$(gh api graphql --paginate -F q="repo:$GITHUB_REPOSITORY is:pr base:main is:merged merged:$from..$to" -f query='
 query($q: String!, $endCursor: String) {
   search(query: $q, type: ISSUE, first: 100, after: $endCursor) {

.github/scripts/static-import-semconv-constants.sh

@@ -1,6 +1,5 @@
 #!/bin/bash -e
 
-# shellcheck disable=SC2044
 for file in $(find instrumentation instrumentation-api -name '*Test.java'); do
   echo "Processing $file"
 

.github/workflows/auto-license-report.yml

@@ -12,9 +12,7 @@ permissions:
   contents: read
 
 jobs:
-  auto-license-report:
-    permissions:
-      contents: write
+  generate:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
@@ -33,16 +31,62 @@ jobs:
         with:
           cache-read-only: true
 
-      - name: Use CLA approved bot
-        run: .github/scripts/use-cla-approved-bot.sh
-
       - name: Update license report
         run: ./gradlew generateLicenseReport --no-build-cache
 
-      - name: Commit and push if there are changes
+      - id: create-patch
+        name: Create patch file
         run: |
-          git add licenses
-          if ! git diff --cached --quiet; then
-            git commit -m "Update license report"
-            git push
+          git diff > patch
+          if [ -s patch ]; then
+            echo "exists=true" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Upload patch file
+        if: steps.create-patch.outputs.exists == 'true'
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
+        with:
+          path: patch
+          name: patch
+
+  # separate job is just to isolate the OTELBOT_JAVA_INSTRUMENTATION_PRIVATE_KEY usage a bit
+  apply:
+    runs-on: ubuntu-latest
+    needs: generate
+    steps:
+      - name: Download patch
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
+        with:
+          path: ${{ runner.temp }}
+
+      - id: check-patch
+        name: Check patch
+        working-directory: ${{ runner.temp }}
+        run: |
+          if [ -f patch ]; then
+            echo "exists=true" >> $GITHUB_OUTPUT
           fi
+
+      - uses: actions/create-github-app-token@67018539274d69449ef7c02e8e71183d1719ab42 # v2.1.4
+        if: steps.check-patch.outputs.exists == 'true'
+        id: otelbot-token
+        with:
+          app-id: ${{ secrets.OTELBOT_JAVA_INSTRUMENTATION_APP_ID }}
+          private-key: ${{ secrets.OTELBOT_JAVA_INSTRUMENTATION_PRIVATE_KEY }}
+
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        if: steps.check-patch.outputs.exists == 'true'
+        with:
+          token: ${{ steps.otelbot-token.outputs.token }}
+
+      - name: Use CLA approved bot
+        if: steps.check-patch.outputs.exists == 'true'
+        run: .github/scripts/use-cla-approved-bot.sh
+
+      - name: Apply patch and push
+        if: steps.check-patch.outputs.exists == 'true'
+        run: |
+          git apply "${{ runner.temp }}/patch"
+          git add licenses
+          git commit -m "Update license report"
+          git push

.github/workflows/build-daily.yml

@@ -25,9 +25,6 @@ jobs:
   muzzle:
     uses: ./.github/workflows/reusable-muzzle.yml
 
-  shell-script-check:
-    uses: ./.github/workflows/reusable-shell-script-check.yml
-
   link-check:
     uses: ./.github/workflows/reusable-link-check.yml
 

.github/workflows/build-pull-request.yml

@@ -40,9 +40,6 @@ jobs:
     with:
       cache-read-only: true
 
-  shell-script-check:
-    uses: ./.github/workflows/reusable-shell-script-check.yml
-
   # this is not a required check to avoid blocking pull requests if external links break
   markdown-check:
     # release branches are excluded because the README.md javaagent download link has to be updated
@@ -66,7 +63,6 @@ jobs:
     needs:
       - common
       - muzzle
-      - shell-script-check
       - markdown-lint-check
     runs-on: ubuntu-latest
     if: always()
@@ -77,7 +73,6 @@ jobs:
             !startsWith(github.base_ref, 'release/') &&
             (
               needs.muzzle.result != 'success' ||
-              needs.shell-script-check.result != 'success' ||
               needs.markdown-lint-check.result != 'success'
             )
           )

.github/workflows/build.yml

@@ -34,11 +34,6 @@ jobs:
     if: "!startsWith(github.ref_name, 'release/')"
     uses: ./.github/workflows/reusable-muzzle.yml
 
-  shell-script-check:
-    # release branches are excluded to avoid unnecessary maintenance if new shell checks are added
-    if: "!startsWith(github.ref_name, 'release/')"
-    uses: ./.github/workflows/reusable-shell-script-check.yml
-
   link-check:
     # release branches are excluded to avoid unnecessary maintenance if external links break
     # (and also because the README.md javaagent download link has to be updated on release branches