Prometheus metrics exporter for Muffin framework
Project description
Muffin-Prometheus – Prometheus metrics exporter for Muffin framework
Requirements
python >= 3.7
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.
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
File details
Details for the file muffin-prometheus-1.2.0.tar.gz.
File metadata
- Download URL: muffin-prometheus-1.2.0.tar.gz
- Upload date:
- Size: 4.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 24e18373132950838548c8ac651208fe50571cfb4b3f543d282aa0614abdd3e7 |
|
| MD5 | b373dbf1e931c1001ebf51dc6a973451 |
|
| BLAKE2b-256 | 2ba1b3b6abe1f9007540a14618a91dc7222ae1dd365c6579a7bdaadfb79632f0 |
File details
Details for the file muffin_prometheus-1.2.0-py3-none-any.whl.
File metadata
- Download URL: muffin_prometheus-1.2.0-py3-none-any.whl
- Upload date:
- Size: 4.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3a9736a68616330a935a8b99617c225f2b53b0d1a9a5af77009e9f3a38f92435 |
|
| MD5 | 4b98c12657b10284d6b8c489f13e0e31 |
|
| BLAKE2b-256 | f2101c007a40294622d420f482dd68d60383502843b64e3a8051cb34a4f6d3a1 |
