dd-trace
    Preparing search index...

    Interface DogStatsD

    interface DogStatsD {
        decrement(
            stat: string,
            value?: number,
            tags?: string[] | Record<string, string | number>,
        ): void;
        distribution(
            stat: string,
            value?: number,
            tags?: string[] | Record<string, string | number>,
        ): void;
        flush(): void;
        gauge(
            stat: string,
            value?: number,
            tags?: string[] | Record<string, string | number>,
        ): void;
        histogram(
            stat: string,
            value?: number,
            tags?: string[] | Record<string, string | number>,
        ): void;
        increment(
            stat: string,
            value?: number,
            tags?: string[] | Record<string, string | number>,
        ): void;
    }
    Index

    Methods

    decrement distribution flush gauge histogram increment

    Methods

    • Decrements a metric by the specified value, optionally specifying tags.

      Parameters

      • stat: string

        The dot-separated metric name.

      • Optionalvalue: number

        The amount to decrement the stat by.

      • Optionaltags: string[] | Record<string, string | number>

        Tags to pass along, such as { foo: 'bar' }. Values are combined with config.tags.

      Returns void

    • Sets a distribution value, optionally specifying tags.

      Parameters

      • stat: string

        The dot-separated metric name.

      • Optionalvalue: number

        The amount to increment the stat by.

      • Optionaltags: string[] | Record<string, string | number>

        Tags to pass along, such as { foo: 'bar' }. Values are combined with config.tags.

      Returns void

    • Beta

      Forces any unsent metrics to be sent

      This method is experimental and could be removed in future versions.

      Returns void

    • Sets a gauge value, optionally specifying tags.

      Parameters

      • stat: string

        The dot-separated metric name.

      • Optionalvalue: number

        The amount to increment the stat by.

      • Optionaltags: string[] | Record<string, string | number>

        Tags to pass along, such as { foo: 'bar' }. Values are combined with config.tags.

      Returns void

    • Sets a histogram value, optionally specifying tags.

      Parameters

      • stat: string

        The dot-separated metric name.

      • Optionalvalue: number

        The amount to increment the stat by.

      • Optionaltags: string[] | Record<string, string | number>

        Tags to pass along, such as { foo: 'bar' }. Values are combined with config.tags.

      Returns void

    • Increments a metric by the specified value, optionally specifying tags.

      Parameters

      • stat: string

        The dot-separated metric name.

      • Optionalvalue: number

        The amount to increment the stat by.

      • Optionaltags: string[] | Record<string, string | number>

        Tags to pass along, such as { foo: 'bar' }. Values are combined with config.tags.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods