Merge branch 'main' of github.com:ghareeb-falazi/opentelemetry-java-instrumentation

Author: ghareeb-falazi

.github/renovate.json5

@@ -199,7 +199,7 @@
         'smoke-tests-otel-starter/spring-smoke-testing/build.gradle.kts',
       ],
       matchPackageNames: [
-        'org.springframework.boot:spring-boot-dependencies:**',
+        'org.springframework.boot:spring-boot-dependencies',
       ],
       enabled: false
     },

docs/instrumentation-list.yaml

@@ -527,6 +527,53 @@ libraries:
           type: STRING
         - name: rpc.system
           type: STRING
+  - name: apache-elasticjob-3.0
+    display_name: Apache ElasticJob
+    description: This instrumentation enables spans for Apache ElasticJob job executions.
+    library_link: https://shardingsphere.apache.org/elasticjob/
+    source_path: instrumentation/apache-elasticjob-3.0
+    scope:
+      name: io.opentelemetry.apache-elasticjob-3.0
+    target_versions:
+      javaagent:
+      - org.apache.shardingsphere.elasticjob:elasticjob-lite-core:[3.0.0,)
+    configurations:
+    - name: otel.instrumentation.apache-elasticjob.experimental-span-attributes
+      description: |
+        Enables experimental span attributes `job.system`, `scheduling.apache-elasticjob.job.name`, `scheduling.apache-elasticjob.task.id`, `scheduling.apache-elasticjob.sharding.item.index`, `scheduling.apache-elasticjob.sharding.total.count`, `scheduling.apache-elasticjob.sharding.item.parameter`, and `scheduling.apache-elasticjob.job.type`.
+      type: boolean
+      default: false
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: INTERNAL
+        attributes:
+        - name: code.function
+          type: STRING
+        - name: code.namespace
+          type: STRING
+    - when: otel.instrumentation.apache-elasticjob.experimental-span-attributes=true
+      spans:
+      - span_kind: INTERNAL
+        attributes:
+        - name: code.function
+          type: STRING
+        - name: code.namespace
+          type: STRING
+        - name: job.system
+          type: STRING
+        - name: scheduling.apache-elasticjob.job.name
+          type: STRING
+        - name: scheduling.apache-elasticjob.job.type
+          type: STRING
+        - name: scheduling.apache-elasticjob.sharding.item.index
+          type: LONG
+        - name: scheduling.apache-elasticjob.sharding.item.parameter
+          type: STRING
+        - name: scheduling.apache-elasticjob.sharding.total.count
+          type: LONG
+        - name: scheduling.apache-elasticjob.task.id
+          type: STRING
   - name: apache-httpasyncclient-4.1
     display_name: Apache HttpAsyncClient
     description: This instrumentation enables HTTP client spans and HTTP client metrics
@@ -6573,12 +6620,33 @@ libraries:
           type: STRING
   jfinal:
   - name: jfinal-3.2
+    display_name: JFinal
+    description: |
+      This instrumentation enriches HTTP server spans with route information, and enables controller spans for JFinal controller methods (controller spans are disabled by default).
+    library_link: https://github.com/jfinal/jfinal
+    features:
+    - HTTP_ROUTE
+    - CONTROLLER_SPANS
     source_path: instrumentation/jfinal-3.2
     scope:
       name: io.opentelemetry.jfinal-3.2
     target_versions:
       javaagent:
       - com.jfinal:jfinal:[3.2,)
+    configurations:
+    - name: otel.instrumentation.common.experimental.controller-telemetry.enabled
+      description: Enables the creation of experimental controller spans.
+      type: boolean
+      default: false
+    telemetry:
+    - when: default
+      spans:
+      - span_kind: INTERNAL
+        attributes:
+        - name: code.function
+          type: STRING
+        - name: code.namespace
+          type: STRING
   jms:
   - name: jms-1.1
     display_name: JMS (Java Message Service)

instrumentation-docs/instrumentations.sh

