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.
Metadata
Release files for muffin-prometheus 1.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| muffin_prometheus-1.4.1.tar.gz | 3.1 kB | Without provenance | Details for muffin_prometheus-1.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| muffin_prometheus-1.4.1-py3-none-any.whl | Python 3 | none | any | Details for muffin_prometheus-1.4.1-py3-none-any.whl |
Total release size: 6.3 kB
Release files / muffin_prometheus-1.4.1.tar.gz
| Download URL | muffin_prometheus-1.4.1.tar.gz |
|---|---|
| Size | 3.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
57e3294ede1d538daa522f7b7ef9be72112852bbdb31a27a439da1b4fcb47fcc
|
|
BLAKE2b-256 checksum How to use checksums |
748e593e81764c50f94a9cc1c1d9c2919fb2986181684dd17a457697a0432896
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure
|
Release files / muffin_prometheus-1.4.1-py3-none-any.whl
| Download URL | muffin_prometheus-1.4.1-py3-none-any.whl |
|---|---|
| Size | 3.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d5c11c7b713a967a2b94fa2d585bc885ed6cb2482a9f2a49b6a6d22fbbadbb4f
|
|
BLAKE2b-256 checksum How to use checksums |
4eb966214e08b3001029d3b844eaa00fabd8b5900f078a344c9be320ccfb39d1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure
|
Security for muffin-prometheus 1.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.