opentelemetry-ruby-contrib icon indicating copy to clipboard operation
opentelemetry-ruby-contrib copied to clipboard

fix: update GraphQL span name to follow semantic conventions

Open karmingc opened this issue 1 year ago • 5 comments

The semantic convention for GraphQL spans is specified here: https://opentelemetry.io/docs/specs/semconv/graphql/graphql-spans/. This will also resolve https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues/560.

karmingc avatar May 07 '24 19:05 karmingc

Where the names always wrong?

I will have to take a look at the spec but are there any expectations around backward compatibility like there is with HTTP or Messaging semantics?

cc: @rmosolgo

arielvalentin avatar May 10 '24 16:05 arielvalentin

Where the names always wrong?

I will have to take a look at the spec but are there any expectations around backward compatibility like there is with HTTP or Messaging semantics?

cc: @rmosolgo

@arielvalentin, all the GraphQL semantic conventions for spans are experimental. Breaking changes are allowed.

kaylareopelle avatar May 10 '24 16:05 kaylareopelle

👋 This pull request has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this pull request will be closed eventually by the stale bot

github-actions[bot] avatar Jun 14 '24 01:06 github-actions[bot]

Hi @karmingc! Whew, this has been a journey! I appreciate your patience.

We brought these questions to the semantic conventions repo. After some discussion, the decision was to change the span name to be graphql.operation.type by default, and to allow instrumentation authors to add a configuration option to append graphql.operation.name to the span name if a user opts in.

With this in mind, are you interested in updating this PR to fit with the new semantic convention? https://github.com/open-telemetry/semantic-conventions/pull/1389

kaylareopelle avatar Oct 10 '24 21:10 kaylareopelle

Hi @karmingc! Whew, this has been a journey! I appreciate your patience.

We brought these questions to the semantic conventions repo. After some discussion, the decision was to change the span name to be graphql.operation.type by default, and to allow instrumentation authors to add a configuration option to append graphql.operation.name to the span name if a user opts in.

With this in mind, are you interested in updating this PR to fit with the new semantic convention? open-telemetry/semantic-conventions#1389

Hi, I haven't had the chance to comment/reply for a while given that I am no longer involved on Ruby-related applications at work. However, I'm still open to fixing these! I'll try to update in the upcoming weeks if possible.

If somebody needs this to be prioritized, feel free to pick it up as well.

karmingc avatar Oct 10 '24 23:10 karmingc