build(deps): bump starlette-exporter from 0.12.0 to 0.15.1 #201

dependabot · 2023-01-23T02:27:14Z

Bumps starlette-exporter from 0.12.0 to 0.15.1.

Release notes

Sourced from starlette-exporter's releases.

update type hint for buckets param

This small release updates the type hint for the buckets param from List to Sequence to match the type hint in the Prometheus client library. Credit to @sbrandtb (#59)

Exemplar support

Adds exemplar support for the request counter and request latency histograms. This is intended to be used with tracing (e.g. OpenTelemetry).

You must supply your own callback function that returns a trace id to be used as the exemplar. PRs welcome with an example, or a simple OpenTelemetry-based helper function.

Example:
# must use `handle_openmetrics` instead of `handle_metrics` for exemplars to appear in /metrics output.
from starlette_exporter import PrometheusMiddleware, handle_openmetrics
app.add_middleware(
PrometheusMiddleware,
exemplars={"trace_id": get_trace_id}  # supply your own callback function
)
app.add_route("/metrics", handle_openmetrics)
Exemplars are only supported by the openmetrics-text exposition format. A new handle_openmetrics handler function is provided (see above example).

For more information, see the Grafana exemplar documentation.

Custom labels

This release adds a labels argument to PrometheusMiddleware that accepts a dict of labels/values that will be added to all metrics.

Each label's value can be either a static value or, optionally, a callback function that takes the Request instance as its argument and returns a string.

Example:
app.add_middleware(
  PrometheusMiddleware,
  labels={
     "service": "api",
     "env": os.getenv("ENV"),
     "my_header": lambda r: r.headers.get("X-My-Header")
    }
)
Reminder: always evaluate the cardinality of sets of labels before using them, and do not use user-supplied values (e.g. untrusted headers) or unconstrained values to populate labels. See this for more information: https://grafana.com/blog/2022/02/15/what-are-cardinality-spikes-and-why-do-they-matter/

Thank you to @intelroman for helping contribute to this feature.

Optional body size metrics, support for HTTPStatus

Request and response body sizes

... (truncated)

Commits

5de5624 bump to v0.15.1
9ebd1ba Merge pull request #59 from FRI-DAY/fix_typing_in_buckets
e14353e Fix Type Annotations of buckets Parameter
0333b63 fix typo in exemplar section of readme
652409e Merge pull request #58 from stephenhillier/exemplars
2e6c10b simplify always_use_int_status docs
a8e8ce1 remove outdated test
e5688a9 add httpx for starlette test client
b79308a add examplar support
8804643 Merge pull request #55 from poofeg/54-add-py-typed
Additional commits viewable in compare view

You can trigger a rebase of this PR by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

> **Note** > Automatic rebases have been disabled on this pull request as it has been open for over 30 days.