Skip to content

feat!: Update GraphQL span name convention#1389

Merged
lmolkova merged 9 commits intoopen-telemetry:mainfrom
kaylareopelle:update-graphql-span-name
Oct 10, 2024
Merged

feat!: Update GraphQL span name convention#1389
lmolkova merged 9 commits intoopen-telemetry:mainfrom
kaylareopelle:update-graphql-span-name

Conversation

@kaylareopelle
Copy link
Copy Markdown
Contributor

Fixes #1361

Changes

Due to concerns about high cardinality with the current span name format, use only the graphql.operation.type attribute for the span name. The higher cardinality attribute, graphql.operation.name can still be used in queries, as it is an attribute on the span. The original fallback span name, GraphQL Operation, is preserved.

Merge requirement checklist

  • CONTRIBUTING.md guidelines followed.
  • Change log entry added, according to the guidelines in When to add a changelog entry.
    • If your PR does not need a change log, start the PR title with [chore]
  • schema-next.yaml updated with changes to existing conventions. (I don't think this needs to be updated because it's a span name and not an attribute)

Due to concerns about high cardinality with the current span name format
use only the <graphql.operation.type> attribute for the span name.
The higher cardinality attribute, <graphql.operation.name> can still be
used in queries, as it is an attribute on the span.
The original fallback, "GraphQL Operation" is preserved.
@kaylareopelle kaylareopelle requested review from a team September 4, 2024 18:19
@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 4, 2024

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Oct 4, 2024
@github-actions github-actions bot removed the Stale label Oct 8, 2024
kaylareopelle and others added 2 commits October 9, 2024 14:18
Provide an path for a config option to add
{graphql.operation.name} to the span name, but with a clear warning around high cardinality.
@kaylareopelle kaylareopelle requested review from a team as code owners October 9, 2024 21:21
Copy link
Copy Markdown
Member

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@kaylareopelle
Copy link
Copy Markdown
Contributor Author

It seems like the wayback machine is down at the moment, causing the markdown-link-check job to fail: https://github.com/open-telemetry/semantic-conventions/actions/runs/11263374842/job/31321102055?pr=1389#step:4:10

@lmolkova lmolkova enabled auto-merge (squash) October 10, 2024 17:41
@lmolkova lmolkova merged commit 7375567 into open-telemetry:main Oct 10, 2024
@lmolkova lmolkova mentioned this pull request Oct 11, 2024
3 tasks
ChrsMark pushed a commit to ChrsMark/semantic-conventions that referenced this pull request Oct 18, 2024
Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com>
Co-authored-by: Liudmila Molkova <limolkova@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Concerns about high cardinality in GraphQL span names

5 participants