Metric

Методы класса

constructor()

Конструктор для создания экземпляра Metric.

Сигнатура

  • constructor(options?: MetricOptions)

Тип

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

Подробности

СвойствоТипОписаниеЗначение по умолчанию
meterNamestringИдентификатор Meternocobase-meter
versionstringТекущая версия NocoBase
readerNamestring | string[]Идентификатор(ы) зарегистрированного MetricReader-

init()

Инициализирует MetricProvider.

Сигнатура

  • init(): void

registerReader()

Регистрирует MetricReader.

Сигнатура

  • registerReader(name: string, reader: GetMetricReader)

Тип

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

type GetMetricReader = () => MetricReader;

Подробности

ПараметрТипОписание
namestringУникальный идентификатор MetricReader
reader() => MetricReaderФункция для получения MetricReader

addView()

Добавляет View. См. Configure Metric Views.

Сигнатура

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

Тип

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

getMeter()

Возвращает Meter.

Сигнатура

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

Подробности

ПараметрТипОписаниеЗначение по умолчанию
namestringИдентификатор Meternocobase-meter
versionstringТекущая версия NocoBase

start()

Запускает MetricReader.

Сигнатура

  • start(): void

shutdown()

Останавливает MetricReader.

Сигнатура

  • shutdown(): Promise<void>