Skip to content

Commit 05823a8

Browse files
committed
Add instructions for 4.0.0 to UPGRADING.md
Signed-off-by: Chris Sinjakli <[email protected]>
1 parent 0736ca1 commit 05823a8

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

UPGRADING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
# Upgrading from 3.x.x to 4.x.x
2+
3+
## Objectives
4+
5+
4.0.0 contains a single breaking change - the [removal
6+
of](https://github.com/prometheus/client_ruby/pull/251) [framework-specific route
7+
detection](https://github.com/prometheus/client_ruby/pull/245) from
8+
`Prometheus::Middleware::Collector`.
9+
10+
## Removal of framework-specific route detection
11+
12+
In 3.0.0 we added a feature that used specific information provided by the Sinatra and
13+
Grape web frameworks to generate the `path` label in `Prometheus::Middleware::Collector`.
14+
15+
This feature turned out to be inherently flawed, due to limitations in the information we
16+
can extract from the request environment. [This
17+
comment](https://github.com/prometheus/client_ruby/issues/249#issuecomment-1061317511)
18+
goes into much more depth on the investigation we did and the conclusions we came to.
19+
20+
Most users will be unaffected by this change. If you use Sinatra or Grape and
21+
`Prometheus::Middleware::Collector` you will notice that your `path` label values will be
22+
much more similar to the ones we generated in the 2.x.x release series.
23+
124
# Upgrading from 2.x.x to 3.x.x
225

326
## Objectives

0 commit comments

Comments
 (0)