Graphorin API reference v0.15.1

---

Graphorin API reference / @graphorin/server / / MetricRegistry

Class: MetricRegistry

Defined in: packages/server/src/metrics/registry.ts:57

Stable

Lightweight Prometheus registry. Each instance owns its metric catalogue + per-label samples; render() emits the canonical text exposition block.

Constructors

Constructor

new MetricRegistry(): MetricRegistry;

Returns

MetricRegistry

Methods

contentType()

contentType(): string;

Defined in: packages/server/src/metrics/registry.ts:196

Returns

string

---

inc()

inc(
   name, 
   labels?, 
   by?): void;

Defined in: packages/server/src/metrics/registry.ts:78

Parameters

Parameter	Type	Default value
name	string	undefined
labels	LabelSet	{}
by	number	1

Returns

void

---

observe()

observe(
   name, 
   value, 
   labels?): void;

Defined in: packages/server/src/metrics/registry.ts:108

Parameters

Parameter	Type
name	string
value	number
labels	LabelSet

Returns

void

---

registerCounter()

registerCounter(
   name, 
   help, 
   labelNames?): void;

Defined in: packages/server/src/metrics/registry.ts:63

Parameters

Parameter	Type	Default value
name	string	undefined
help	string	undefined
labelNames	readonly string[]	[]

Returns

void

---

registerGauge()

registerGauge(
   name, 
   help, 
   labelNames?): void;

Defined in: packages/server/src/metrics/registry.ts:68

Parameters

Parameter	Type	Default value
name	string	undefined
help	string	undefined
labelNames	readonly string[]	[]

Returns

void

---

registerSummary()

registerSummary(
   name, 
   help, 
   labelNames?): void;

Defined in: packages/server/src/metrics/registry.ts:73

Parameters

Parameter	Type	Default value
name	string	undefined
help	string	undefined
labelNames	readonly string[]	[]

Returns

void

---

render()

render(): string;

Defined in: packages/server/src/metrics/registry.ts:150

Render the current snapshot in Prometheus text exposition format (v0.0.4). Never throws - incomplete sample buckets are skipped instead of failing the scrape.

Returns

string

---

reset()

reset(): void;

Defined in: packages/server/src/metrics/registry.ts:126

Returns

void

---

set()

set(
   name, 
   value, 
   labels?): void;

Defined in: packages/server/src/metrics/registry.ts:97

Parameters

Parameter	Type
name	string
value	number
labels	LabelSet

Returns

void

---

snapshot()

snapshot(): {
  counters: Record<string, ReadonlyArray<{
     labels: LabelSet;
     value: number;
  }>>;
  gauges: Record<string, ReadonlyArray<{
     labels: LabelSet;
     value: number;
  }>>;
  summaries: Record<string, ReadonlyArray<{
     count: number;
     labels: LabelSet;
     samples: ReadonlyArray<number>;
     sum: number;
  }>>;
};

Defined in: packages/server/src/metrics/registry.ts:201

Snapshot for tests / assertions.

Returns

{
  counters: Record<string, ReadonlyArray<{
     labels: LabelSet;
     value: number;
  }>>;
  gauges: Record<string, ReadonlyArray<{
     labels: LabelSet;
     value: number;
  }>>;
  summaries: Record<string, ReadonlyArray<{
     count: number;
     labels: LabelSet;
     samples: ReadonlyArray<number>;
     sum: number;
  }>>;
}

Name	Type	Defined in
counters	Record<string, ReadonlyArray&lt;{ labels: LabelSet; value: number; }&gt;>	packages/server/src/metrics/registry.ts:202
gauges	Record<string, ReadonlyArray&lt;{ labels: LabelSet; value: number; }&gt;>	packages/server/src/metrics/registry.ts:203
summaries	Record<string, ReadonlyArray<{ count: number; labels: LabelSet; samples: ReadonlyArray&lt;number&gt;; sum: number; }>>	packages/server/src/metrics/registry.ts:204