OpenTelemetry SDK
    Preparing search index...

    Interface GrpcInstrumentationConfig

    Base interface for configuration options common to all instrumentations. This interface can be extended by individual instrumentations to include additional configuration options specific to that instrumentation. All configuration options must be optional.

    interface GrpcInstrumentationConfig {
        enabled?: boolean;
        ignoreGrpcMethods?: IgnoreMatcher[];
        metadataToSpanAttributes?: {
            client?: { requestMetadata?: string[]; responseMetadata?: string[] };
            server?: { requestMetadata?: string[]; responseMetadata?: string[] };
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    enabled? ignoreGrpcMethods? metadataToSpanAttributes?

    Properties

    enabled?: boolean

    Whether to enable the plugin.

    true
    ignoreGrpcMethods?: IgnoreMatcher[]
    metadataToSpanAttributes?: {
        client?: { requestMetadata?: string[]; responseMetadata?: string[] };
        server?: { requestMetadata?: string[]; responseMetadata?: string[] };
    }

    Map the following gRPC metadata to span attributes.

    Settings

    Member Visibility

    On This Page

    Properties