@@ -14,13 +14,13 @@ adapt to, but please read the details below:
1414Please refer to [ UPGRADING.md] ( UPGRADING.md ) for details on upgrading from versions
1515` < 3.0.0 ` .
1616
17- - [ #206 ] ( https://github.com/prometheus/client_ruby/pull/206 ) Include ` SCRIPT_NAME ` when
18- determining path in Collector:
17+ - [ #206 ] ( https://github.com/prometheus/client_ruby/pull/206 ) Include ` SCRIPT_NAME ` when
18+ determining path in Collector:
1919 When determining the path for a request, ` Rack::Request ` prefixes the
2020 ` SCRIPT_NAME ` . This was a problem with our code when using mountable engines,
2121 where the engine part of the path gets lost. This patch fixes that to include ` SCRIPT_NAME ` as part of the path.
22-
23- ** This may be a breaking change** . Labels may change in existing metrics.
22+
23+ ** This may be a breaking change** . Labels may change in existing metrics.
2424
2525- [ #245 ] ( https://github.com/prometheus/client_ruby/pull/206 ) Use framework-specific route
2626 info and handle consecutive path segments containing IDs in Collector:
@@ -36,26 +36,26 @@ Please refer to [UPGRADING.md](UPGRADING.md) for details on upgrading from versi
3636 ** This may be a breaking change** . Labels may change in existing metrics.
3737
3838- [ #209 ] ( https://github.com/prometheus/client_ruby/pull/209 ) Automatically initialize metrics
39- without labels.
40- Following the [ Prometheus Best Practices] ( https://prometheus.io/docs/practices/instrumentation/#avoid-missing-metrics ) ,
41- client libraries are expected to automatically export a 0 value when declaring a metric
42- that has no labels.
43- We missed this recommendation in the past, and this wasn't happening. Starting from this
39+ without labels.
40+ Following the [ Prometheus Best Practices] ( https://prometheus.io/docs/practices/instrumentation/#avoid-missing-metrics ) ,
41+ client libraries are expected to automatically export a 0 value when declaring a metric
42+ that has no labels.
43+ We missed this recommendation in the past, and this wasn't happening. Starting from this
4444 version, all metrics without labels will be immediately exported with ` 0 ` value, without
45- need for an increment / observation.
46-
45+ need for an increment / observation.
46+
4747 ** This may be a breaking change** . Depending on your particular metrics, this may
48- result in a significant increase to the number of time series being exported. We
49- recommend you test this and make sure it doesn't cause problems.
48+ result in a significant increase to the number of time series being exported. We
49+ recommend you test this and make sure it doesn't cause problems.
5050
5151- [ #220 ] ( https://github.com/prometheus/client_ruby/pull/220 ) and [ #234 ] ( https://github.com/prometheus/client_ruby/pull/234 )
52- Improvements to Pushgateway client:
53- - The ` job ` parameter is now mandatory when instantiating ` Prometheus::Client::Push `
52+ Improvements to Pushgateway client:
53+ - The ` job ` parameter is now mandatory when instantiating ` Prometheus::Client::Push `
5454 and will raise ` ArgumentError ` if not specified, or if ` nil ` or an empty string/object
5555 are passed.
5656 - The ` Prometheus::Client::Push ` initializer now takes keyword arguments.
5757 - You can now pass a set of arbitrary key-value pairs (` grouping_key ` ) to uniquely
58- identify a job instance, rather than just an ` instance ` label.
58+ identify a job instance, rather than just an ` instance ` label.
5959 - Fixed URI escaping of spaces in the path when pushing to to Pushgateway. In the
6060 past, spaces were being encoded as ` + ` instead of ` %20 ` , which resulted in
6161 incorrect label values in the grouping key.
@@ -65,7 +65,7 @@ Please refer to [UPGRADING.md](UPGRADING.md) for details on upgrading from versi
6565 - We validate that labels in your ` grouping_key ` don't clash with labels in the
6666 metrics being submitted, and raise an error if they do.
6767 - We raise an error on a non-2xx HTTP response from the Pushgateway.
68-
68+
6969 ** This is a breaking change if you use Pushgateway** . You will need to update your
7070 code to pass keyword arguments to the ` Prometheus::Client::Push ` initializer.
7171
@@ -101,35 +101,35 @@ Please refer to [UPGRADING.md](UPGRADING.md) for details on upgrading from versi
101101## New Features
102102
103103- [ #199 ] ( https://github.com/prometheus/client_ruby/pull/199 ) Add ` port ` filtering option
104- to Exporter middleware.
104+ to Exporter middleware.
105105 You can now specify a ` port ` when adding ` Prometheus::Middleware::Exporter ` to your
106106 middleware chain, and metrics will only be exported if the ` /metrics ` request comes
107107 through that port.
108108
109- - [ #222 ] ( https://github.com/prometheus/client_ruby/pull/222 ) Enable configuring ` Net::HTTP `
110- timeouts for Pushgateway calls.
111- You can now specify ` open_timeout ` and ` read_timeout ` when instantiating
109+ - [ #222 ] ( https://github.com/prometheus/client_ruby/pull/222 ) Enable configuring ` Net::HTTP `
110+ timeouts for Pushgateway calls.
111+ You can now specify ` open_timeout ` and ` read_timeout ` when instantiating
112112 ` Prometheus::Client::Push ` , to control these timeouts.
113113
114114## Code improvements and bug fixes
115115
116- - [ #201 ] ( https://github.com/prometheus/client_ruby/pull/201 ) Make all registry methods
116+ - [ #201 ] ( https://github.com/prometheus/client_ruby/pull/201 ) Make all registry methods
117117 thread safe.
118118
119- - [ #227 ] ( https://github.com/prometheus/client_ruby/pull/227 ) Fix ` with_labels ` bug that
120- made it completely non-functional, and occasionally resulted in ` DirectFileStore ` file
119+ - [ #227 ] ( https://github.com/prometheus/client_ruby/pull/227 ) Fix ` with_labels ` bug that
120+ made it completely non-functional, and occasionally resulted in ` DirectFileStore ` file
121121 corruption.
122122
123123
124124# 2.1.0 / 2020-06-29
125125
126126## New Features
127127
128- - [ #177 ] ( https://github.com/prometheus/client_ruby/pull/177 ) Added Histogram helpers to
128+ - [ #177 ] ( https://github.com/prometheus/client_ruby/pull/177 ) Added Histogram helpers to
129129 generate linear and exponential buckets, as the Client Library Guidelines recommend.
130- - [ #172 ] ( https://github.com/prometheus/client_ruby/pull/172 ) Added : most_recent
130+ - [ #172 ] ( https://github.com/prometheus/client_ruby/pull/172 ) Added : most_recent
131131 aggregation for gauges on DirectFileStore.
132-
132+
133133## Code improvements
134134
135135- Fixed several warnings that started firing in the latest versions of Ruby.
@@ -138,7 +138,7 @@ Please refer to [UPGRADING.md](UPGRADING.md) for details on upgrading from versi
138138
139139## Breaking changes
140140
141- - [ #176 ] ( https://github.com/prometheus/client_ruby/pull/176 ) BUGFIX: Values observed at
141+ - [ #176 ] ( https://github.com/prometheus/client_ruby/pull/176 ) BUGFIX: Values observed at
142142 the upper limit of a histogram bucket are now counted in that bucket, not the following
143143 one. This is unlikely to break functionality and you probably don't need to make code
144144 changes, but it may break tests.
@@ -156,6 +156,6 @@ Please refer to [UPGRADING.md](UPGRADING.md) for details on upgrading from versi
156156- This release saw a number of breaking changes to better comply with latest best practices
157157 for naming and client behaviour. Please refer to [ UPGRADING.md] ( UPGRADING.md ) for details
158158 if upgrading from ` <= 0.9 ` .
159-
159+
160160- The main feature of this release was adding support for multi-process environments such
161161 as pre-fork servers (Unicorn, Puma).
0 commit comments