GraphQL java instrumentation #5583

laurit · 2022-03-15T15:21:44Z

Resolves #4270
Unlike #4337, that attempted to generate the same kind of telemetry as js instrumentation, the instrumentation in this pr generates only a single span for each graphql request. I chose not to follow js implementation as in my opinion it didn't really align with our existing instrumentations. To understand what kind of spans are generated by js implementation it is easiest to look at their test.

[skip ci]

laurit · 2022-03-15T15:23:41Z

gradle-plugins/src/main/kotlin/io/opentelemetry/javaagent/muzzle/AcceptableVersions.kt

    return !draftVersion
  }

  companion object {
    private val GIT_SHA_PATTERN = Regex("^.*-[0-9a-f]{7,}$")
+    private val DATETIME_PATTERN = Regex("^\\d{4}-\\d{2}-\\d{2}t\\d{2}-\\d{2}-\\d{2}.*$")


graphql-java has a ton of weird versions https://repo1.maven.org/maven2/com/graphql-java/graphql-java/

laurit · 2022-03-15T15:26:30Z

...src/main/java/io/opentelemetry/javaagent/instrumentation/graphql/GraphqlInstrumentation.java

+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        namedOneOf("checkInstrumentationDefaultState", "checkInstrumentation")


These methods add default instrumentations. By applying our instrumentation after these our instrumentation will end up surrounding all other instrumentation.

laurit · 2022-03-15T15:27:16Z

.../src/main/java/io/opentelemetry/instrumentation/graphql/ExperimentalAttributesExtractor.java

+public class ExperimentalAttributesExtractor
+    implements AttributesExtractor<InstrumentationExecutionParameters, ExecutionResult> {
+  // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-graphql/src/enums/AttributeNames.ts
+  private static final AttributeKey<String> OPERATION_NAME =


these attributes are the same as in js instrumentation

laurit · 2022-03-15T15:28:47Z

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

+import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanStatusExtractor;
+
+@SuppressWarnings("AbbreviationAsWordInName")


as discussed on slack, for library instrumentation I used GraphQL which isn't allowed by our checkstyle rules

laurit · 2022-03-15T15:30:56Z

...ry/src/main/java/io/opentelemetry/instrumentation/graphql/GraphqlTracingInstrumentation.java

+
+          Span span = Span.fromContext(context);
+          for (GraphQLError error : result.getErrors()) {
+            AttributesBuilder attributes = Attributes.builder();


Record errors (validation and parse errors etc) as exceptions. I don't know whether this is ok.

I re-read the exceptions spec and it seems ok. Is this what JS implementation does?

As far as I understand they do something similar with validation errors https://github.com/open-telemetry/opentelemetry-js-contrib/blob/491588f7245e48268bea438cc475e87ae1ed8ad6/plugins/node/opentelemetry-instrumentation-graphql/src/instrumentation.ts#L385 but they don't seem to be doing anything with execution errors https://github.com/open-telemetry/opentelemetry-js-contrib/blob/491588f7245e48268bea438cc475e87ae1ed8ad6/plugins/node/opentelemetry-instrumentation-graphql/src/instrumentation.ts#L241

laurit · 2022-03-15T15:33:53Z

...12.0/testing/src/main/java/io/opentelemetry/instrumentation/graphql/AbstractGraphqlTest.java

+  void validationError() {
+    ExecutionResult result =
+        graphql.execute(
+            "" //


// prevents spotless from moving these to a single line. Alternatively could use // spotless:off which would need to be enabled with toggleOffOn()

Out of these two I think I'd probably prefer using // spotless:off for such use cases (though this one works too, I don't have a very strong opinion on that)

// spotless:off leaves less doubt about what the strange trailing slashes are for 👍

...12.0/testing/src/main/java/io/opentelemetry/instrumentation/graphql/AbstractGraphqlTest.java

...ry/src/main/java/io/opentelemetry/instrumentation/graphql/GraphqlTracingInstrumentation.java

...c/main/java/io/opentelemetry/instrumentation/graphql/GraphqlTracingInstrumentationState.java

...ry/src/main/java/io/opentelemetry/instrumentation/graphql/GraphqlTracingInstrumentation.java

trask · 2022-03-16T04:36:14Z

...ry/src/main/java/io/opentelemetry/instrumentation/graphql/GraphqlTracingInstrumentation.java

+
+          Span span = Span.fromContext(context);
+          for (GraphQLError error : result.getErrors()) {
+            AttributesBuilder attributes = Attributes.builder();


I re-read the exceptions spec and it seems ok. Is this what JS implementation does?

.../src/main/java/io/opentelemetry/instrumentation/graphql/ExperimentalAttributesExtractor.java

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

....0/library/src/main/java/io/opentelemetry/instrumentation/graphql/GraphQLTracingBuilder.java

...ary/src/main/java/io/opentelemetry/instrumentation/graphql/OpenTelemetryInstrumentation.java

...rc/main/java/io/opentelemetry/instrumentation/graphql/OpenTelemetryInstrumentationState.java

...ary/src/main/java/io/opentelemetry/instrumentation/graphql/OpenTelemetryInstrumentation.java

mateuszrzeszutek · 2022-03-16T10:52:17Z

...12.0/testing/src/main/java/io/opentelemetry/instrumentation/graphql/AbstractGraphqlTest.java

+  void validationError() {
+    ExecutionResult result =
+        graphql.execute(
+            "" //


Out of these two I think I'd probably prefer using // spotless:off for such use cases (though this one works too, I don't have a very strong opinion on that)

Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>

...12.0/testing/src/main/java/io/opentelemetry/instrumentation/graphql/AbstractGraphqlTest.java

trask · 2022-03-16T16:59:35Z

...12.0/testing/src/main/java/io/opentelemetry/instrumentation/graphql/AbstractGraphqlTest.java

+  void validationError() {
+    ExecutionResult result =
+        graphql.execute(
+            "" //


// spotless:off leaves less doubt about what the strange trailing slashes are for 👍

...ary/src/main/java/io/opentelemetry/instrumentation/graphql/OpenTelemetryInstrumentation.java

...gent/src/main/java/io/opentelemetry/javaagent/instrumentation/graphql/GraphqlSingletons.java

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

...ary/src/main/java/io/opentelemetry/instrumentation/graphql/OpenTelemetryInstrumentation.java

trask · 2022-03-17T15:55:54Z

🥳

jord1e · 2022-03-17T17:10:59Z

haha cool!

* GraphQL Java Initial Commit * [WIP] First steps for GraphQL instrumentation, totally not ready [skip ci] * GraphQL Java instrumentation * address review comments * Apply suggestions from code review Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com> * review feedback * scope handling * Apply suggestions from code review Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com> * use spotless:off * trigger build * review comments Co-authored-by: Jordie <xd@jrdie.nl> Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com> Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

jord1e and others added 3 commits March 15, 2022 16:03

GraphQL Java Initial Commit

f016d7b

[WIP] First steps for GraphQL instrumentation, totally not ready

1e953c4

[skip ci]

GraphQL Java instrumentation

48382ab

laurit requested a review from a team March 15, 2022 15:21

laurit commented Mar 15, 2022

View reviewed changes

trask reviewed Mar 16, 2022

View reviewed changes

address review comments

9b94a78

mateuszrzeszutek reviewed Mar 16, 2022

View reviewed changes

laurit and others added 3 commits March 16, 2022 14:30

Apply suggestions from code review

a1904fe

Co-authored-by: Mateusz Rzeszutek <mrzeszutek@splunk.com>

review feedback

72319b8

scope handling

a7d72b8

trask approved these changes Mar 16, 2022

View reviewed changes

laurit and others added 3 commits March 16, 2022 19:18

Apply suggestions from code review

dfc5f9d

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

use spotless:off

e5f7e2a

trigger build

5a13760

mateuszrzeszutek approved these changes Mar 17, 2022

View reviewed changes

...ary/src/main/java/io/opentelemetry/instrumentation/graphql/OpenTelemetryInstrumentation.java Outdated Show resolved Hide resolved

review comments

2eac6b2

mateuszrzeszutek approved these changes Mar 17, 2022

View reviewed changes

trask merged commit 2ebe912 into open-telemetry:main Mar 17, 2022

jord1e mentioned this pull request Mar 17, 2022

GraphQL Java Instrumentation #4337

Closed

laurit deleted the graphql-java-support branch March 17, 2022 19:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GraphQL java instrumentation #5583

GraphQL java instrumentation #5583

laurit commented Mar 15, 2022

laurit Mar 15, 2022

laurit Mar 15, 2022

laurit Mar 15, 2022

laurit Mar 15, 2022

laurit Mar 15, 2022

trask Mar 16, 2022

laurit Mar 16, 2022

laurit Mar 15, 2022

mateuszrzeszutek Mar 16, 2022

trask Mar 16, 2022

trask Mar 16, 2022

mateuszrzeszutek Mar 16, 2022

trask Mar 16, 2022

trask commented Mar 17, 2022

jord1e commented Mar 17, 2022

GraphQL java instrumentation #5583

GraphQL java instrumentation #5583

Conversation

laurit commented Mar 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trask commented Mar 17, 2022

jord1e commented Mar 17, 2022