basalt / core/src / Gauge

Class: Gauge

Defined in: core/src/metrics.ts:61

Extends

• Metric

Constructors

Constructor

> new Gauge(name, help, labelNames?): Gauge

Defined in: core/src/metrics.ts:28

Parameters

name

string

help

string

labelNames?

string[] = []

Returns

Gauge

Inherited from

Metric.constructor

Properties

help

> readonly help: string

Defined in: core/src/metrics.ts:30

Inherited from

Metric.help

---

labelNames

> readonly labelNames: string[] = []

Defined in: core/src/metrics.ts:31

Inherited from

Metric.labelNames

---

name

> readonly name: string

Defined in: core/src/metrics.ts:29

Inherited from

Metric.name

---

type

> readonly type: "gauge"

Defined in: core/src/metrics.ts:62

Overrides

Metric.type

Methods

dec()

> dec(labels?, value?): void

Defined in: core/src/metrics.ts:77

Parameters

labels?

Labels = {}

value?

number = 1

Returns

void

---

header()

> protected header(): string

Defined in: core/src/metrics.ts:34

Returns

string

Inherited from

Metric.header

---

inc()

> inc(labels?, value?): void

Defined in: core/src/metrics.ts:74

Parameters

labels?

Labels = {}

value?

number = 1

Returns

void

---

render()

> render(): string

Defined in: core/src/metrics.ts:81

Returns

string

Overrides

Metric.render

---

set()

> set(value, labels?): void

Defined in: core/src/metrics.ts:71

Parameters

value

number

labels?

Labels = {}

Returns

void