Metric

Class Methods

constructor()

Constructor to create a Metric instance.

Signature

  • constructor(options?: MetricOptions)

Type

export type MetricOptions = {
  meterName?: string;
  version?: string;
  readerName?: string | string[];
};

Details

PropertyTypeDescriptionDefault Value
meterNamestringMeter identifiernocobase-meter
versionstringCurrent version of NocoBase
readerNamestring | string[]Identifier(s) of registered MetricReader to use-

init()

Initializes MetricProvider.

Signature

  • init(): void

registerReader()

Registers a MetricReader.

Signature

  • registerReader(name: string, reader: GetMetricReader)

Type

import { MetricReader } from '@opentelemetry/sdk-metrics';

type GetMetricReader = () => MetricReader;

Details

ParameterTypeDescription
namestringUnique identifier for MetricReader
reader() => MetricReaderFunction to get MetricReader

addView()

Adds a View. Refer to Configure Metric Views.

Signature

  • addView(...view: View[])

Type

import { View } from '@opentelemetry/sdk-metrics';

getMeter()

Gets the Meter.

Signature

  • getMeter(name?: string, version?: string)

Details

ParameterTypeDescriptionDefault Value
namestringMeter identifiernocobase-meter
versionstringCurrent version of NocoBase

start()

Starts the MetricReader.

Signature

  • start(): void

shutdown()

Stops the MetricReader.

Signature

  • shutdown(): Promise<void>