merge main

Author: Duncan-tree-zhou

.fossa.yml

@@ -76,6 +76,9 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:apache-dubbo-2.7:library-autoconfigure'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:apache-elasticjob-3.0:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:apache-httpasyncclient-4.1:javaagent'
@@ -829,6 +832,9 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:opentelemetry-api:opentelemetry-api-1.52:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:opentelemetry-api:opentelemetry-api-1.56:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:opentelemetry-instrumentation-annotations:opentelemetry-instrumentation-annotations-1.16:javaagent'

.github/config/lychee.toml

@@ -1,5 +1,5 @@
 # Lychee configuration file
-# See https://lychee.cli.rs/config/
+# See https://lychee.cli.rs/guides/config/
 
 timeout = 30
 retry_wait_time = 5

.github/config/markdownlint.yml

@@ -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/copilot-instructions.md

@@ -189,7 +189,22 @@
       enabled: false,
     },
     {
-      // intentionally using Spring Boot 2 in these smoke tests
+      // intentionally using Spring Boot 2 to make sure the earliest version is supported
+      matchFileNames: [
+        'smoke-tests/images/spring-boot/build.gradle.kts',
+        'smoke-tests-otel-starter/spring-boot-2/build.gradle.kts',
+        'smoke-tests-otel-starter/spring-boot-common/build.gradle.kts',
+        'smoke-tests-otel-starter/spring-boot-reactive-2/build.gradle.kts',
+        'smoke-tests-otel-starter/spring-boot-reactive-common/build.gradle.kts',
+        'smoke-tests-otel-starter/spring-smoke-testing/build.gradle.kts',
+      ],
+      matchPackageNames: [
+        'org.springframework.boot:spring-boot-dependencies',
+      ],
+      enabled: false
+    },
+    {
+      // Spring Boot 2 smoke tests are intentionally using slf4j 1.x
       matchFileNames: [
         'smoke-tests/images/spring-boot/build.gradle.kts',
         'smoke-tests-otel-starter/spring-boot-2/build.gradle.kts',
@@ -200,7 +215,6 @@
       ],
       matchPackageNames: [
         'org.slf4j:slf4j-api',
-        'org.springframework.boot:**',
       ],
       matchUpdateTypes: [
         'major',
@@ -323,19 +337,6 @@
       ],
       allowedVersions: '/^1\\.3\\./',
     },
-    {
-      // intentionally using Spring Boot 2 in dependency management (for Java 8 support)
-      matchFileNames: [
-        'dependencyManagement/build.gradle.kts',
-      ],
-      matchUpdateTypes: [
-        'major',
-      ],
-      enabled: false,
-      matchPackageNames: [
-        'org.springframework.boot:spring-boot-dependencies:**',
-      ],
-    },
     {
       // pinned version to Jetty 8 (Servlet 3.0) for compatibility
       matchFileNames: [

.github/renovate.json5

@@ -14,7 +14,7 @@ private admin repo.
 - `GRADLE_PUBLISH_KEY` - owned by [@trask](https://github.com/trask)
 - `GRADLE_PUBLISH_SECRET` - owned by [@trask](https://github.com/trask)
 - `NVD_API_KEY` - stored in OpenTelemetry-Java 1Password
-  - Generated at https://nvd.nist.gov/developers/request-an-api-key
+  - Generated at <https://nvd.nist.gov/developers/request-an-api-key>
   - Key is associated with [@trask](https://github.com/trask)'s gmail address
 - `SONATYPE_KEY` - owned by [@trask](https://github.com/trask)
 - `SONATYPE_USER` - owned by [@trask](https://github.com/trask)

.github/repository-settings.md

@@ -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-javaagent-suppression-keys.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/check-package-names.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/diff-suppression-keys-with-docs.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) {