@@ -14,6 +14,8 @@ readonly INSTRUMENTATIONS=(
   "apache-dbcp-2.0:javaagent:test"
   "apache-dbcp-2.0:javaagent:testStableSemconv"
   "apache-dubbo-2.7:javaagent:testDubbo"
+  "apache-elasticjob-3.0:javaagent:test"
+  "apache-elasticjob-3.0:javaagent:testExperimental"
   "apache-httpasyncclient-4.1:javaagent:test"
   "apache-httpclient:apache-httpclient-2.0:javaagent:test"
   "apache-httpclient:apache-httpclient-4.0:javaagent:test"
@@ -148,6 +150,7 @@ readonly INSTRUMENTATIONS=(
   "jsf:jsf-myfaces-3.0:javaagent:test"
   "jsp-2.3:javaagent:test"
   "jsp-2.3:javaagent:testExperimental"
+  "jfinal-3.2:javaagent:test"
   "kafka:kafka-clients:kafka-clients-2.6:library:test"
   "kafka:kafka-connect-2.6:testing:test"
   "ktor:ktor-1.0:library:test"

instrumentation/apache-elasticjob-3.0/javaagent/build.gradle.kts

@@ -17,6 +17,20 @@ dependencies {
   testImplementation("org.apache.curator:curator-test:5.1.0")
 }
 
-tasks.withType<Test>().configureEach {
-  jvmArgs("-Dotel.instrumentation.apache-elasticjob.experimental-span-attributes=true")
+tasks {
+  withType<Test>().configureEach {
+    systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+  }
+
+  val testExperimental by registering(Test::class) {
+    testClassesDirs = sourceSets.test.get().output.classesDirs
+    classpath = sourceSets.test.get().runtimeClasspath
+
+    jvmArgs("-Dotel.instrumentation.apache-elasticjob.experimental-span-attributes=true")
+    systemProperty("metadataConfig", "otel.instrumentation.apache-elasticjob.experimental-span-attributes=true")
+  }
+
+  check {
+    dependsOn(testExperimental)
+  }
 }

instrumentation/apache-elasticjob-3.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/apacheelasticjob/v3_0/ElasticJobTest.java

@@ -11,7 +11,6 @@
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
 import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
 import static java.nio.charset.StandardCharsets.UTF_8;
-import static java.util.Arrays.asList;
 
 import com.sun.net.httpserver.HttpServer;
 import io.opentelemetry.api.trace.SpanKind;
@@ -28,8 +27,10 @@
 import java.net.InetSocketAddress;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
+import javax.annotation.Nullable;
 import org.apache.shardingsphere.elasticjob.api.JobConfiguration;
 import org.apache.shardingsphere.elasticjob.http.props.HttpJobProperties;
 import org.apache.shardingsphere.elasticjob.infra.env.IpUtils;
@@ -55,6 +56,9 @@ class ElasticJobTest {
   private static CoordinatorRegistryCenter regCenter;
   private static HttpServer httpServer;
 
+  private static final boolean EXPERIMENTAL_ATTRIBUTES_ENABLED =
+      Boolean.getBoolean("otel.instrumentation.apache-elasticjob.experimental-span-attributes");
+
   @BeforeAll
   static void init() throws Exception {
     // ip address detection in ElasticJob may fail to find a valid address, we skip the detection
@@ -150,7 +154,7 @@ void testSimpleJob() {
             regCenter,
             job,
             JobConfiguration.newBuilder("simpleElasticJob", 2)
-                .cron("0/5 * * * * ?")
+                .cron("0/30 * * * * ?")
                 .shardingItemParameters("0=A,1=B")
                 .build());
 
@@ -350,6 +354,11 @@ private static String buildScriptCommandLine() throws IOException {
     return tempScript.toString();
   }
 
+  @Nullable
+  private static <T> T experimental(T value) {
+    return EXPERIMENTAL_ATTRIBUTES_ENABLED ? value : null;
+  }
+
   private static List<AttributeAssertion> elasticJobAttributes(
       String jobName,
       long item,
@@ -358,16 +367,35 @@ private static List<AttributeAssertion> elasticJobAttributes(
       String codeFunction,
       String codeNamespace,
       String jobType) {
-    return asList(
-        equalTo(stringKey("code.function"), codeFunction),
-        equalTo(stringKey("code.namespace"), codeNamespace),
-        equalTo(stringKey("job.system"), "elasticjob"),
-        equalTo(stringKey("scheduling.apache-elasticjob.job.name"), jobName),
-        equalTo(stringKey("scheduling.apache-elasticjob.job.type"), jobType),
-        equalTo(longKey("scheduling.apache-elasticjob.sharding.item.index"), item),
-        equalTo(longKey("scheduling.apache-elasticjob.sharding.total.count"), totalCount),
-        equalTo(stringKey("scheduling.apache-elasticjob.sharding.item.parameter"), parameter),
+    List<AttributeAssertion> assertions = new ArrayList<>();
+
+    assertions.add(equalTo(stringKey("code.function"), codeFunction));
+    assertions.add(equalTo(stringKey("code.namespace"), codeNamespace));
+
+    assertions.add(equalTo(stringKey("job.system"), experimental("elasticjob")));
+    assertions.add(
+        equalTo(stringKey("scheduling.apache-elasticjob.job.name"), experimental(jobName)));
+    assertions.add(
+        equalTo(stringKey("scheduling.apache-elasticjob.job.type"), experimental(jobType)));
+    assertions.add(
+        equalTo(longKey("scheduling.apache-elasticjob.sharding.item.index"), experimental(item)));
+    assertions.add(
+        equalTo(
+            longKey("scheduling.apache-elasticjob.sharding.total.count"),
+            experimental(totalCount)));
+    assertions.add(
+        equalTo(
+            stringKey("scheduling.apache-elasticjob.sharding.item.parameter"),
+            experimental(parameter)));
+    assertions.add(
         satisfies(
-            stringKey("scheduling.apache-elasticjob.task.id"), taskId -> taskId.contains(jobName)));
+            stringKey("scheduling.apache-elasticjob.task.id"),
+            taskId -> {
+              if (EXPERIMENTAL_ATTRIBUTES_ENABLED) {
+                taskId.contains(jobName);
+              }
+            }));
+
+    return assertions;
   }
 }

instrumentation/apache-elasticjob-3.0/metadata.yaml

@@ -0,0 +1,13 @@
+display_name: Apache ElasticJob
+description: This instrumentation enables spans for Apache ElasticJob job executions.
+library_link: https://shardingsphere.apache.org/elasticjob/
+configurations:
+  - name: otel.instrumentation.apache-elasticjob.experimental-span-attributes
+    description: >
+      Enables experimental span attributes `job.system`, `scheduling.apache-elasticjob.job.name`,
+      `scheduling.apache-elasticjob.task.id`, `scheduling.apache-elasticjob.sharding.item.index`,
+      `scheduling.apache-elasticjob.sharding.total.count`,
+      `scheduling.apache-elasticjob.sharding.item.parameter`, and
+      `scheduling.apache-elasticjob.job.type`.
+    type: boolean
+    default: false

instrumentation/graphql-java/README.md

@@ -4,6 +4,7 @@
 |------------------------------------------------------------------------|---------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `otel.instrumentation.graphql.query-sanitizer.enabled`                 | Boolean | `true`  | Whether to remove sensitive information from query source that is added as span attribute.                                                                                                                              |
 | `otel.instrumentation.graphql.add-operation-name-to-span-name.enabled` | Boolean | `false` | Whether GraphQL operation name is added to the span name. <p>**WARNING**: GraphQL operation name is provided by the client and can have high cardinality. Use only when the server is not exposed to malicious clients. |
+| `otel.instrumentation.graphql.capture-query`                           | Boolean | `true`  | Whether to capture the query in `graphql.document` span attribute.                                                                                                                                                      |
 
 # Settings for the GraphQL 20 instrumentation
 

instrumentation/graphql-java/graphql-java-12.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/graphql/v12_0/GraphqlSingletons.java

@@ -13,6 +13,9 @@
 
 public final class GraphqlSingletons {
 
+  private static final boolean CAPTURE_QUERY =
+      AgentInstrumentationConfig.get()
+          .getBoolean("otel.instrumentation.graphql.capture-query", true);
   private static final boolean QUERY_SANITIZATION_ENABLED =
       AgentInstrumentationConfig.get()
           .getBoolean("otel.instrumentation.graphql.query-sanitizer.enabled", true);
@@ -23,6 +26,7 @@ public final class GraphqlSingletons {
 
   private static final GraphQLTelemetry TELEMETRY =
       GraphQLTelemetry.builder(GlobalOpenTelemetry.get())
+          .setCaptureQuery(CAPTURE_QUERY)
           .setSanitizeQuery(QUERY_SANITIZATION_ENABLED)
           .setAddOperationNameToSpanName(ADD_OPERATION_NAME_TO_SPAN_NAME)
           .build();

instrumentation/graphql-java/graphql-java-12.0/library/src/main/java/io/opentelemetry/instrumentation/graphql/v12_0/GraphQLTelemetry.java

@@ -28,10 +28,17 @@ public static GraphQLTelemetryBuilder builder(OpenTelemetry openTelemetry) {
   private final OpenTelemetryInstrumentationHelper helper;
 
   GraphQLTelemetry(
-      OpenTelemetry openTelemetry, boolean sanitizeQuery, boolean addOperationNameToSpanName) {
+      OpenTelemetry openTelemetry,
+      boolean captureQuery,
+      boolean sanitizeQuery,
+      boolean addOperationNameToSpanName) {
     helper =
         OpenTelemetryInstrumentationHelper.create(
-            openTelemetry, INSTRUMENTATION_NAME, sanitizeQuery, addOperationNameToSpanName);
+            openTelemetry,
+            INSTRUMENTATION_NAME,
+            captureQuery,
+            sanitizeQuery,
+            addOperationNameToSpanName);
   }
 
   /**

instrumentation/graphql-java/graphql-java-12.0/library/src/main/java/io/opentelemetry/instrumentation/graphql/v12_0/GraphQLTelemetryBuilder.java

@@ -14,13 +14,24 @@ public final class GraphQLTelemetryBuilder {
 
   private final OpenTelemetry openTelemetry;
 
+  private boolean captureQuery = true;
   private boolean sanitizeQuery = true;
   private boolean addOperationNameToSpanName = false;
 
   GraphQLTelemetryBuilder(OpenTelemetry openTelemetry) {
     this.openTelemetry = openTelemetry;
   }
 
+  /**
+   * Sets whether query should be captured in {@code graphql.document} span attribute. Default is
+   * {@code true}.
+   */
+  @CanIgnoreReturnValue
+  public GraphQLTelemetryBuilder setCaptureQuery(boolean captureQuery) {
+    this.captureQuery = captureQuery;
+    return this;
+  }
+
   /** Sets whether sensitive information should be removed from queries. Default is {@code true}. */
   @CanIgnoreReturnValue
   public GraphQLTelemetryBuilder setSanitizeQuery(boolean sanitizeQuery) {
@@ -45,6 +56,7 @@ public GraphQLTelemetryBuilder setAddOperationNameToSpanName(boolean addOperatio
    * GraphQLTelemetryBuilder}.
    */
   public GraphQLTelemetry build() {
-    return new GraphQLTelemetry(openTelemetry, sanitizeQuery, addOperationNameToSpanName);
+    return new GraphQLTelemetry(
+        openTelemetry, captureQuery, sanitizeQuery, addOperationNameToSpanName);
   }
 }