Autumn Docs

Модуль PrometheusRegistry ​

Фасад над внутренним классом CollectorRegistry.

  • управляет реестром по умолчанию;
  • позволяет регистрировать/снимать регистрацию коллекторов;
  • собирает метрики из всех коллекторов и возвращает массив семейств в промежуточном формате.

Реестр по умолчанию ​

Функция ПолучитьРеестрПоУмолчанию() Экспорт ​

Ленивая инициализация объекта CollectorRegistry:

  • при первом вызове создаёт Новый CollectorRegistry();
  • далее возвращает уже созданный экземпляр.

Используется модулем Prometheus и может использоваться напрямую, если нужно управлять регистрацией коллекторов.

Регистрация коллекторов ​

Функция Зарегистрировать(Коллектор) Экспорт ​

Регистрирует коллектор в системе метрик.

Вызов делегируется в CollectorRegistry.Register(Коллектор) реестра по умолчанию.

Функция СнятьРегистрацию(Коллектор) Экспорт ​

Снимает регистрацию коллектора:

  • вызывает CollectorRegistry.Unregister(Коллектор).

Возвращает Истина, если коллектор был снят, иначе Ложь.

Процедура ЗарегистрироватьОбязательно(Коллектор) Экспорт ​

Обёртка над Зарегистрировать:

  • вызывает Зарегистрировать(Коллектор);
  • при неуспехе выбрасывает исключение, которое начинается с "Не удалось зарегистрировать коллектор метрик", а для структуры метрики содержит её имя. Неуспех означает, что этот коллектор уже зарегистрирован или в реестре есть метрика с тем же именем и такими же константными лейблами либо с другим типом (см. CollectorRegistry.Register).

Полезно при инициализации критичных метрик, без которых приложение не должно продолжать работу.

Сбор метрик ​

Функция Собрать() Экспорт ​

Собирает метрики из:

  • Реестра по умолчанию (CollectorRegistry.Gather()).

Возвращает массив семейств метрик:

  • каждое семейство — структура с полями Имя, Тип, Справка, Сэмплы;
  • структура соответствует промежуточному формату, описанному в спецификации библиотеки.