Make akka-http-10.6 module optional to simplify local build. (#9767)

Author: AlexeyKuznetsov-DD

.gitlab-ci.yml

@@ -167,15 +167,14 @@ default:
   before_script:
     - source .gitlab/gitlab-utils.sh
     # Akka token added to SSM from https://account.akka.io/token
-    - export AKKA_REPO_TOKEN=$(aws ssm get-parameter --region us-east-1 --name ci.dd-trace-java.akka_repo_token --with-decryption --query "Parameter.Value" --out text)
+    - export ORG_GRADLE_PROJECT_akkaRepositoryToken=$(aws ssm get-parameter --region us-east-1 --name ci.dd-trace-java.akka_repo_token --with-decryption --query "Parameter.Value" --out text)
     - mkdir -p .gradle
     - export GRADLE_USER_HOME=$(pwd)/.gradle
     - |
       # Don't put jvm args here as it will be picked up by child gradle processes used in tests
       cat << EOF > $GRADLE_USER_HOME/gradle.properties
       mavenRepositoryProxy=$MAVEN_REPOSITORY_PROXY
       gradlePluginProxy=$GRADLE_PLUGIN_PROXY
-      akkaRepositoryToken=$AKKA_REPO_TOKEN
       EOF
     - |
       # replace maven central part by MAVEN_REPOSITORY_PROXY in .mvn/wrapper/maven-wrapper.properties

BUILDING.md

@@ -8,6 +8,7 @@ This documentation provides information for developers to set up their environme
   * [Install the required JDKs](#install-the-required-jdks)
   * [Install git](#install-git)
   * [Install Docker Desktop](#install-docker-desktop)
+  * [Configure Akka Token](#configure-akka-token)
 * [Clone the repository and set up git](#clone-the-repository-and-set-up-git)
 * [Building the project](#building-the-project)
 
@@ -248,6 +249,18 @@ winget install --id Docker.DockerDesktop
 > [!NOTE]
 > Both git configurations (hooks and submodule) will only be applied to this project and won't apply globally in your setup.
 
+### Configure Akka Token
+> [!NOTE]
+> You can skip this step if you don’t need instrumentation for the **akka-http-10.6** module.
+> For background on why Akka now requires authentication, see this [article](https://akka.io/blog/why-we-are-changing-the-license-for-akka).
+
+To enable access to Akka artifacts hosted on Lightbend’s private repository, you’ll need to configure an authentication token.
+1. Obtain a repository token. Visit the Akka account [page](https://account.akka.io/token) to generate a secure repository token.
+2. Set up the environment variable. Create an environment variable named:
+```shell
+  ORG_GRADLE_PROJECT_akkaRepositoryToken=<your_token>
+```
+
 ## Building the project
 
 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).

settings.gradle.kts

@@ -264,7 +264,7 @@ include(
   ":dd-java-agent:instrumentation:akka:akka-actor-2.5",
   ":dd-java-agent:instrumentation:akka:akka-http:akka-http-10.0",
   ":dd-java-agent:instrumentation:akka:akka-http:akka-http-10.2-iast",
-  ":dd-java-agent:instrumentation:akka:akka-http:akka-http-10.6",
+  // dd-java-agent:instrumentation:akka:akka-http:akka-http-10.6 will be included when `akkaRepositoryToken` is present, see next `include` block.
   ":dd-java-agent:instrumentation:apache-httpclient:apache-httpasyncclient-4.0",
   ":dd-java-agent:instrumentation:apache-httpclient:apache-httpclient-4.0",
   ":dd-java-agent:instrumentation:apache-httpclient:apache-httpclient-5.0",
@@ -613,6 +613,15 @@ include(
   ":dd-java-agent:instrumentation:zio:zio-2.0",
 )
 
+// Optional `akka-http-10.6` instrumentation (see BUILDING.md for how to enable it):
+if (providers.gradleProperty("akkaRepositoryToken").isPresent) {
+  include(
+    ":dd-java-agent:instrumentation:akka:akka-http:akka-http-10.6"
+  )
+} else {
+  logger.quiet("Omitting :dd-java-agent:instrumentation:akka:akka-http:akka-http-10.6: 'akkaRepositoryToken' not configured")
+}
+
 // benchmark
 include(
   ":dd-java-agent:benchmark",