Prometheus Fastapi Instrumentator Versions Save

5.8.1 (2022-05-03)

Bug Fixes

• deps: regression too strict version requirements #136 (36bc045). Thanks to @graipher for raising the issue.

5.8.0 (2022-05-01)

⚠ BREAKING CHANGES

• Removed support for Python 3.6 and overall cleanup
• dev: Switch from underscores to dashes for function names

Features

• ci: Add dependabot.yml (a6d6406)

Code Refactoring

• dev: Switch from underscores to dashes for function names (1dc0bb3)
• remove support for python 3.6 and clean (363d353)

Changed

• Ran poetry update.
• Updated all development dependencies to newest (non-conflicting) versions.

Fixed

• Updated prometheus-client dependency version constraint ^0.8.0 that only allows versions in the range [0.8.0, 0.9.0[. This is not correct and leads to conflicts when you want to install the newest prometheus client library version and this package. Switched to explicit contraints to ensure this does not happen again.

Added

• Passthrough of Kwargs to FastAPI route that exposes metrics.

Changed

All changes are minor and non-breaking and mostly effect development only.

• Most of the stuff that is not directly related to the code has been replaced with common files / scripts from another repository of mine I use as a kind of template for Python projects you can find here.
• Replaced Makefile with simple Bash script that contains a bunch of functions. Easier to maintain and to use.
• Replace workflow files with new workflows.
• Add conftest.py that provides utilities for testing.
• Reliscenced from MIT to Apache-2.0.
• Added DEVELOPMENT.md.
• Introduced MyPy for linting during development.
• Updated docs.

Added

• Parameter tags to method expose(). Passthrough to FastAPI to support tagging. Raised by @chisaipete here.

Fixed

• "Duplicate mime type charset=utf-8 on Response Header" raised by @flobaader in this issue. Fixed in commit by changing the way the content type header is set. Seems like when Starlette's media_type parameter is used to provide content type, the charset is appended again automatically even if it already is part of Content-Type.

Changed

• Run poetry update and with that updated a few dependencies.

Added

• New metrics closure requests. Idea raised by @jpslopes

Fixed

• Regression introduced in 5.4.1 by pinning FastAPI dependency to fastapi = "0.38.1, <=1.0.0" instead of fastapi = ">=0.38.1, <=1.0.0". Thanks to @PaulFlanaganGenscape for rasing this issue here.

Added

• New metric that monitors the number of requests in progress. Can be configured to have the labels handler and method. It can be activated with should_instrument_requests_inprogress and configured with inprogress_name and inprogress_labels. Check the autogenerated docs for more info. Implementation not as nice as all the others because the metric requires to be incremented before actually getting the response. This kind of conflicts with the approach of this project. See e62576e3640be0b677334537d27bc267ab0e91cf for the implementation commit.

Changed

• Updated a few of the development dependencies to newer versions.
• Updated CI to test with Python 3.9 instead of 3.8.
• Replace deprecated way of creating GitHub environment variables in workflows.
• Update few minor things around the GitHub workflow files.

Fixed

• Fix for https://github.com/trallnag/prometheus-fastapi-instrumentator/issues/9. The expose method in the instrumentator ignores the endpoint argument and always creates the endpoint with the path /metrics. Variable was missing. Raised by @funkybase on 2020-09-24.

Changed

• Poetry update