Skip to content

chore: use hive console in addition to additional trace collector #7104

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

chore: use hive console in addition to additional trace collector #7104

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0a7e3a3
feat: use hive console in addition to additional trace collector
n1ru4l Oct 13, 2025
fc0351e
inline
n1ru4l Oct 14, 2025
fc2546e
deployment config
n1ru4l Oct 14, 2025
4e3f9c2
oops
n1ru4l Oct 14, 2025
9e6715a
ooops2
n1ru4l Oct 14, 2025
c04bf43
k
n1ru4l Oct 14, 2025
696f5c0
?
n1ru4l Oct 14, 2025
cb40d28
?
n1ru4l Oct 14, 2025
13de6bd
?
n1ru4l Oct 14, 2025
237aab5
use different prefix to disable environment variable based plugin setup
n1ru4l Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 39 additions & 20 deletions deployment/config/public-graphql-api-gateway/gateway.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,41 @@
// @ts-expect-error not a dependency
import { defineConfig } from '@graphql-hive/gateway';
// @ts-expect-error not a dependency
import { openTelemetrySetup } from '@graphql-hive/gateway/opentelemetry/setup';
import { hiveTracingSetup } from '@graphql-hive/plugin-opentelemetry/setup';
import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
import { MultiSpanProcessor } from '@opentelemetry/sdk-trace-base/build/src/MultiSpanProcessor';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently not exported (see open-telemetry/opentelemetry-js#6007)


openTelemetrySetup({
// Mandatory: It depends on the available API in your runtime.
// We recommend AsyncLocalStorage based manager when possible.
// `@opentelemetry/context-zone` is also available for other runtimes.
// Pass `false` to disable context manager usage.
contextManager: new AsyncLocalStorageContextManager(),

traces: {
// Define your exporter, most of the time the OTLP HTTP one. Traces are batched by default.
exporter: new OTLPTraceExporter({ url: process.env['OPENTELEMETRY_COLLECTOR_ENDPOINT']! }),
// You can easily enable a console exporter for quick debug
console: process.env['DEBUG_TRACES'] === '1',
},
});
if (process.env['OPENTELEMETRY_COLLECTOR_ENDPOINT'] || process.env['HIVE_TRACING_ACCESS_TOKEN']) {
hiveTracingSetup({
contextManager: new AsyncLocalStorageContextManager(),
processor: new MultiSpanProcessor([
Copy link
Collaborator

Choose a reason for hiding this comment

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

does this impact performance at all, such that we shouldn't add it if only one of the exporters is used?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Probably minimal, but yes it always adds a minimal impact. When nothing is configured, OTEL uses a no-op TracerProvider which just does nothing at all.

...(process.env['HIVE_TRACING_ACCESS_TOKEN']
? [
new BatchSpanProcessor(
new OTLPTraceExporter({
url: process.env['HIVE_TRACING_ENDPOINT'],
headers: {
Authorization: `Bearer ${process.env['HIVE_TRACING_ACCESS_TOKEN']}`,
'X-Hive-Target-Ref': process.env.HIVE_TRACING_TARGET!,
},
}),
),
]
: []),
...(process.env['OPENTELEMETRY_COLLECTOR_ENDPOINT']
? [
new BatchSpanProcessor(
new OTLPTraceExporter({
url: process.env['OPENTELEMETRY_COLLECTOR_ENDPOINT']!,
}),
),
]
: []),
]),
});
}

const defaultQuery = `#
# Welcome to the Hive Console GraphQL API.
Expand Down Expand Up @@ -50,11 +67,13 @@ export const gatewayConfig = defineConfig({
},
disableWebsockets: true,
prometheus: true,
openTelemetry: process.env['OPENTELEMETRY_COLLECTOR_ENDPOINT']
? {
serviceName: 'public-graphql-api-gateway',
}
: false,
openTelemetry:
process.env['OPENTELEMETRY_COLLECTOR_ENDPOINT'] || process.env['HIVE_TRACING_ACCESS_TOKEN']
? {
traces: true,
serviceName: 'public-graphql-api-gateway',
}
: undefined,
demandControl: {
maxCost: 1000,
includeExtensionMetadata: true,
Expand Down
Loading