Merge branch 'master' into dougqh/advice-annotation-checking

Author: dougqh

.circleci/config.continue.yml.j2

@@ -36,7 +36,7 @@ instrumentation_modules: &instrumentation_modules "dd-java-agent/instrumentation
 debugger_modules: &debugger_modules "dd-java-agent/agent-debugger|dd-java-agent/agent-bootstrap|dd-java-agent/agent-builder|internal-api|communication|dd-trace-core"
 profiling_modules: &profiling_modules "dd-java-agent/agent-profiling"
 
-default_system_tests_commit: &default_system_tests_commit c87bd359aad64a29f280fc5c70a879f7c7f4846e
+default_system_tests_commit: &default_system_tests_commit 53d9b2c43876a39e5c0426f4df4dd5fd79d062e8
 
 parameters:
   nightly:
@@ -971,19 +971,20 @@ jobs:
             cd system-tests
             set +e
             RUN_ATTEMPTS=1
-            while [ $RUN_ATTEMPTS -le 3 ]; do
+            MAX_ATTEMPTS=1 # Disable retries as the runner is supposed to be stable. Revert to 3 if needed.
+            while [ $RUN_ATTEMPTS -le $MAX_ATTEMPTS ]; do
               echo "Running parametric test attempt $RUN_ATTEMPTS"
-              timeout 20m ./run.sh PARAMETRIC -L java --log-cli-level=DEBUG --durations=30 -vv
+              timeout 20m ./run.sh PARAMETRIC --library java --durations=30 -vv
               status=$?
-              #timneout returns 124 if it times out
-              #if the return code is not 124, then we exit with the status
+              # timeout returns 124 if it times out
+              # if the return code is not 124, then we exit with the status
               if [ $status -ne 124 ]; then
                 exit $status
                 break
               fi
               RUN_ATTEMPTS=$((RUN_ATTEMPTS+1))
-              if [ $RUN_ATTEMPTS -eq 4 ]; then
-                #Max attempts reached, exit with 124
+              if [ $RUN_ATTEMPTS -gt $MAX_ATTEMPTS ]; then
+                # Max attempts reached, exit with 124
                 exit 124
               fi
             done
@@ -994,9 +995,11 @@ jobs:
       - run:
           name: Collect artifacts
           command: tar -cvzf logs_java_parametric_dev.tar.gz -C system-tests logs_parametric
+          when: always
 
       - store_artifacts:
           path: logs_java_parametric_dev.tar.gz
+          when: always
 
 
 build_test_jobs: &build_test_jobs

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Bug Report
+    url: https://help.datadoghq.com/hc/en-us/requests/new?tf_1260824651490=pt_product_type:apm&tf_1900004146284=pt_apm_language:java
+    about: This option creates an expedited Bug Report via the helpdesk (no login required). This will allow us to look up your account and allows you to provide additional information in private.
+  - name: Feature Request
+    url: https://help.datadoghq.com/hc/en-us/requests/new?tf_1260824651490=pt_product_type:apm&tf_1900004146284=pt_apm_language:java&tf_1260825272270=pt_apm_category_feature_request
+    about: This option creates an expedited Feature Request via the helpdesk (no login required). This helps with prioritization and allows you to provide additional information in private.

.github/workflows/analyze-changes.yaml

@@ -132,7 +132,7 @@ jobs:
           ls -laR "./workspace/.trivy"
 
       - name: Run Trivy security scanner
-        uses: aquasecurity/trivy-action@6e7b7d1fd3e4fef0c5fa8cce1229c54b2c9bd0d8 # v0.24.0
+        uses: aquasecurity/trivy-action@915b19bbe73b92a6cf82a1bc12b087c9a19a5fe2 # v0.28.0
         with:
           scan-type: rootfs
           scan-ref: './workspace/.trivy/'

.github/workflows/update-gradle-dependencies.yaml

@@ -77,5 +77,5 @@ jobs:
             --base master \
             --head $BRANCH_NAME \
             --label "tag: dependencies" \
