Interface DogStatsD

interface DogStatsD {
    decrement(stat, value?, tags?): void;
    distribution(stat, value?, tags?): void;
    flush(): void;
    gauge(stat, value?, tags?): void;
    histogram(stat, value?, tags?): void;
    increment(stat, value?, tags?): void;
}

Methods

decrement distribution flush gauge histogram increment

Methods

decrement

  • decrement(stat, value?, tags?): void

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

    Parameters

    • stat: string

      The dot-separated metric name.

    • Optional value: number

      The amount to decrement the stat by.

    • Optional tags: {
          [tag: string]: string | number;
      }

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

      • [tag: string]: string | number

    Returns void

distribution

  • distribution(stat, value?, tags?): void

  • Sets a distribution value, optionally specifying tags.

    Parameters

    • stat: string

      The dot-separated metric name.

    • Optional value: number

      The amount to increment the stat by.

    • Optional tags: {
          [tag: string]: string | number;
      }

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

      • [tag: string]: string | number

    Returns void

flush

  • flush(): void
  • Beta

    Forces any unsent metrics to be sent

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

    Returns void

gauge

  • gauge(stat, value?, tags?): void

  • Sets a gauge value, optionally specifying tags.

    Parameters

    • stat: string

      The dot-separated metric name.

    • Optional value: number

      The amount to increment the stat by.

    • Optional tags: {
          [tag: string]: string | number;
      }

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

      • [tag: string]: string | number

    Returns void

histogram

  • histogram(stat, value?, tags?): void

  • Sets a histogram value, optionally specifying tags.

    Parameters

    • stat: string

      The dot-separated metric name.

    • Optional value: number

      The amount to increment the stat by.

    • Optional tags: {
          [tag: string]: string | number;
      }

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

      • [tag: string]: string | number

    Returns void

increment

  • increment(stat, value?, tags?): void

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

    Parameters

    • stat: string

      The dot-separated metric name.

    • Optional value: number

      The amount to increment the stat by.

    • Optional tags: {
          [tag: string]: string | number;
      }

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

      • [tag: string]: string | number

    Returns void

Settings

Member Visibility

Theme

On This Page

decrementdistributionflushgaugehistogramincrement