API Reference
    Preparing search index...

    Interface TracerInterface

    interface TracerInterface {
        putAnnotation: (key: string, value: string | number | boolean) => void;
        putMetadata: (key: string, value: unknown, namespace?: string) => void;
        addErrorAsMetadata(error: Error, remote?: boolean): void;
        addResponseAsMetadata(data?: unknown, methodName?: string): void;
        addServiceNameAnnotation(): void;
        annotateColdStart(): void;
        captureAWS<T>(aws: T): undefined | T;
        captureAWSClient<T>(service: T): undefined | T;
        captureAWSv3Client<T>(service: T): undefined | T;
        captureLambdaHandler(
            options?: CaptureLambdaHandlerOptions,
        ): HandlerMethodDecorator;
        captureMethod<T extends AnyClass>(
            options?: CaptureMethodOptions,
        ): MethodDecorator<T>;
        getRootXrayTraceId(): undefined | string;
        getSegment(): undefined | Segment | Subsegment;
        isTraceSampled(): boolean;
        isTracingEnabled(): boolean;
        setSegment(segment: Segment | Subsegment): void;
    }

    Implemented by

    Index

    Properties

    putAnnotation putMetadata

    Methods

    addErrorAsMetadata addResponseAsMetadata addServiceNameAnnotation annotateColdStart captureAWS captureAWSClient captureAWSv3Client captureLambdaHandler captureMethod getRootXrayTraceId getSegment isTraceSampled isTracingEnabled setSegment

    Properties

    putAnnotation: (key: string, value: string | number | boolean) => void
    putMetadata: (key: string, value: unknown, namespace?: string) => void

    Methods

    • Parameters

      • error: Error
      • Optionalremote: boolean

      Returns void

    • Parameters

      • Optionaldata: unknown
      • OptionalmethodName: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods