Update dependency prometheus-fastapi-instrumentator to v5.11.2

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
prometheus-fastapi-instrumentator	5.7.1 -> 5.11.2

---

Release Notes

trallnag/prometheus-fastapi-instrumentator (prometheus-fastapi-instrumentator)

v5.11.2

Compare Source

v5.11.1

Compare Source

Fixed

• Improved typing hints and enabled stricter rules for MyPy. Thanks to
  @​tomtom103 for implementing this in
  #​231.

v5.11.0

Compare Source

Minor release containing several fixes and a small enhancement. Fixes are
related to multi process mode, a regression introduced with the previous
release, and errors that started to occur with current versions of Starlette and
FastAPI.

Ask or discuss anything quick about the release in the discussion
#​221.

Added

• Adjusted the add() method to accept an arbitrary number of instrumentation
  functions as arguments instead of a single one. Non-breaking change.
  Implemented in pull request
  #​230.

Fixed

• Fixed multi process mode in expose() method that handles the /metrics
  endpoint. Due to reusing the registry assigned to the instrumentator it could
  lead to duplicated metrics. Now the endpoint follows recommendation from
  Prometheus client library documentation. Also improved multi process unit
  tests. Closed issue
  #​228
  and
  #​227.
  Fixed in pull request
  #​229.

• Fixed NameError and "Duplicated timeseries..." errors that started to occur
  with latest versions of Starlette / FastAPI in combination with multiple
  middlewares. Instrumentation closures are now optional and the instrumentator
  handles this accordingly. Thanks to @​alexted and
  others for reporting errors. Thanks to
  @​frankie567 for pointing out the change in
  Starlette. Related to pull request
  #​153
  and issue
  #​214.
  Closed issue
  #​219.
  Done in pull request
  #​220.

• Added missing registry parameter to remaining metrics functions. This
  enables passing custom registry to other metrics functions than default.
  Related to pull request
  #​153.
  Closed issue
  #​219.
  Done in pull request
  #​220.

v5.10.0

Compare Source

First release in several months. Includes new features and fixes from various
contributors. Notable changes that might have an impact on existing setups is
the automatic instrumentation of mounted apps and the deprecation of the
lowercase prometheus_multiproc_dir environment variable.

Ask or discuss anything quick about the release in the discussion
#​221.

Added

• Added smart handling of mounted apps. Previously the URL handler logic did
  not handle mounted apps and always returned just the prefix in that case.
  Based on code from
  elastic/apm-agent-python
  licensed under the permissive BSD-3-Clause License. Thanks to
  @​LordGaav for proposing this enhancement / fix
  and implementing it in
  #​208.
  Related to issues
  #​31
  and
  #​121.

• Added optional parameters metric_namespace and metric_subsystem to
  instrument() method to configure namespace and subsystem for all metric
  names. Check the README.md for
  more information. Thanks to @​phbernardes for
  proposing this enhancement and implementing it in
  #​193.

• Added passthrough of body to info.response. This enables metrics that
  work based on data in the body. Thanks to everyone who brought this up in
  #​76
  and to @​HadilD for implementing it in
  #​203.

• Allowed passing a custom registry to be used instead of using the default
  one. This would be useful in particular when testing multiple FastAPI apps
  (e.g. microservices) in the same tests run. Note that there are issues with
  the current implementation in certain corner cases. Thanks to
  @​tiangolo for proposing this enhancement and
  implementing it in
  #​153.

• Environment variable used by should_respect_env_var (default
  ENABLE_METRICS) now accepts truthy values like 1 and true and not
  just True. Thanks to @​chbndrhnns for
  proposing this enhancement in
  #​27
  and implementing it in
  #​28.

• Added support for asynchronous instrumentation functions. The add()
  method now accepts them in addition to "normal" functions and the
  instrumentator middleware will await them appropriately. Thanks to
  @​AndreasPB for proposing this enhancement and
  implementing it in
  #​61.
  Thanks to @​Skeen for contributing to the
  discussion.

Changed

• Licensed part of the project under the BSD-3-Clause License. This is due to
  code being used from a repo licensed under BSD-3-Clause (see the "Added"
  section). The default ISC License and the BSD-3-Clause License are both
  permissive. So there should be no user impact.

Fixed

• Fixed status code in metric being "Hxx" when http.HTTPStatus enumeration is
  used in combination with grouping of status codes. Thanks to
  @​Leem0sh and others for raising the issue in
  #​190.
  Thanks to @​nikstuckenbrock and
  @​blag for fixing it in
  #​192.

• Fixed documentation in main README on how to use
  prometheus-fastapi-instrumentator with current versions of FastAPI. Related to
  issues
  #​214
  and
  #​80.
  Thanks to @​alfaro28 and
  @​harochau.

Deprecated

• Deprecated environment variable prometheus_multiproc_dir and replaced it
  with PROMETHEUS_MULTIPROC_DIR. This matches the behavior of the Prometheus
  Python client library. This fixes
  #​89
  and
  #​50.
  Thanks to all the people who brought this up. Thanks to
  @​michaelusner for implementing the
  deprecation in
  #​42 /
  #​217.

v5.9.1

Compare Source

Fixed

• Corrected documention on how to use package. Instrumentation should happen in
  a function decorated with @app.on_event("startup") to prevent crashes on
  startup in certain situations. Done in
  #​168.
  Thanks to @​mdczaplicki and others.

v5.9.0

Compare Source

Added

• Added py.typed file to package to improve typing annotations. Done in
  #​137.
  Thanks to @​mmaslowskicc for proposing and
  implementing this.

Changed

• Changed license from MIT to ISC, which is just like MIT but shorter.
• Coding style improvements. Replaced a few for loops with list comprehensions.
  Defaulting an argument to None instead of an empty list. Done in
  #​155.
  Thanks to @​yezz123.
• Several improvements to the documentation. Thanks to
  @​jabertuhin,
  @​frodrigo, and
  @​murphp15.

Fixed

• Removed print statement polluting logs. Done in
  #​157.
  Thanks to @​nikstuckenbrock and others.

v5.8.2

Compare Source

Changed

• Refactored the middleware to an ASGI implementation. Related to
  #​139.
  Thanks to @​Kludex and
  @​adriangb for the proposal and implementation.

v5.8.1

Compare Source

Fixed

• Fixed a regression that made the required FastAPI version too strict for no
  reason. Related to
  #​136.
  Thanks to @​graipher for raising this issue.

v5.8.0

Compare Source

Removed

• BREAKING: Dropped support for Python 3.6 which is has reached end-of-life.

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[github-actions]

Unit Test Results

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0 ❌

Results for commit 30787e8.