Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Follow semantic conventions for naming graphql spans #560

Open
olliverberry opened this issue Jul 13, 2023 · 4 comments · May be fixed by #966
Open

Follow semantic conventions for naming graphql spans #560

olliverberry opened this issue Jul 13, 2023 · 4 comments · May be fixed by #966
Assignees
@karmingc
Labels
good first issue Good for newcomers help wanted Extra attention is needed keep Ensures stale-bot keeps this issue/PR open

Comments

@olliverberry
Copy link

The current graphql instrumentation does not follow span naming conventions detailed here. The documentation states the following:
The span name MUST be of the format <graphql.operation.type> <graphql.operation.name> provided that graphql.operation.type and graphql.operation.name are available. If graphql.operation.name is not available, the span SHOULD be named <graphql.operation.type>. When <graphql.operation.type> is not available, GraphQL Operation MAY be used as span name.

The relevant code looks to be here, where graphql.operation.type and graphql.operation.name are added as span attributes but the span is then named graphql.execute_query.

This change would also align with other libraries that already follow this convention, such as nodejs's instrumentation for graphql seen here.
@arielvalentin
Copy link
Collaborator

Would you be amenable to opening a PR to fix these?

@arielvalentin arielvalentin added good first issue Good for newcomers help wanted Extra attention is needed labels Jul 18, 2023
@github-actions
Copy link
Contributor

👋 This issue 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 issue will be closed eventually by the stale bot.

@github-actions github-actions bot added the stale Marks an issue/PR stale label Aug 18, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Dec 9, 2023
@karmingc
Copy link

karmingc commented May 6, 2024

@arielvalentin would it be possible to reopen this issue?

@arielvalentin arielvalentin reopened this May 6, 2024
@arielvalentin arielvalentin added keep Ensures stale-bot keeps this issue/PR open and removed stale Marks an issue/PR stale labels May 6, 2024
karmingc added a commit to karmingc/opentelemetry-ruby-contrib that referenced this issue May 7, 2024
@karmingc
fix: update GraphQL span name to follow semantic conventions
d0892d1 
The semantic convention for GraphQL spans is specified here: https://opentelemetry.io/docs/specs/semconv/graphql/graphql-spans/. This will also resolve open-telemetry#560.
@karmingc karmingc linked a pull request May 7, 2024 that will close this issue
Open
karmingc added a commit to karmingc/opentelemetry-ruby-contrib that referenced this issue May 7, 2024
@karmingc
fix: update GraphQL span name to follow semantic conventions
7d5b965 
The semantic convention for GraphQL spans is specified here: https://opentelemetry.io/docs/specs/semconv/graphql/graphql-spans/. This will also resolve open-telemetry#560.
karmingc added a commit to karmingc/opentelemetry-ruby-contrib that referenced this issue May 7, 2024
@karmingc
fix: update GraphQL span name to follow semantic conventions
b354b73 
The semantic convention for GraphQL spans is specified here: https://opentelemetry.io/docs/specs/semconv/graphql/graphql-spans/. This will also resolve open-telemetry#560.
karmingc added a commit to karmingc/opentelemetry-ruby-contrib that referenced this issue May 7, 2024
@karmingc
fix: update GraphQL span name to follow semantic conventions
a8356e5 
The semantic convention for GraphQL spans is specified here: https://opentelemetry.io/docs/specs/semconv/graphql/graphql-spans/. This will also resolve open-telemetry#560.
karmingc added a commit to karmingc/opentelemetry-ruby-contrib that referenced this issue May 7, 2024
@karmingc
fix: update GraphQL span name to follow semantic conventions
fc34086 
The semantic convention for GraphQL spans is specified here: https://opentelemetry.io/docs/specs/semconv/graphql/graphql-spans/. This will also resolve open-telemetry#560.
karmingc added a commit to karmingc/opentelemetry-ruby-contrib that referenced this issue May 8, 2024
@karmingc
fix: update GraphQL span name to follow semantic conventions
370af56 
The semantic convention for GraphQL spans is specified here: https://opentelemetry.io/docs/specs/semconv/graphql/graphql-spans/. This will also resolve open-telemetry#560.
@kaylareopelle
Copy link
Contributor

@karmingc - Since you're working on this via #966, I went ahead and assigned you to this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@karmingc karmingc

Labels
good first issue Good for newcomers help wanted Extra attention is needed keep Ensures stale-bot keeps this issue/PR open
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: update GraphQL span name to follow semantic conventions karmingc/opentelemetry-ruby-contrib
4 participants
@arielvalentin @karmingc @kaylareopelle @olliverberry