Prometheus metrics exporter for Muffin framework
Project description
Muffin-Prometheus – Prometheus metrics exporter for Muffin framework
Requirements
python >= 3.9
Installation
Muffin-prometheus should be installed using pip:
pip install muffin-prometheus
Usage
Initialize and setup the plugin:
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'])
Options
Name |
Default value |
Desctiption |
metrics_url |
"/dev/prometheus" |
HTTP Path to export metrics for Prometheus |
group_paths |
[] |
List of path’s prefixes to group. A path which starts from the prefix will be grouped |
You are able to provide the options when you are initiliazing the plugin:
prometheus.setup(app, metrics_url='/metrics', group_paths=['/views', '/api/v1', '/api/v2'])
Or setup it inside Muffin.Application config using the PROMETHEUS_ prefix:
PROMETHEUS_METRICS_URL = '/metrics'
PROMETHEUS_GROUP_PATHS = ['/views', '/api/v1', '/api/v2']
Muffin.Application configuration options are case insensitive
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-prometheus/issues
Contributing
Development of the plugin happens at: https://github.com/klen/muffin-prometheus
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for muffin_prometheus-1.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5c11c7b713a967a2b94fa2d585bc885ed6cb2482a9f2a49b6a6d22fbbadbb4f |
|
MD5 | 6c285a902ca7371b34ace13e596e7378 |
|
BLAKE2b-256 | 4eb966214e08b3001029d3b844eaa00fabd8b5900f078a344c9be320ccfb39d1 |