Module logi_prometheus_backend

A logi backend for collecting prometheus metrics.

Copyright © 2017 Takeru Ohta <phjgt308@gmail.com>

Behaviours: logi_backend.

Description

A logi backend for collecting prometheus metrics.

This exposes metrics that count the number of log messages sent to a channel.

EXAMPLE

  %% Installs `logi_prometheus_backend' to the default channel.
  ok = logi_prometheus_backend:install(info).
 
  %% Logs a message.
  > logi:info("foo").
 
  %% Prints metrics.
  > io:format(prometheus_text_format:format()).
  # TYPE logi_messages_total counter
  # HELP logi_messages_total Log messages count
  logi_messages_total{logger="logi_default_logger",severity="info",application="stdlib",module="erl_eval"} 1

Function Index

install/1Equivalent to install(logi:default_logger(), ConditionSpec).
install/2Prometheus用のメトリクス収集バックエンドをLoggerに登録する.
uninstall/0Equivalent to uninstall(logi:default_logger()).
uninstall/1バックエンドの登録を解除する.

Function Details

install/1

install(ConditionSpec::logi_condition:spec()) -> ok

Equivalent to install(logi:default_logger(), ConditionSpec).

install/2

install(Logger::logi:logger(), ConditionSpec::logi_condition:spec()) -> ok

Prometheus用のメトリクス収集バックエンドをLoggerに登録する

既に登録の場合は、内容が更新される

uninstall/0

uninstall() -> ok

Equivalent to uninstall(logi:default_logger()).

uninstall/1

uninstall(Logger::logi:logger()) -> ok

バックエンドの登録を解除する

バックエンドが未登録の場合は、エラーとはならずに単に無視される


Generated by EDoc, Oct 27 2017, 04:44:07.