Skip to content

Commit 0736ca1

Browse files
committed
Update CHANGELOG.md for 4.0.0
Signed-off-by: Chris Sinjakli <chris@sinjakli.co.uk>
1 parent 62dcd1a commit 0736ca1

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,39 @@
44

55
_None outstanding_
66

7+
# 4.0.0 / 2022-03-27
8+
9+
_**Codename:** The "barely a release" release_
10+
11+
This version contains a single - sadly breaking - change.
12+
13+
- [#251](https://github.com/prometheus/client_ruby/pull/251) Remove framework-specific
14+
route detection from collector middleware:
15+
In 3.0.0 [we shipped](https://github.com/prometheus/client_ruby/issues/245) a feature
16+
that attempted to use framework-specific information to determine the path of the
17+
request in `Prometheus::Middleware::Collector`.
18+
19+
Sadly, we found out after shipping it that it was prone to multiple issues. We spent
20+
a decent amount of time looking into them in depth, and came to the conclusion that
21+
there wasn't any reasonable way to fix them - the issues are inherent to the feature.
22+
23+
For a full, detailed write-up of our investigation, see [this
24+
comment](https://github.com/prometheus/client_ruby/issues/249#issuecomment-1061317511).
25+
26+
Almost all users will be unaffected by this change, but it is breaking per the
27+
definition we've used for previous releases, so we've erred on the side of caution and
28+
bumped the major version to communicate that.
29+
30+
If you use Sinatra or Grape with the `Prometheus::Middleware::Collector`, you will
31+
notice different `path` labels being generated. If not, this release will change
32+
nothing for you.
33+
34+
If you want the behaviour from 3.0.0 - or any custom path label generation you'd
35+
prefer - we've updated [our collector middleware
36+
documentation](https://github.com/prometheus/client_ruby/blob/master/examples/rack/README.md#collector).
37+
38+
**This may be a breaking change**. Labels may change in existing metrics.
39+
740
# 3.0.0 / 2022-02-05
841

942
This new major version includes some breaking changes. They should be reasonably easy to

0 commit comments

Comments
 (0)