dd-trace
    Preparing search index...

    Interface aws_sdk

    This plugin automatically instruments the aws-sdk module.

    interface aws_sdk {
        batchPropagationEnabled?: boolean;
        enabled?: boolean;
        hooks?: { request?: (span?: Span, response?: anyObject) => any };
        measured?: boolean | { [key: string]: boolean };
        service?: string | ((params: anyObject) => string | null | undefined);
        [key: string]: boolean | Object | undefined;
    }

    Indexable

    • [key: string]: boolean | Object | undefined

      Configuration for individual services to enable/disable them. Message queue services can also configure the producer and consumer individually by passing an object with a producer and consumer properties. The list of valid service keys is in the service-specific section of https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html

    Index

    Properties

    batchPropagationEnabled? enabled? hooks? measured? service?

    Properties

    batchPropagationEnabled?: boolean

    Whether to inject all messages during batch AWS SQS, Kinesis, and SNS send operations. Normal behavior is to inject the first message in batch send operations.

    false
    enabled?: boolean

    Whether to enable the plugin.

    true
    hooks?: { request?: (span?: Span, response?: anyObject) => any }

    Hooks to run before spans are finished.

    Type Declaration

    • Optionalrequest?: (span?: Span, response?: anyObject) => any

      Hook to execute just before the aws span finishes.

    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.

    service?: string | ((params: anyObject) => string | null | undefined)

    The service name to be used for this plugin. When a function is used it is called with the AWS request parameters (e.g. { TableName } for DynamoDB, { Bucket } for S3) and its return value is used as the service name. Returning a nullish value falls back to the default service name, so individual resources can be mapped without renaming every call to the service.

    Settings

    Member Visibility

    On This Page

    Properties