Interface sharedb

This plugin automatically instruments the sharedb module.

interface sharedb {
    enabled?: boolean;
    hooks?: {
        receive?: ((span?, request?) => any);
        reply?: ((span?, request?, response?) => any);
    };
    service?: any;
}

Hierarchy

  • Integration
    • sharedb

Properties

enabled? hooks? service?

Properties

Optional enabled

enabled?: boolean

Whether to enable the plugin.

Default

true

Optional hooks

hooks?: {
    receive?: ((span?, request?) => any);
    reply?: ((span?, request?, response?) => any);
}

Hooks to run before spans are finished.

Type declaration

  • Optional receive?: ((span?, request?) => any)

    Hook to execute just when the span is created.

      • (span?, request?): any

      • Hook to execute just when the span is created.

        Parameters

        Returns any

  • Optional reply?: ((span?, request?, response?) => any)

    Hook to execute just when the span is finished.

      • (span?, request?, response?): any

      • Hook to execute just when the span is finished.

        Parameters

        • Optional span: export=.Span
        • Optional request: any
        • Optional response: any

        Returns any

Optional service

service?: any

The service name to be used for this plugin.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc