Class MetricMetadata

Object with all metric related metadata.

Hierarchy

  • MetricMetadata

Constructors

constructor

Properties

additionalProperties? description? integration? perUnit? shortName? statsdInterval? type? unit?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional description

description?: string

Metric description.

Optional integration

integration?: string

Name of the integration that sent the metric if applicable.

Optional perUnit

perUnit?: string

Per unit of the metric such as second in bytes per second.

Optional shortName

shortName?: string

A more human-readable and abbreviated version of the metric name.

Optional statsdInterval

statsdInterval?: number

StatsD flush interval of the metric in seconds if applicable.

Optional type

type?: string

Metric type such as gauge or rate.

Optional unit

unit?: string

Primary unit of the metric such as byte or operation.

Settings

Member Visibility

Theme

Generated using TypeDoc