{"id":28764948,"url":"https://github.com/klen/muffin-prometheus","last_synced_at":"2025-08-03T00:09:25.096Z","repository":{"id":50878499,"uuid":"357260131","full_name":"klen/muffin-prometheus","owner":"klen","description":"Prometheus metrics exporter for Muffin framework","archived":false,"fork":false,"pushed_at":"2024-07-31T16:23:28.000Z","size":80,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-05-28T21:44:28.853Z","etag":null,"topics":["asgi","curio","muffin","prometheus-exporter","trio"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klen.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":".github/contributing.md","funding":null,"license":null,"code_of_conduct":".github/code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/codeowners","security":".github/security.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-12T16:14:29.000Z","updated_at":"2024-07-31T16:23:22.000Z","dependencies_parsed_at":"2024-07-31T20:24:00.138Z","dependency_job_id":null,"html_url":"https://github.com/klen/muffin-prometheus","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/klen/muffin-prometheus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fmuffin-prometheus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fmuffin-prometheus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fmuffin-prometheus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fmuffin-prometheus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klen","download_url":"https://codeload.github.com/klen/muffin-prometheus/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klen%2Fmuffin-prometheus/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260336371,"owners_count":22993742,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asgi","curio","muffin","prometheus-exporter","trio"],"created_at":"2025-06-17T10:13:02.185Z","updated_at":"2025-08-03T00:09:25.077Z","avatar_url":"https://github.com/klen.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Muffin-Prometheus\n#################\n\n.. _description:\n\n**Muffin-Prometheus** -- Prometheus_ metrics exporter for Muffin_ framework\n\n.. _badges:\n\n.. image:: https://github.com/klen/muffin-prometheus/workflows/tests/badge.svg\n    :target: https://github.com/klen/muffin-prometheus/actions\n    :alt: Tests Status\n\n.. image:: https://img.shields.io/pypi/v/muffin-prometheus\n    :target: https://pypi.org/project/muffin-prometheus/\n    :alt: PYPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/muffin-prometheus\n    :target: https://pypi.org/project/muffin-prometheus/\n    :alt: Python Versions\n\n.. _contents:\n\n.. contents::\n\n.. _requirements:\n\nRequirements\n=============\n\n- python \u003e= 3.9\n\n.. _installation:\n\nInstallation\n=============\n\n**Muffin-prometheus** should be installed using pip: ::\n\n    pip install muffin-prometheus\n\n.. _usage:\n\nUsage\n=====\n\n\nInitialize and setup the plugin:\n\n.. code-block:: python\n\n    import muffin\n    import muffin_prometheus\n\n    # Create Muffin Application\n    app = muffin.Application('example')\n\n    # Initialize the plugin\n    # As alternative: prometheus = muffin_prometheus.Plugin(app, **options)\n    prometheus = muffin_prometheus.Plugin()\n    prometheus.setup(app, group_paths=['/api'])\n\n\nOptions\n-------\n\n=========================== =========================== ===========================\nName                        Default value               Desctiption\n--------------------------- --------------------------- ---------------------------\n**metrics_url**             ``\"/dev/prometheus\"``       HTTP Path to export metrics for Prometheus_\n**group_paths**             ``[]``                      List of path's prefixes to group. A path which starts from the prefix will be grouped\n=========================== =========================== ===========================\n\n\nYou are able to provide the options when you are initiliazing the plugin:\n\n.. code-block:: python\n\n    prometheus.setup(app, metrics_url='/metrics', group_paths=['/views', '/api/v1', '/api/v2'])\n\n\nOr setup it inside ``Muffin.Application`` config using the ``PROMETHEUS_`` prefix:\n\n.. code-block:: python\n\n   PROMETHEUS_METRICS_URL = '/metrics'\n\n   PROMETHEUS_GROUP_PATHS = ['/views', '/api/v1', '/api/v2']\n\n``Muffin.Application`` configuration options are case insensitive\n\n\n.. _bugtracker:\n\nBug tracker\n===========\n\nIf you have any suggestions, bug reports or annoyances please report them to\nthe issue tracker at https://github.com/klen/muffin-prometheus/issues\n\n.. _contributing:\n\nContributing\n============\n\nDevelopment of the plugin happens at: https://github.com/klen/muffin-prometheus\n\n\nContributors\n=============\n\n* klen_ (Kirill Klenov)\n\n.. _license:\n\nLicense\n========\n\nLicensed under a `MIT license`_.\n\n.. _links:\n\n\n.. _klen: https://github.com/klen\n.. _Muffin: https://github.com/klen/muffin\n.. _Prometheus: https://prometheus.io\n\n.. _MIT license: http://opensource.org/licenses/MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklen%2Fmuffin-prometheus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklen%2Fmuffin-prometheus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklen%2Fmuffin-prometheus/lists"}