MetricsInstrument

Extends

• BaseInstrument

Constructors

new MetricsInstrument(store, init)

new MetricsInstrument(store, init): MetricsInstrument

Parameters

• store: Store

• init: MetricsInstrumentInit= {}

Returns

MetricsInstrument

Overrides

BaseInstrument.constructor

Source

inspector/lib/instruments/metrics.ts:19

Properties

active

active: boolean = false

Inherited from

BaseInstrument.active

Source

inspector/lib/instruments/base.ts:6

---

dashboards

dashboards: Dashboard[]

Source

inspector/lib/instruments/metrics.ts:15

---

disabled

disabled: boolean = false

Inherited from

BaseInstrument.disabled

Source

inspector/lib/instruments/base.ts:8

---

name

name: InspectorInstruments

Inherited from

BaseInstrument.name

Source

inspector/lib/instruments/base.ts:11

---

sensors

sensors: SensorBase[] = []

Source

inspector/lib/instruments/metrics.ts:17

---

store

store: Store

Inherited from

BaseInstrument.store

Source

inspector/lib/instruments/base.ts:12

Methods

activate()

activate(): boolean

Returns

boolean

Overrides

BaseInstrument.activate

Source

inspector/lib/instruments/metrics.ts:41

---

deactivate()

deactivate(): boolean

Returns

boolean

Overrides

BaseInstrument.deactivate

Source

inspector/lib/instruments/metrics.ts:61

---

getEntryLabel()

getEntryLabel(_value): string

Parameters

• \_value: any

Returns

string

Inherited from

BaseInstrument.getEntryLabel

Source

inspector/lib/instruments/base.ts:22

---

getEntryTime()

getEntryTime(_value): number

Parameters

• \_value: any

Returns

number

Inherited from

BaseInstrument.getEntryTime

Source

inspector/lib/instruments/base.ts:26

---

push()

push(data): Promise<void>

Parameters

• data: Record<string, Object[]>

Returns

Promise<void>

Overrides

BaseInstrument.push

Source

inspector/lib/instruments/metrics.ts:29

---

putToStore()

putToStore(_time, _label, _value): Promise<void>

Parameters

• \_time: number

• \_label: string

• \_value: string

Returns

Promise<void>

Overrides

BaseInstrument.putToStore

Source

inspector/lib/instruments/metrics.ts:69

---

query()

query(query): Promise<Object>

Parameters

• query: Query & Object

Returns

Promise<Object>

entries

entries: StoreEntry[]

hasMore

hasMore: boolean = false

Overrides

BaseInstrument.query

Source

inspector/lib/instruments/metrics.ts:73

---

queryFromStore()

queryFromStore(query): Promise<StoreQueryResult>

Parameters

• query: Query

Returns

Promise<StoreQueryResult>

Inherited from

BaseInstrument.queryFromStore

Source

inspector/lib/instruments/base.ts:66

---

serializeValue()

serializeValue(value): any

Parameters

• value: any

Returns

any

Inherited from

BaseInstrument.serializeValue

Source

inspector/lib/instruments/base.ts:30

---

subscribe()

subscribe(fn, options): () => void

Parameters

• fn: (time, label, value) => void

• options: Object

• options\.interval?: number

• options\.keys?: string[]

• options\.startTime?: number

Returns

Function

Returns

void

Overrides

BaseInstrument.subscribe

Source

inspector/lib/instruments/metrics.ts:85

---

Generated using TypeDoc and typedoc-plugin-markdown.