Interface apollo

Currently this plugin automatically instruments @apollo/gateway for module versions >= v2.3.0. This module uses graphql operations to service requests & thus generates graphql spans. We recommend disabling the graphql plugin if you only want to trace @apollo/gateway

interface apollo {
    enabled?: boolean;
    measured?: boolean | {
        [key: string]: boolean;
    };
    service?: any;
    signature?: boolean;
    source?: boolean;
}

Hierarchy

  • Instrumentation
    • apollo

Properties

enabled? measured? service? signature? source?

Properties

Optional enabled

enabled?: boolean

Whether to enable the plugin.

Default

true

Optional measured

measured?: boolean | {
    [key: string]: boolean;
}

Whether to measure the span. Can also be set to a key-value pair with span names as keys and booleans as values for more granular control.

Type declaration

  • [key: string]: boolean

Optional service

service?: any

The service name to be used for this plugin.

Optional signature

signature?: boolean

Whether to enable signature calculation for the resource name. This can be disabled if your apollo/gateway operations always have a name. Note that when disabled all queries will need to be named for this to work properly.

Default

true

Optional source

source?: boolean

Whether to include the source of the operation within the query as a tag on every span. This may contain sensitive information and should only be enabled if sensitive data is always sent as variables and not in the query text.

Default

false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc