feat(opentelemetry): add cache events and attributes #993

EmrysMyrddin · 2025-04-04T10:01:36Z

I didn't found any standard cache related attributes, so I've add custom gateway.cache prefix.

I also noticed that the operation name is not set when the result is cached (since the execute hook is not called). I don't want to fix this in this PR because it will involve changes in all response cache plugin variants

Related to GW-168

Copilot

Copilot reviewed 26 out of 33 changed files in this pull request and generated 1 comment.

Files not reviewed (7)

.yarn/patches/@opentelemetry-exporter-trace-otlp-http-npm-0.200.0-80a44c64cd.patch: Language not supported
.yarn/patches/@opentelemetry-otlp-exporter-base-npm-0.200.0-6fb25211c7.patch: Language not supported
.yarn/patches/@opentelemetry-otlp-exporter-base-npm-0.56.0-ba3dc5f5c5.patch: Language not supported
.yarn/patches/@opentelemetry-resources-npm-1.29.0-112f89f0c5.patch: Language not supported
.yarn/patches/@opentelemetry-resources-npm-2.0.0-f20376a5f9.patch: Language not supported
package.json: Language not supported
packages/plugins/opentelemetry/package.json: Language not supported

Copilot · 2025-04-04T10:02:26Z

e2e/opentelemetry/opentelemetry.e2e.ts

      ): Promise<void> {
        const url = `http://0.0.0.0:${jaeger.additionalPorts[16686]}/api/traces?service=${service}`;

        let res!: JaegerTracesApiResponse;
        let err: any;
-        const signal = AbortSignal.timeout(15_000);
+        const timeout = AbortSignal.timeout(15_00);


The timeout value '15_00' may be a typo; if a 15 second timeout is intended, consider using '15_000' instead.

Suggested change

const timeout = AbortSignal.timeout(15_00);

const timeout = AbortSignal.timeout(15_000);

@EmrysMyrddin Should this be fixed?

It should be, but in the v2 branch directly. I will do it on next rebase.

theguild-bot · 2025-04-04T10:04:52Z

🚀 Snapshot Release (`alpha`)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package	Version	Info
`@graphql-mesh/fusion-runtime`	`0.11.11-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707`	npm ↗︎ unpkg ↗︎
`@graphql-hive/gateway`	`1.13.7-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707`	npm ↗︎ unpkg ↗︎
`@graphql-hive/nestjs`	`1.0.11-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707`	npm ↗︎ unpkg ↗︎
`@graphql-hive/plugin-aws-sigv4`	`1.0.8-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/plugin-jwt-auth`	`1.5.4-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/plugin-opentelemetry`	`2.0.0-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/plugin-prometheus`	`1.3.43-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707`	npm ↗︎ unpkg ↗︎
`@graphql-hive/gateway-runtime`	`1.8.1-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707`	npm ↗︎ unpkg ↗︎

theguild-bot · 2025-04-04T10:07:11Z

🚀 Snapshot Release (Binary for `macOS-ARM64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-04-04T10:07:39Z

🚀 Snapshot Release (Binary for `Linux-ARM64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-04-04T10:07:54Z

🚀 Snapshot Release (Binary for `Linux-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-04-04T10:09:17Z

🚀 Snapshot Release (Node Docker Image)

The latest changes of this PR are available as image on GitHub Container Registry (based on the declared changesets):

ghcr.io/graphql-hive/gateway:1.13.7-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707

theguild-bot · 2025-04-04T10:09:28Z

🚀 Snapshot Release (Binary for `macOS-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-04-04T10:10:00Z

🚀 Snapshot Release (Bun Docker Image)

The latest changes of this PR are available as image on GitHub Container Registry (based on the declared changesets):

ghcr.io/graphql-hive/gateway:1.13.7-alpha-eeedfe89cea8ad8ec8c4ae19d0176f06c6667707-bun

theguild-bot · 2025-04-04T10:14:08Z

🚀 Snapshot Release (Binary for `Windows-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

dotansimha · 2025-04-06T05:54:35Z

packages/plugins/opentelemetry/src/plugin-utils.ts

@@ -78,6 +82,8 @@ export function withState<
  const pluginWithState = addStateGetters(hooks);
  pluginWithState.instrumentation = addStateGetters(instrumentation);

+  console.log('plugin hooks: ', Object.entries(pluginWithState));


dotansimha · 2025-04-06T05:55:16Z

packages/plugins/opentelemetry/src/spans.ts

+  payload: OnCacheGetHookEventPayload,
+) {
+  trace.getActiveSpan()?.addEvent('gateway.cache.error', {
+    'gateway.cache.key': payload.key,


good naming!

nit: can also be graphql.cache.key to make it more unique in a full architecture,

or graphql.response_cache.key

It is not just response caching. Cache storage can be used in other places.

Yeah, not sure about graphql.cache.key, the cache instance can actually be used to cache anything (like the schema)

dotansimha

lgtm. let's also wait for @ardatan to confirm.

enisdenjo · 2025-04-08T19:30:43Z

Heads up, I've rebased v2 on main. There's conflicts now.

add cache events and attributes

Copilot AI review requested due to automatic review settings April 4, 2025 10:01

EmrysMyrddin changed the base branch from main to v2 April 4, 2025 10:02

Copilot AI reviewed Apr 4, 2025

View reviewed changes

EmrysMyrddin changed the title ~~feat(opentelemetry): correct span parenting + fix batching support~~ feat(opentelemetry): add cache events and attributes Apr 4, 2025

EmrysMyrddin force-pushed the feat/otel/add-more-spans branch from 4315d1f to 56eabaf Compare April 4, 2025 10:25

dotansimha reviewed Apr 6, 2025

View reviewed changes

dotansimha approved these changes Apr 6, 2025

View reviewed changes

dotansimha requested a review from ardatan April 6, 2025 05:55

enisdenjo force-pushed the v2 branch from 376b8e3 to e101965 Compare April 8, 2025 19:10

enisdenjo force-pushed the v2 branch from e101965 to f246857 Compare April 9, 2025 13:38

EmrysMyrddin force-pushed the feat/otel/add-more-spans branch from d91cb77 to 8071f7b Compare April 10, 2025 18:13

enisdenjo force-pushed the v2 branch from 7ac617e to 3563e2b Compare April 11, 2025 17:50

EmrysMyrddin force-pushed the feat/otel/add-more-spans branch from 8071f7b to fdc303b Compare April 11, 2025 19:04

EmrysMyrddin force-pushed the v2 branch from 3563e2b to 2881d4f Compare April 12, 2025 11:11

EmrysMyrddin force-pushed the feat/otel/add-more-spans branch from fdc303b to cf7e239 Compare April 12, 2025 11:13

ardatan approved these changes Apr 13, 2025

View reviewed changes

enisdenjo force-pushed the v2 branch 3 times, most recently from 5879f2b to 0bc8a1c Compare April 17, 2025 17:50

add cache events and attributes

dee3574

add cache events and attributes

EmrysMyrddin added 2 commits April 18, 2025 20:13

remove only

d40bbb7

remove debug logs

eeedfe8

EmrysMyrddin force-pushed the feat/otel/add-more-spans branch from cf7e239 to eeedfe8 Compare April 18, 2025 18:13

EmrysMyrddin merged commit c66c06c into v2 Apr 18, 2025
61 checks passed

EmrysMyrddin deleted the feat/otel/add-more-spans branch April 18, 2025 18:32

enisdenjo pushed a commit that referenced this pull request Apr 21, 2025

feat(opentelemetry): add cache events and attributes (#993)

838e985

enisdenjo pushed a commit that referenced this pull request May 12, 2025

feat(opentelemetry): add cache events and attributes (#993)

4feb06b

enisdenjo pushed a commit that referenced this pull request May 20, 2025

feat(opentelemetry): add cache events and attributes (#993)

33d0d57

enisdenjo pushed a commit that referenced this pull request May 22, 2025

feat(opentelemetry): add cache events and attributes (#993)

35b4c59

	const timeout = AbortSignal.timeout(15_00);
	const timeout = AbortSignal.timeout(15_000);

feat(opentelemetry): add cache events and attributes #993

feat(opentelemetry): add cache events and attributes #993

Uh oh!

Conversation

EmrysMyrddin commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 4, 2025

Choose a reason for hiding this comment

Uh oh!

ardatan Apr 6, 2025

Choose a reason for hiding this comment

Uh oh!

EmrysMyrddin Apr 8, 2025

Choose a reason for hiding this comment

Uh oh!

theguild-bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (alpha)

Uh oh!

theguild-bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for macOS-ARM64)

Uh oh!

theguild-bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Linux-ARM64)

Uh oh!

theguild-bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Linux-X64)

Uh oh!

theguild-bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Node Docker Image)

Uh oh!

theguild-bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for macOS-X64)

Uh oh!

theguild-bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Bun Docker Image)

Uh oh!

theguild-bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Windows-X64)

Uh oh!

dotansimha Apr 6, 2025

Choose a reason for hiding this comment

Uh oh!

dotansimha Apr 6, 2025

Choose a reason for hiding this comment

Uh oh!

dotansimha Apr 6, 2025

Choose a reason for hiding this comment

Uh oh!

ardatan Apr 6, 2025

Choose a reason for hiding this comment

Uh oh!

EmrysMyrddin Apr 8, 2025

Choose a reason for hiding this comment

Uh oh!

dotansimha left a comment

Choose a reason for hiding this comment

Uh oh!

enisdenjo commented Apr 8, 2025

Uh oh!

Uh oh!

Uh oh!

EmrysMyrddin commented Apr 4, 2025 •

edited

Loading

theguild-bot commented Apr 4, 2025 •

edited

Loading

🚀 Snapshot Release (`alpha`)

theguild-bot commented Apr 4, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `macOS-ARM64`)

theguild-bot commented Apr 4, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Linux-ARM64`)

theguild-bot commented Apr 4, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Linux-X64`)

theguild-bot commented Apr 4, 2025 •

edited

Loading

theguild-bot commented Apr 4, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `macOS-X64`)

theguild-bot commented Apr 4, 2025 •

edited

Loading

theguild-bot commented Apr 4, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Windows-X64`)