-            --label "tag: no release notes"
+            --label "tag: no release notes" \
             --body-file -

.gitlab-ci.yml

@@ -216,10 +216,8 @@ package-oci:
 onboarding_tests_installer:
   parallel:
     matrix:
-      - ONBOARDING_FILTER_WEBLOG: [test-app-java, test-app-java-container, test-app-java-container-jdk15, test-app-java-alpine]
+      - ONBOARDING_FILTER_WEBLOG: [test-app-java, test-app-java-container, test-app-java-alpine]
         SCENARIO: [ SIMPLE_INSTALLER_AUTO_INJECTION, SIMPLE_AUTO_INJECTION_PROFILING ]
-      - ONBOARDING_FILTER_WEBLOG: [test-app-java-buildpack]
-        SCENARIO: [ SIMPLE_INSTALLER_AUTO_INJECTION ]
 
 onboarding_tests_k8s_injection:
   variables:

BUILDING.md

@@ -1,16 +1,16 @@
 
 # Building
 
-This documentation is dedicated to developers to setup their environment, and build the project from sources:
+This documentation provides information for developers to set up their environment and build their project from sources.
 
-* Check your development environment is ready to build,
-* Check the development environment requirements,
-* Guide - How to setup your development environment,
-* Guide - How to build the project.
+* [Development environment quick check](#development-environment-quick-check)
+* [Environment requirements quick check](#environment-requirements-quick-check)
+* [Development environment set up](#development-environment-set-up)
+* [Project build](#project-build)
 
 ## Development environment quick check
 
-To check that your development environment is properly set up to build the project, you will eventually run `./setup.sh` from the project root and should have its output look something like this:
+To check that your development environment is properly set up to build the project, run `./setup.sh` from the project root. Your output should look something like the following.
 
 ```bash
 $ ./setup.sh
@@ -31,110 +31,106 @@ $ ./setup.sh
 ✅ The Docker server is running.
 ```
 
-If the script finds any issue, you can check the requirements and follow the guide below to install and configure the required tools.
+If there is any issue with your output, you can check the requirements and/or follow the guide below to install and configure the required tools.
 
-## Building requirements
+## Environment requirements quick check
 
-To build the full project:
+Requirements to build the full project:
 
-* The JDK versions 8, 11, 17 and 21 must be installed
-* The `JAVA_8_HOME`, `JAVA_11_HOME`, `JAVA_17_HOME`, `JAVA_21_HOME` and `JAVA_GRAALVM17_HOME` must point to their respective JDK location,
+* The JDK versions 8, 11, 17 and 21 must be installed.
+* The `JAVA_8_HOME`, `JAVA_11_HOME`, `JAVA_17_HOME`, `JAVA_21_HOME` and `JAVA_GRAALVM17_HOME` must point to their respective JDK location.
 * The JDK-8 `bin` directory must be the only JDK on the PATH (e.g. `$JAVA_8_HOME/bin`).
-* The `JAVA_HOME` environment variable may be unset. If set, it must point to the JDK 8 location (same as `JAVA_8_HOME`),
-* The `git` command line must be installed,
-* A container runtime environment must be available to run all tests (usually Docker Desktop). 
+* The `JAVA_HOME` environment variable may be unset. If set, it must point to the JDK 8 location (same as `JAVA_8_HOME`).
+* The `git` command line must be installed.
+* A container runtime environment must be available to run all tests (e.g. Docker Desktop).
 
-
-## Setting up development environment
+## Development environment set up
 
 ### Install the required JDKs
 
 **On MacOS:**
 
-* Install the required JDKs using `brew`:  
+* Install the required JDKs using `brew`.
 `brew install --cask zulu@8 zulu@11 zulu@17 zulu@21 graalvm/tap/graalvm-ce-java17`
-* Fix the GraalVM installation by [removing the quarantine flag](https://www.graalvm.org/latest/docs/getting-started/macos/):  
+* Fix the GraalVM installation by [removing the quarantine flag](https://www.graalvm.org/latest/docs/getting-started/macos/).
 `sudo xattr -r -d com.apple.quarantine /Library/Java/JavaVirtualMachines/graalvm-<current version of graalvm>`
-* Add the required environment variables to your shell using the `export` command:
+* Add the required environment variables to your shell using the `export` command. You can permanently install the environment variables by appending the `export` commands into your shell configuration file `~/.zshrc` or `.bashrc` or other.
 ```shell
 export JAVA_8_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home  
 export JAVA_11_HOME=/Library/Java/JavaVirtualMachines/zulu-11.jdk/Contents/Home
 export JAVA_17_HOME=/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home
 export JAVA_21_HOME=/Library/Java/JavaVirtualMachines/zulu-21.jdk/Contents/Home
-export JAVA_GRAALVM17_HOME=/Library/Java/JavaVirtualMachines/graalvm-<current version of grallvm>/Contents/Home
+export JAVA_GRAALVM17_HOME=/Library/Java/JavaVirtualMachines/graalvm-<current version of graalvm>/Contents/Home
 export JAVA_HOME=$JAVA_8_HOME
 ```
+* Restart your shell after applying the changes if you appended the commands to your shell configuration file.
 
 > [!NOTE] 
-> ARM users, there is no Oracle JDK v8 for ARM. 
+> ARM users: there is no Oracle JDK v8 for ARM. 
 > It's recommended to use [Azul's Zulu](https://www.azul.com/downloads/?version=java-8-lts&architecture=arm-64-bit&package=jdk#zulu) builds of Java 8.
 > [Amazon Corretto](https://aws.amazon.com/corretto/) builds have also been proven to work.
 
 > [!NOTE]
-> MacOS users, remember that `/usr/libexec/java_home` may control which JDK is in your path.
-
-> [!NOTE]
-> You can permanently install the environment variables by appending the `export` commands into your shell configuration file `~/.zshrc` (or `.bashrc` dependening of your shell).
-> You will need to restart your shell first to apply the changes.
+> MacOS users: remember that `/usr/libexec/java_home` may control which JDK is in your path.
 
 **On Linux:**
 
-* Download and extract JDK 8, 11, 17 and 21 from [Eclipse Temurin releases](https://adoptium.net/temurin/releases/) and GraalVM from [Oracle downloads](https://www.graalvm.org/downloads/),
-* Install the GraalVM native image requirements for native builds following [the GraalVM official documentation](https://www.graalvm.org/latest/reference-manual/native-image/#prerequisites),
-* Add the required environment variables to your shell using the `export` command:
+* Download and extract JDK 8, 11, 17 and 21 from [Eclipse Temurin releases](https://adoptium.net/temurin/releases/) and GraalVM from [Oracle downloads](https://www.graalvm.org/downloads/).
+* Install the GraalVM native image requirements for native builds by following [the GraalVM official documentation](https://www.graalvm.org/latest/reference-manual/native-image/#prerequisites).
+* Add the required environment variables to your shell using the `export` command. You can permanently install the environment variables by appending the `export` commands into your shell configuration file `~/.zshrc` or `~/.bashrc` or other. 
 ```shell
 export JAVA_8_HOME=/<path to extracted archive>/jdk8u<current version of JDK 8>
 export JAVA_11_HOME=/<path to extracted archive>/jdk-11.<current version of JDK 11>
 export JAVA_17_HOME=/<path to extracted archive>/jdk-17.<current version of JDK 17>
 export JAVA_21_HOME=/<path to extracted archive>/jdk-21.<current version of JDK 21>
-export JAVA_GRAALVM17_HOME=/<path to extracted archive>/graalvm-jdk-17.<current version of grallvm>/Contents/Home
+export JAVA_GRAALVM17_HOME=/<path to extracted archive>/graalvm-jdk-17.<current version of graalvm>/Contents/Home
 export JAVA_HOME=$JAVA_8_HOME
 ```
-
-> [!NOTE]
-> You can permanently install the environment variables by appending the `export` commands into your shell configuration file `~/.zshrc` (or `.bashrc` dependening of your shell).
-> You will need to restart your shell first to apply the changes.
+* Restart your shell after applying the changes if you appended the commands to your shell configuration file.
 
 **On Windows:**
 
-* Download and install JDK 8, 11, 17 and 21 from [Eclipse Temurin releases](https://adoptium.net/temurin/releases/) and GraalVM from [Oracle downloads](https://www.graalvm.org/downloads/),
-* Install the GraalVM native image requirements for native builds following [the GraalVM official documentation](https://www.graalvm.org/latest/docs/getting-started/windows/#prerequisites-for-native-image-on-windows),
-* Add the required environment variables:
-  * Open the *Start Menu*, type `environment variable` and open the *System Properties* using the *Edit environment variable for your account* entry,
-  * Add new entries to the table:
-    * `JAVA_8_HOME` to the JDK 8 installation folder, usually `C:\Program Files\Eclipse Adoptium\jdk-<current version of Java 8>-hotspot\bin`,
-    * `JAVA_11_HOME`, `JAVA_21_HOME`, and `JAVA_21_HOME` similarly to their respective installation `bin` folders,
-    * `JAVA_GRAALVM17_HOME` to the GraalVM installation folder, usually `C:\Program Files\Java\<current version of graalvm>\bin`.
+* Download and install JDK 8, 11, 17 and 21 from [Eclipse Temurin releases](https://adoptium.net/temurin/releases/) and GraalVM from [Oracle downloads](https://www.graalvm.org/downloads/).
+* Install the GraalVM native image requirements for native builds by following [the GraalVM official documentation](https://www.graalvm.org/latest/docs/getting-started/windows/#prerequisites-for-native-image-on-windows).
+* Add the required environment variables.
+  * Open the *Start Menu*, type `environment variable`, and use the *Edit environment variable for your account* entry to open the *System Properties*.
+  * Add new entries to the table.
+    * `JAVA_8_HOME` to the JDK 8 installation folder, usually `C:\Program Files\Eclipse Adoptium\jdk-<current version of Java 8>-hotspot\bin`
+    * `JAVA_11_HOME`, `JAVA_21_HOME`, and `JAVA_21_HOME` similarly to their respective installation `bin` folders
+    * `JAVA_GRAALVM17_HOME` to the GraalVM installation folder, usually `C:\Program Files\Java\<current version of graalvm>\bin`
 
 ### Install git
 
-**On MacOS**, you can trigger the installation running any `git` command from the terminal, like `git --version`.
-If not installed, it will prompt you to install it.
+**On MacOS:** 
+
+You can trigger the installation by running any `git` command from the terminal, e.g. `git --version`.
+If not installed, the terminal will prompt you to install it.
 
-**On Linux**, use `# apt-get install git` command.
+**On Linux:**
+
+Run `apt-get install git`.
+
+**On Windows:** 
 
-**On Windows**, [download and install the installer from the offical website](https://git-scm.com/download/win).
+Download and install [the installer](https://git-scm.com/download/win) from the official website.
 
 ### Install Docker Desktop
 
 Download and install Docker Desktop from the offical website for [MacOS](https://docs.docker.com/desktop/install/mac-install/), [Linux](https://docs.docker.com/desktop/install/linux-install/) or [Windows](https://docs.docker.com/desktop/install/windows-install/).
 
 > [!NOTE]
-> Docker Desktop is the recommended container runtime environment but you can use any other environment to run testcontainers tests.
+> Docker Desktop is the recommended container runtime environment, but you can use any other environment to run testcontainers tests.
 > Check [the testcontainers container runtime requirements](https://java.testcontainers.org/supported_docker_environment/) for more details.
 
-### Clone the repository and setup git
+### Clone the repository and set up git
 
-First get a copy of the project.
-Start a terminal into your workspace and clone the repository using git:
+* Get a copy of the project.
+  * In your workspace, clone the repository using git.
 ```bash
 git clone --recurse-submodules [email protected]:DataDog/dd-trace-java.git
 ```
-
-Then, install the project git hooks:
-
-There is a pre-commit hook setup to verify formatting before committing. It can be activated with this command:
-
+* Install the project git hooks.
+  * There is a pre-commit hook setup to verify formatting before committing. It can be activated with the following command.
 ```bash
 # On MacOS and Linux
 cd dd-trace-java
@@ -146,13 +142,13 @@ copy .githooks/pre-comit .git/hooks/
 ```
 
 > [!TIP]
-> You can alternative use the `core.hooksPath` configuration to point to the `.githooks` folder using `git config --local core.hooksPath .githooks` if you don't already have a hooks path already defined system-wide.
+> You can alternatively use the `core.hooksPath` configuration to point to the `.githooks` folder using `git config --local core.hooksPath .githooks` if you don't already have a hooks path defined system-wide.
 
 > [!NOTE]
-> The git hooks will check your code is properly formatted before commiting it.
-> This is done both to avoid future merge conflict and ensure an uniformity inside the code base.
+> The git hooks will check that your code is properly formatted before commiting.
+> This is done both to avoid future merge conflict and ensure uniformity inside the code base.
 
-Finally, configure git to automatically update submodules:
+* Configure git to automatically update submodules.
 ```bash
 git config --local submodule.recurse true
 ```
@@ -163,42 +159,42 @@ git config --local submodule.recurse true
 
 > [!TIP]
 > This will keep the submodule in `dd-java-agent/agent-jmxfetch/integrations-core` up-to-date.
-> There is also an automated check when opening a pull request if you are trying to submit an module version change (usually an outdated version).
+> There is also an automated check when opening a pull request if you are trying to submit a module version change (usually an outdated version).
 
 > [!NOTE]
-> Both git configurations (hooks and submodule) will only be applied to the project and won't apply globally to your setup.
+> Both git configurations (hooks and submodule) will only be applied to this project and won't apply globally in your setup.
 
 ### Check your development environment
 
-If you properly followed this guide, the `setup.sh` script at the project root should run without issue, confirming everything is properly setup.
+You can confirm that your development environment is properly set up using the [quick check](#development-environment-quick-check) `setup.sh` script.
 
 > [!NOTE] 
 > The `setup.sh` script is only available for MacOS and Linux.
 
 ### Build the project
 
-Now everything is setup, you can then move the next section to start a build, or check [the contribution guidelines](CONTRIBUTING.md).
+After everything is properly set up, you can move on to the next section to start a build or check [the contribution guidelines](CONTRIBUTING.md).
 
-## Building commands
+## Project build
 
-To build the project without running tests run:
+To build the project without running tests, run:
 ```bash
 ./gradlew clean assemble
 ```
 
-To build the entire project with tests (this can take a very long time) run:
+To build the entire project with tests (this can take a very long time), run:
 ```bash
 ./gradlew clean build
 ```
 
 >[!NOTE]
 > Running the complete test suite on a local development environment can be challenging.
-> It might take a very long time, and you might encounter few flaky tests along the way.
-> It is recommended to only run the tests related to your changes locally, and leave the whole test suite to the continuous integration platform.
+> It may take a very long time, and you might encounter a few flaky tests along the way.
+> It is recommended to only run the tests related to your changes locally and leave running the whole test suite to the continuous integration platform.
 
-To build the JVM agent artifact only run:
+To build the JVM agent artifact only, run:
 ```bash
 ./gradlew :dd-java-agent:shadowJar
 ```
 
-After building the project, you can find the built JVM agent artifact into the `dd-java-agent/build/libs` folder.
+After building the project, you can find the built JVM agent artifact in the `dd-java-agent/build/libs` folder.