UNPKG

1.8 kBTypeScriptView Raw
1interface GraphqlOptions {
2 /**
3 * Do not create spans for resolvers.
4 *
5 * Defaults to true.
6 */
7 ignoreResolveSpans?: boolean;
8 /**
9 * Don't create spans for the execution of the default resolver on object properties.
10 *
11 * When a resolver function is not defined on the schema for a field, graphql will
12 * use the default resolver which just looks for a property with that name on the object.
13 * If the property is not a function, it's not very interesting to trace.
14 * This option can reduce noise and number of spans created.
15 *
16 * Defaults to true.
17 */
18 ignoreTrivialResolveSpans?: boolean;
19 /**
20 * If this is enabled, a http.server root span containing this span will automatically be renamed to include the operation name.
21 * Set this to `false` if you do not want this behavior, and want to keep the default http.server span name.
22 *
23 * Defaults to true.
24 */
25 useOperationNameForRootSpan?: boolean;
26}
27export declare const instrumentGraphql: ((options?: GraphqlOptions | undefined) => void) & {
28 id: string;
29};
30/**
31 * Adds Sentry tracing instrumentation for the [graphql](https://www.npmjs.com/package/graphql) library.
32 *
33 * For more information, see the [`graphqlIntegration` documentation](https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/graphql/).
34 *
35 * @param {GraphqlOptions} options Configuration options for the GraphQL integration.
36 *
37 * @example
38 * ```javascript
39 * const Sentry = require('@sentry/node');
40 *
41 * Sentry.init({
42 * integrations: [Sentry.graphqlIntegration()],
43 * });
44 */
45export declare const graphqlIntegration: (options?: GraphqlOptions | undefined) => import("@sentry/core").Integration;
46export {};
47//# sourceMappingURL=graphql.d.ts.map
\No newline at end of file