跳转到主要内容

Muffin框架的Prometheus指标导出器

项目描述

Muffin-PrometheusPrometheus 指标导出器,用于 Muffin 框架

Tests Status PYPI Version Python Versions

要求

  • python >= 3.9

安装

Muffin-prometheus 应使用pip安装

pip install muffin-prometheus

使用

初始化和设置插件

import muffin
import muffin_prometheus

# Create Muffin Application
app = muffin.Application('example')

# Initialize the plugin
# As alternative: prometheus = muffin_prometheus.Plugin(app, **options)
prometheus = muffin_prometheus.Plugin()
prometheus.setup(app, group_paths=['/api'])

选项

名称

默认值

描述

metrics_url

"/dev/prometheus"

导出Prometheus指标的HTTP路径

group_paths

[]

要分组的路径前缀列表。以前缀开始的路径将被分组

您可以在初始化插件时提供选项

prometheus.setup(app, metrics_url='/metrics', group_paths=['/views', '/api/v1', '/api/v2'])

或在使用Muffin.Application配置时使用PROMETHEUS_前缀进行设置

PROMETHEUS_METRICS_URL = '/metrics'

PROMETHEUS_GROUP_PATHS = ['/views', '/api/v1', '/api/v2']

Muffin.Application配置选项不区分大小写

错误跟踪器

如果您有任何建议、错误报告或不满,请通过https://github.com/klen/muffin-prometheus/issues向问题跟踪器报告

贡献

插件的开发发生在: https://github.com/klen/muffin-prometheus

贡献者

  • klen (Kirill Klenov)

许可证

本软件受MIT许可证许可。

由以下组织支持