UNPKG

@graphql-mesh/plugin-opentelemetry

Version:
994 lines (984 loc) • 34.1 kB
'use strict'; var gatewayRuntime = require('@graphql-hive/gateway-runtime'); var request = require('@graphql-hive/logger/request'); var utils$1 = require('@graphql-mesh/utils'); var utils = require('@graphql-tools/utils'); var api = require('@opentelemetry/api'); var core$1 = require('@opentelemetry/core'); var promiseHelpers = require('@whatwg-node/promise-helpers'); var core = require('@graphql-hive/core'); var transportCommon = require('@graphql-mesh/transport-common'); var semanticConventions = require('@opentelemetry/semantic-conventions'); var graphql = require('graphql'); class OtelContextStack { #root; #current; constructor(root) { this.#root = { ctx: root }; this.#current = this.#root; } get current() { return this.#current.ctx; } get root() { return this.#root.ctx; } push = (ctx) => { this.#current = { ctx, previous: this.#current }; }; pop = () => { this.#current = this.#current.previous ?? this.#root; }; toString() { let node = this.#current; const names = []; while (node != void 0) { names.push(api.trace.getSpan(node.ctx).name); node = node.previous; } return names.join(" -> "); } } function withState(pluginFactory) { const states = {}; function getProp(scope, key) { return { get() { if (!states[scope]) states[scope] = /* @__PURE__ */ new WeakMap(); let value = states[scope].get(key); if (!value) states[scope].set(key, value = {}); return value; }, enumerable: true }; } function getState(payload) { let { executionRequest, context, request } = payload; const state = {}; const defineState = (scope, key) => Object.defineProperty(state, scope, getProp(scope, key)); if (executionRequest) { defineState("forSubgraphExecution", executionRequest); if (executionRequest.context?.params) context = executionRequest.context; } if (context) { defineState("forOperation", context); if (context.request) request = context.request; } if (request) { defineState("forRequest", request); } return state; } function addStateGetters(src) { const result = {}; for (const [hookName, hook] of Object.entries(src)) { if (typeof hook !== "function") { result[hookName] = hook; } else { result[hookName] = { [hook.name](payload, ...args) { return hook( { ...payload, get state() { return getState(payload); } }, ...args ); } }[hook.name]; } } return result; } const { instrumentation, ...hooks } = pluginFactory(getState); const pluginWithState = addStateGetters(hooks); pluginWithState.instrumentation = addStateGetters(instrumentation); return pluginWithState; } function getMostSpecificState(state = {}) { const { forOperation, forRequest, forSubgraphExecution } = state; return forSubgraphExecution ?? forOperation ?? forRequest; } const RETRY_SYMBOL = Symbol.for("@hive-gateway/runtime/upstreamRetry"); function isRetryExecutionRequest(executionRequest) { return !!executionRequest?.[RETRY_SYMBOL]; } function getRetryInfo(executionRequest) { return executionRequest[RETRY_SYMBOL]; } const SEMATTRS_GRAPHQL_DOCUMENT = "graphql.document"; const SEMATTRS_GRAPHQL_OPERATION_TYPE = "graphql.operation.type"; const SEMATTRS_GRAPHQL_OPERATION_NAME = "graphql.operation.name"; const SEMATTRS_GRAPHQL_OPERATION_HASH = "hive.graphql.operation.hash"; const SEMATTRS_GRAPHQL_ERROR_COUNT = "hive.graphql.error.count"; const SEMATTRS_GRAPHQL_ERROR_CODES = "hive.graphql.error.codes"; const SEMATTRS_GATEWAY_UPSTREAM_SUBGRAPH_NAME = "hive.gateway.upstream.subgraph.name"; const SEMATTRS_GATEWAY_OPERATION_SUBGRAPH_NAMES = "hive.gateway.operation.subgraph.names"; function createHttpSpan(input) { const { url, request, tracer } = input; const span = tracer.startSpan( `${request.method || "GET"} ${url.pathname}`, { attributes: { [semanticConventions.SEMATTRS_HTTP_METHOD]: request.method || "GET", [semanticConventions.SEMATTRS_HTTP_URL]: request.url, [semanticConventions.SEMATTRS_HTTP_ROUTE]: url.pathname, [semanticConventions.SEMATTRS_HTTP_SCHEME]: url.protocol, [semanticConventions.SEMATTRS_NET_HOST_NAME]: url.hostname || url.host || request.headers.get("host") || "localhost", [semanticConventions.SEMATTRS_HTTP_HOST]: url.host || request.headers.get("host") || void 0, [semanticConventions.SEMATTRS_HTTP_CLIENT_IP]: request.headers.get("x-forwarded-for")?.split(",")[0], [semanticConventions.SEMATTRS_HTTP_USER_AGENT]: request.headers.get("user-agent") || void 0, "hive.client.name": request.headers.get("x-graphql-client-name") || void 0, "hive.client.version": request.headers.get("x-graphql-client-version") || void 0 }, kind: api.SpanKind.SERVER }, input.ctx ); return { ctx: api.trace.setSpan(input.ctx, span) }; } function setResponseAttributes(ctx, response) { const span = api.trace.getSpan(ctx); if (span) { span.setAttribute(semanticConventions.SEMATTRS_HTTP_STATUS_CODE, response.status); span.setAttribute( "gateway.cache.response_cache", response.status === 304 && response.headers.get("ETag") ? "hit" : "miss" ); span.setStatus({ code: response.ok ? api.SpanStatusCode.OK : api.SpanStatusCode.ERROR, message: response.ok ? void 0 : response.statusText }); } } function createGraphQLSpan(input) { const span = input.tracer.startSpan( `graphql.operation`, { kind: api.SpanKind.INTERNAL }, input.ctx ); return api.trace.setSpan(input.ctx, span); } function setParamsAttributes(input) { const { ctx, params } = input; const span = api.trace.getSpan(ctx); if (!span) { return; } span.setAttribute(SEMATTRS_GRAPHQL_DOCUMENT, params.query ?? "<undefined>"); span.setAttribute( SEMATTRS_GRAPHQL_OPERATION_NAME, params.operationName ?? "" ); } const typeInfos = /* @__PURE__ */ new WeakMap(); const defaultOperationHashingFn = (input) => { if (!typeInfos.has(input.schema)) { typeInfos.set(input.schema, new graphql.TypeInfo(input.schema)); } const typeInfo = typeInfos.get(input.schema); return core.hashOperation({ documentNode: input.document, operationName: input.operationName ?? null, schema: input.schema, // NOTE: we should make this configurable at some point. variables: null, typeInfo }); }; function setExecutionAttributesOnOperationSpan(input) { const { hashOperationFn = defaultOperationHashingFn, args, ctx } = input; const span = api.trace.getSpan(ctx); if (span) { const operation = utils.getOperationASTFromDocument( args.document, args.operationName || void 0 ); const operationName = operation.name?.value; const document = transportCommon.defaultPrintFn(args.document); const hash = hashOperationFn?.({ ...args }); if (hash) { span.setAttribute(SEMATTRS_GRAPHQL_OPERATION_HASH, hash); } span.setAttribute(SEMATTRS_GRAPHQL_OPERATION_TYPE, operation.operation); span.setAttribute(SEMATTRS_GRAPHQL_OPERATION_NAME, operationName ?? ""); span.setAttribute(SEMATTRS_GRAPHQL_DOCUMENT, document); span.updateName(`graphql.operation ${operationName ?? "<Anonymous>"}`); } } function createGraphqlContextBuildingSpan(input) { const span = input.tracer.startSpan( "graphql.context", { kind: api.SpanKind.INTERNAL }, input.ctx ); return api.trace.setSpan(input.ctx, span); } function createGraphQLParseSpan(input) { const span = input.tracer.startSpan( "graphql.parse", { kind: api.SpanKind.INTERNAL }, input.ctx ); return api.trace.setSpan(input.ctx, span); } function setGraphQLParseAttributes(input) { const span = api.trace.getSpan(input.ctx); if (!span) { return; } span.setAttribute(SEMATTRS_GRAPHQL_DOCUMENT, input.query ?? "<empty>"); span.setAttribute(SEMATTRS_GRAPHQL_OPERATION_NAME, input.operationName ?? ""); if (input.result instanceof Error) { span.setAttribute(SEMATTRS_GRAPHQL_ERROR_COUNT, 1); } } function createGraphQLValidateSpan(input) { const span = input.tracer.startSpan( "graphql.validate", { attributes: { [SEMATTRS_GRAPHQL_DOCUMENT]: input.query, [SEMATTRS_GRAPHQL_OPERATION_NAME]: input.operationName }, kind: api.SpanKind.INTERNAL }, input.ctx ); return api.trace.setSpan(input.ctx, span); } function setGraphQLValidateAttributes(input) { const { result, ctx } = input; const span = api.trace.getSpan(ctx); if (!span) { return; } if (result instanceof Error) { span.setStatus({ code: api.SpanStatusCode.ERROR, message: result.message }); } else if (Array.isArray(result) && result.length > 0) { span.setAttribute(SEMATTRS_GRAPHQL_ERROR_COUNT, result.length); span.setStatus({ code: api.SpanStatusCode.ERROR, message: result.map((e) => e.message).join(", ") }); for (const error in result) { span.recordException(error); } } } function createGraphQLExecuteSpan(input) { const span = input.tracer.startSpan( "graphql.execute", { kind: api.SpanKind.INTERNAL }, input.ctx ); return api.trace.setSpan(input.ctx, span); } function setGraphQLExecutionAttributes(input) { const { ctx, args } = input; const span = api.trace.getSpan(ctx); if (!span) { return; } const operation = utils.getOperationASTFromDocument( args.document, args.operationName || void 0 ); span.setAttribute(SEMATTRS_GRAPHQL_OPERATION_TYPE, operation.operation); span.setAttribute( SEMATTRS_GRAPHQL_OPERATION_NAME, operation.name?.value ?? "" ); span.setAttribute( SEMATTRS_GRAPHQL_DOCUMENT, transportCommon.defaultPrintFn(input.args.document) ); } function setGraphQLExecutionResultAttributes(input) { const { ctx, result } = input; const span = api.trace.getSpan(ctx); if (!span) { return; } if (input.subgraphNames) { span.setAttribute( SEMATTRS_GATEWAY_OPERATION_SUBGRAPH_NAMES, input.subgraphNames ); } if (!utils.isAsyncIterable(result) && // FIXME: Handle async iterable too result.errors && result.errors.length > 0) { span.setAttribute(SEMATTRS_GRAPHQL_ERROR_COUNT, result.errors.length); span.setStatus({ code: api.SpanStatusCode.ERROR, message: result.errors.map((e) => e.message).join(", ") }); const codes = []; for (const error of result.errors) { span.recordException(error); codes.push(`${error.extensions["code"]}`); } span.setAttribute(SEMATTRS_GRAPHQL_ERROR_CODES, codes); } } function createSubgraphExecuteSpan(input) { const operation = utils.getOperationASTFromDocument( input.executionRequest.document, input.executionRequest.operationName ); const span = input.tracer.startSpan( `subgraph.execute (${input.subgraphName})`, { attributes: { [SEMATTRS_GRAPHQL_OPERATION_NAME]: operation.name?.value ?? "", [SEMATTRS_GRAPHQL_DOCUMENT]: transportCommon.defaultPrintFn( input.executionRequest.document ), [SEMATTRS_GRAPHQL_OPERATION_TYPE]: operation.operation, [SEMATTRS_GATEWAY_UPSTREAM_SUBGRAPH_NAME]: input.subgraphName }, kind: api.SpanKind.CLIENT }, input.ctx ); return api.trace.setSpan(input.ctx, span); } function createUpstreamHttpFetchSpan(input) { const span = input.tracer.startSpan( "http.fetch", { attributes: {}, kind: api.SpanKind.CLIENT }, input.ctx ); return api.trace.setSpan(input.ctx, span); } function setUpstreamFetchAttributes(input) { const { ctx, url, options: fetchOptions } = input; const span = api.trace.getSpan(ctx); if (!span) { return; } const urlObj = new URL(input.url); span.setAttribute(semanticConventions.SEMATTRS_HTTP_METHOD, fetchOptions.method ?? "GET"); span.setAttribute(semanticConventions.SEMATTRS_HTTP_URL, url); span.setAttribute(semanticConventions.SEMATTRS_NET_HOST_NAME, urlObj.hostname); span.setAttribute(semanticConventions.SEMATTRS_HTTP_HOST, urlObj.host); span.setAttribute(semanticConventions.SEMATTRS_HTTP_ROUTE, urlObj.pathname); span.setAttribute(semanticConventions.SEMATTRS_HTTP_SCHEME, urlObj.protocol); if (input.executionRequest && isRetryExecutionRequest(input.executionRequest)) { const { attempt } = getRetryInfo(input.executionRequest); if (attempt > 0) { span.setAttribute("http.request.resend_count", attempt); } } } function setUpstreamFetchResponseAttributes(input) { const { ctx, response } = input; const span = api.trace.getSpan(ctx); if (!span) { return; } span.setAttribute(semanticConventions.SEMATTRS_HTTP_STATUS_CODE, response.status); span.setStatus({ code: response.ok ? api.SpanStatusCode.OK : api.SpanStatusCode.ERROR, message: response.ok ? void 0 : response.statusText }); } function recordCacheEvent(event, payload) { api.trace.getActiveSpan()?.addEvent("gateway.cache." + event, { "gateway.cache.key": payload.key, "gateway.cache.ttl": payload.ttl }); } function recordCacheError(action, error, payload) { api.trace.getActiveSpan()?.addEvent("gateway.cache.error", { "gateway.cache.key": payload.key, "gateway.cache.ttl": payload.ttl, "gateway.cache.action": action, [semanticConventions.SEMATTRS_EXCEPTION_TYPE]: "code" in error ? error.code : error.message, [semanticConventions.SEMATTRS_EXCEPTION_MESSAGE]: error.message, [semanticConventions.SEMATTRS_EXCEPTION_STACKTRACE]: error.stack }); } const responseCacheSymbol = Symbol.for("servedFromResponseCache"); function setExecutionResultAttributes(input) { const span = api.trace.getSpan(input.ctx); if (input.result && span) { span.setAttribute( "gateway.cache.response_cache", input.result[responseCacheSymbol] ? "hit" : "miss" ); } } function createSchemaLoadingSpan(inputs) { const span = inputs.tracer.startSpan( "gateway.schema", { attributes: { "gateway.schema.changed": false } }, inputs.ctx ); const currentContext = api.context.active(); if (currentContext !== inputs.ctx) { const currentSpan = api.trace.getActiveSpan(); currentSpan?.addLink({ context: span.spanContext() }); } return api.trace.setSpan(api.ROOT_CONTEXT, span); } function setSchemaAttributes(inputs) { const span = api.trace.getActiveSpan(); if (!span) { return; } span.setAttribute("gateway.schema.changed", true); span.setAttribute("graphql.schema", graphql.printSchema(inputs.schema)); } function registerException(ctx, error) { const span = ctx && api.trace.getSpan(ctx); if (!span) { return; } const message = error?.message?.toString() ?? error?.toString(); span.setStatus({ code: api.SpanStatusCode.ERROR, message }); span.recordException(error); } function isContextManagerCompatibleWithAsync() { const symbol = Symbol(); const root = api.context.active(); return api.context.with(root.setValue(symbol, true), () => { return new Promise((resolve) => { setTimeout(() => { resolve(api.context.active().getValue(symbol) || false); }); }); }); } const getEnvVar = "process" in globalThis ? (name, defaultValue) => process.env[name] || defaultValue : (_name, defaultValue) => defaultValue; const logLevelMap = { ALL: api.DiagLogLevel.ALL, VERBOSE: api.DiagLogLevel.VERBOSE, DEBUG: api.DiagLogLevel.DEBUG, INFO: api.DiagLogLevel.INFO, WARN: api.DiagLogLevel.WARN, ERROR: api.DiagLogLevel.ERROR, NONE: api.DiagLogLevel.NONE }; function diagLogLevelFromEnv() { const value = getEnvVar("OTEL_LOG_LEVEL", null); if (value == null) { return void 0; } const resolvedLogLevel = logLevelMap[value.toUpperCase()]; if (resolvedLogLevel == null) { api.diag.warn( `Unknown log level "${value}", expected one of ${Object.keys(logLevelMap)}, using default` ); return api.DiagLogLevel.INFO; } return resolvedLogLevel; } const initializationTime = "performance" in globalThis ? performance.now() : void 0; const otelCtxForRequestId = /* @__PURE__ */ new Map(); const HeadersTextMapGetter = { keys(carrier) { return [...carrier.keys()]; }, get(carrier, key) { return carrier.get(key) || void 0; } }; function useOpenTelemetry(options) { const inheritContext = options.inheritContext ?? true; const propagateContext = options.propagateContext ?? true; let useContextManager; const traces = typeof options.traces === "object" ? options.traces : {}; let tracer; let pluginLogger; let initSpan; function isParentEnabled(state) { const parentState = getMostSpecificState(state); return !parentState || !!parentState.otel; } function getContext(state) { const specificState = getMostSpecificState(state)?.otel; if (initSpan && !specificState) { return initSpan; } if (useContextManager) { return api.context.active(); } return specificState?.current ?? api.ROOT_CONTEXT; } let preparation$ = init(); preparation$.then(() => { preparation$ = utils.fakePromise(); }); async function init() { if (options.useContextManager !== false && !await isContextManagerCompatibleWithAsync()) { useContextManager = false; if (options.useContextManager === true) { throw new Error( "[OTEL] Context Manager usage is enabled, but the registered one is not compatible with async calls. Please use another context manager, such as `AsyncLocalStorageContextManager`." ); } } else { useContextManager = options.useContextManager ?? true; } tracer = traces.tracer || api.trace.getTracer("gateway"); initSpan = api.trace.setSpan( api.context.active(), tracer.startSpan("gateway.initialization", { startTime: initializationTime }) ); if (!useContextManager) { if (traces.spans?.schema) { pluginLogger.warn( "Schema loading spans are disabled because no context manager is available" ); } traces.spans = traces.spans ?? {}; traces.spans.schema = false; } } return withState((getState) => ({ getTracer: () => tracer, getOtelContext: ({ state }) => getContext(state), instrumentation: { request({ state: { forRequest }, request }, wrapped) { if (!shouldTrace(traces.spans?.http, { request })) { return wrapped(); } const url = getURL(request); return promiseHelpers.unfakePromise( preparation$.then(() => { const ctx = inheritContext ? api.propagation.extract( api.context.active(), request.headers, HeadersTextMapGetter ) : api.context.active(); forRequest.otel = new OtelContextStack( createHttpSpan({ ctx, request, tracer, url }).ctx ); if (useContextManager) { wrapped = api.context.bind(forRequest.otel.current, wrapped); } return wrapped(); }).catch((error) => { registerException(forRequest.otel?.current, error); throw error; }).finally(() => { const ctx = forRequest.otel?.root; ctx && api.trace.getSpan(ctx)?.end(); }) ); }, operation({ context: gqlCtx, state: { forOperation, ...parentState } }, wrapped) { if (!isParentEnabled(parentState) || !shouldTrace(traces.spans?.graphql, { context: gqlCtx })) { return wrapped(); } return promiseHelpers.unfakePromise( preparation$.then(() => { const ctx = getContext(parentState); forOperation.otel = new OtelContextStack( createGraphQLSpan({ tracer, ctx }) ); if (useContextManager) { wrapped = api.context.bind(forOperation.otel.current, wrapped); } return utils.fakePromise().then(wrapped).catch((err) => { registerException(forOperation.otel?.current, err); throw err; }).finally(() => api.trace.getSpan(forOperation.otel.current)?.end()); }) ); }, context({ state, context: gqlCtx }, wrapped) { if (!isParentEnabled(state) || !shouldTrace(traces.spans?.graphqlContextBuilding, { context: gqlCtx })) { return wrapped(); } const { forOperation } = state; const ctx = getContext(state); forOperation.otel.push( createGraphqlContextBuildingSpan({ ctx, tracer }) ); if (useContextManager) { wrapped = api.context.bind(forOperation.otel.current, wrapped); } try { wrapped(); } catch (err) { registerException(forOperation.otel?.current, err); throw err; } finally { api.trace.getSpan(forOperation.otel.current)?.end(); forOperation.otel.pop(); } }, parse({ state, context: gqlCtx }, wrapped) { if (!isParentEnabled(state) || !shouldTrace(traces.spans?.graphqlParse, { context: gqlCtx })) { return wrapped(); } const ctx = getContext(state); const { forOperation } = state; forOperation.otel.push(createGraphQLParseSpan({ ctx, tracer })); if (useContextManager) { wrapped = api.context.bind(forOperation.otel.current, wrapped); } try { wrapped(); } catch (err) { registerException(forOperation.otel.current, err); throw err; } finally { api.trace.getSpan(forOperation.otel.current)?.end(); forOperation.otel.pop(); } }, validate({ state, context: gqlCtx }, wrapped) { if (!isParentEnabled(state) || !shouldTrace(traces.spans?.graphqlValidate, { context: gqlCtx })) { return wrapped(); } const { forOperation } = state; forOperation.otel.push( createGraphQLValidateSpan({ ctx: getContext(state), tracer, query: gqlCtx.params.query?.trim(), operationName: gqlCtx.params.operationName }) ); if (useContextManager) { wrapped = api.context.bind(forOperation.otel.current, wrapped); } try { wrapped(); } catch (err) { registerException(forOperation.otel?.current, err); throw err; } finally { api.trace.getSpan(forOperation.otel.current)?.end(); forOperation.otel.pop(); } }, execute({ state, context: gqlCtx }, wrapped) { if (!isParentEnabled(state) || !shouldTrace(traces.spans?.graphqlExecute, { context: gqlCtx })) { state.forOperation.skipExecuteSpan = true; return wrapped(); } const ctx = getContext(state); const { forOperation } = state; forOperation.otel?.push(createGraphQLExecuteSpan({ ctx, tracer })); if (useContextManager) { wrapped = api.context.bind(forOperation.otel.current, wrapped); } return promiseHelpers.unfakePromise( utils.fakePromise().then(wrapped).catch((err) => { registerException(forOperation.otel.current, err); throw err; }).finally(() => { api.trace.getSpan(forOperation.otel.current)?.end(); forOperation.otel.pop(); }) ); }, subgraphExecute({ state: { forSubgraphExecution, ...parentState }, executionRequest, subgraphName }, wrapped) { const isIntrospection = !executionRequest.context.params; if (!isParentEnabled(parentState) || parentState.forOperation?.skipExecuteSpan || !shouldTrace( isIntrospection ? traces.spans?.schema : traces.spans?.subgraphExecute, { subgraphName, executionRequest } )) { return wrapped(); } const parentContext = isIntrospection ? api.context.active() : getContext(parentState); forSubgraphExecution.otel = new OtelContextStack( createSubgraphExecuteSpan({ ctx: parentContext, tracer, executionRequest, subgraphName }) ); if (useContextManager) { wrapped = api.context.bind(forSubgraphExecution.otel.current, wrapped); } return promiseHelpers.unfakePromise( utils.fakePromise().then(wrapped).catch((err) => { registerException(forSubgraphExecution.otel.current, err); throw err; }).finally(() => { api.trace.getSpan(forSubgraphExecution.otel.current)?.end(); forSubgraphExecution.otel.pop(); }) ); }, fetch({ state, executionRequest }, wrapped) { if (gatewayRuntime.isRetryExecutionRequest(executionRequest)) { state = getState(gatewayRuntime.getRetryInfo(executionRequest)); } if (!isParentEnabled(state) || !shouldTrace(traces.spans?.upstreamFetch, { executionRequest })) { return wrapped(); } return promiseHelpers.unfakePromise( preparation$.then(() => { const { forSubgraphExecution } = state; const ctx = createUpstreamHttpFetchSpan({ ctx: getContext(state), tracer }); forSubgraphExecution?.otel.push(ctx); if (useContextManager) { wrapped = api.context.bind(ctx, wrapped); } return utils.fakePromise().then(wrapped).catch((err) => { registerException(ctx, err); throw err; }).finally(() => { api.trace.getSpan(ctx)?.end(); forSubgraphExecution?.otel.pop(); }); }) ); }, schema(_, wrapped) { if (!shouldTrace(traces.spans?.schema, null)) { return wrapped(); } return promiseHelpers.unfakePromise( preparation$.then(() => { const ctx = createSchemaLoadingSpan({ ctx: initSpan ?? api.ROOT_CONTEXT, tracer }); return utils.fakePromise().then(() => api.context.with(ctx, wrapped)).catch((err) => { api.trace.getSpan(ctx)?.recordException(err); }).finally(() => { api.trace.getSpan(ctx)?.end(); }); }) ); } }, onYogaInit({ yoga }) { const log = options.log ?? //TODO remove this when Yoga will also use the new Logger API new gatewayRuntime.Logger({ writers: [ { write(level, attrs, msg) { level = level === "trace" ? "debug" : level; yoga.logger[level](msg, attrs); } } ] }); pluginLogger = log.child("[OpenTelemetry] "); if (options.configureDiagLogger !== false) { const logLevel = diagLogLevelFromEnv(); if (logLevel) { const diagLog = pluginLogger.child("[diag] "); diagLog.verbose = diagLog.trace; api.diag.setLogger(diagLog, logLevel); core$1.setGlobalErrorHandler((err) => diagLog.error(err)); } } pluginLogger.debug( `context manager is ${useContextManager ? "enabled" : "disabled"}` ); }, onRequest({ state, request: request$1 }) { try { const requestId = request.requestIdByRequest.get(request$1); if (requestId) { request.loggerForRequest(options.log.child({ requestId }), request$1); if (!useContextManager) { otelCtxForRequestId.set(requestId, getContext(state)); } } } catch (error) { pluginLogger.error( { error }, "Error while setting up logger for request" ); } }, onEnveloped({ state, extendContext }) { extendContext({ openTelemetry: { tracer, activeContext: () => getContext(state) } }); }, onCacheGet: (payload) => shouldTrace(traces.events?.cache, { key: payload.key, action: "read" }) ? { onCacheMiss: () => recordCacheEvent("miss", payload), onCacheHit: () => recordCacheEvent("hit", payload), onCacheGetError: ({ error }) => recordCacheError("read", error, payload) } : void 0, onCacheSet: (payload) => shouldTrace(traces.events?.cache, { key: payload.key, action: "write" }) ? { onCacheSetDone: () => recordCacheEvent("write", payload), onCacheSetError: ({ error }) => recordCacheError("write", error, payload) } : void 0, onResponse({ response, request: request$1, state }) { try { state.forRequest.otel && setResponseAttributes(state.forRequest.otel.root, response); if (!useContextManager) { const requestId = request.requestIdByRequest.get(request$1); if (requestId) { otelCtxForRequestId.delete(requestId); } } } catch (error) { pluginLogger.error({ error }, "Failed to end http span"); } }, onParams({ state, context: gqlCtx, params }) { if (!isParentEnabled(state) || !shouldTrace(traces.spans?.graphql, { context: gqlCtx })) { return; } const ctx = getContext(state); setParamsAttributes({ ctx, params }); }, onExecutionResult({ result, context: gqlCtx, state }) { if (!isParentEnabled(state) || !shouldTrace(traces.spans?.graphql, { context: gqlCtx })) { return; } setExecutionResultAttributes({ ctx: getContext(state), result }); }, onParse({ state, context: gqlCtx }) { if (!isParentEnabled(state) || !shouldTrace(traces.spans?.graphqlParse, { context: gqlCtx })) { return; } return ({ result }) => { setGraphQLParseAttributes({ ctx: getContext(state), operationName: gqlCtx.params.operationName, query: gqlCtx.params.query?.trim(), result }); }; }, onValidate({ state, context: gqlCtx }) { if (!isParentEnabled(state) || !shouldTrace(traces.spans?.graphqlValidate, { context: gqlCtx })) { return; } return ({ result }) => { setGraphQLValidateAttributes({ ctx: getContext(state), result }); }; }, onExecute({ state, args }) { if (!isParentEnabled(state)) { return; } setExecutionAttributesOnOperationSpan({ ctx: state.forOperation.otel.root, args, hashOperationFn: options.hashOperation }); if (state.forOperation.skipExecuteSpan) { return; } const ctx = getContext(state); setGraphQLExecutionAttributes({ ctx, args }); state.forOperation.subgraphNames = []; return { onExecuteDone({ result }) { setGraphQLExecutionResultAttributes({ ctx, result, subgraphNames: state.forOperation.subgraphNames }); } }; }, onSubgraphExecute({ subgraphName, state }) { state.forOperation?.subgraphNames?.push(subgraphName); }, onFetch(payload) { const { url, setFetchFn, fetchFn, executionRequest } = payload; let { state } = payload; if (executionRequest && gatewayRuntime.isRetryExecutionRequest(executionRequest)) { state = getState(gatewayRuntime.getRetryInfo(executionRequest)); } if (propagateContext) { setFetchFn((url2, options2, ...args) => { const reqHeaders = utils$1.getHeadersObj(options2?.headers || {}); api.propagation.inject(getContext(state), reqHeaders); return fetchFn(url2, { ...options2, headers: reqHeaders }, ...args); }); } if (!isParentEnabled(state) || !shouldTrace(traces.spans?.upstreamFetch, { executionRequest })) { return; } const ctx = getContext(state); setUpstreamFetchAttributes({ ctx, url, options: payload.options, executionRequest }); return ({ response }) => { setUpstreamFetchResponseAttributes({ ctx, response }); }; }, onSchemaChange(payload) { setSchemaAttributes(payload); if (initSpan) { api.trace.getSpan(initSpan)?.end(); initSpan = null; } }, onDispose() { if (options.flushOnDispose !== false) { const flushMethod = options.flushOnDispose ?? "forceFlush"; const provider = api.trace.getTracerProvider(); if (flushMethod in provider && typeof provider[flushMethod] === "function") { return provider[flushMethod](); } } } })); } function shouldTrace(value, args) { if (value == null) { return true; } if (typeof value === "function") { return value(args); } return value; } function getURL(request) { if ("parsedUrl" in request) { return request.parsedUrl; } return new URL(request.url, "http://localhost"); } exports.SEMATTRS_GATEWAY_OPERATION_SUBGRAPH_NAMES = SEMATTRS_GATEWAY_OPERATION_SUBGRAPH_NAMES; exports.SEMATTRS_GATEWAY_UPSTREAM_SUBGRAPH_NAME = SEMATTRS_GATEWAY_UPSTREAM_SUBGRAPH_NAME; exports.SEMATTRS_GRAPHQL_DOCUMENT = SEMATTRS_GRAPHQL_DOCUMENT; exports.SEMATTRS_GRAPHQL_ERROR_CODES = SEMATTRS_GRAPHQL_ERROR_CODES; exports.SEMATTRS_GRAPHQL_ERROR_COUNT = SEMATTRS_GRAPHQL_ERROR_COUNT; exports.SEMATTRS_GRAPHQL_OPERATION_HASH = SEMATTRS_GRAPHQL_OPERATION_HASH; exports.SEMATTRS_GRAPHQL_OPERATION_NAME = SEMATTRS_GRAPHQL_OPERATION_NAME; exports.SEMATTRS_GRAPHQL_OPERATION_TYPE = SEMATTRS_GRAPHQL_OPERATION_TYPE; exports.getEnvVar = getEnvVar; exports.otelCtxForRequestId = otelCtxForRequestId; exports.useOpenTelemetry = useOpenTelemetry;