Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump prometheus-client from 2.1.0 to 3.0.0 #181

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 7, 2022

Bumps prometheus-client from 2.1.0 to 3.0.0.

Release notes

Sourced from prometheus-client's releases.

v3.0.0 / 2022-02-05

This new major version includes some breaking changes. They should be reasonably easy to adapt to, but please read the details below:

Breaking changes

Please refer to https://github.com/prometheus/client_ruby/blob/HEAD/UPGRADING.md for details on upgrading from versions < 3.0.0.

  • #206 Include SCRIPT_NAME when determining path in Collector: When determining the path for a request, Rack::Request prefixes the SCRIPT_NAME. This was a problem with our code when using mountable engines, where the engine part of the path gets lost. This patch fixes that to include SCRIPT_NAME as part of the path.

    This may be a breaking change. Labels may change in existing metrics.

  • #245 Use framework-specific route info and handle consecutive path segments containing IDs in Collector: When generating the path label, we now use framework-specific information from the request environment to produce better labels for apps written in the Sinatra and Grape frameworks. Rails doesn't provide the information we need to do the same there, but we hope to get such functionality added in a future release.

    Our framework-agnostic fallback (which Rails apps will use) has also been improved. It now supports stripping IDs/UUIDs from consecutive path segments, where previously only alternating segments would be correctly stripped.

    This may be a breaking change. Labels may change in existing metrics.

  • #209 Automatically initialize metrics without labels. Following the Prometheus Best Practices, client libraries are expected to automatically export a 0 value when declaring a metric that has no labels. We missed this recommendation in the past, and this wasn't happening. Starting from this version, all metrics without labels will be immediately exported with 0 value, without need for an increment / observation.

    This may be a breaking change. Depending on your particular metrics, this may result in a significant increase to the number of time series being exported. We recommend you test this and make sure it doesn't cause problems.

  • #220 and #234 Improvements to Pushgateway client:

    • The job parameter is now mandatory when instantiating Prometheus::Client::Push and will raise ArgumentError if not specified, or if nil or an empty string/object are passed.
    • The Prometheus::Client::Push initializer now takes keyword arguments.
    • You can now pass a set of arbitrary key-value pairs (grouping_key) to uniquely

... (truncated)

Changelog

Sourced from prometheus-client's changelog.

3.0.0 / 2022-02-05

This new major version includes some breaking changes. They should be reasonably easy to adapt to, but please read the details below:

Breaking changes

Please refer to https://github.com/prometheus/client_ruby/blob/master/UPGRADING.md for details on upgrading from versions < 3.0.0.

  • #206 Include SCRIPT_NAME when determining path in Collector: When determining the path for a request, Rack::Request prefixes the SCRIPT_NAME. This was a problem with our code when using mountable engines, where the engine part of the path gets lost. This patch fixes that to include SCRIPT_NAME as part of the path.

    This may be a breaking change. Labels may change in existing metrics.

  • #245 Use framework-specific route info and handle consecutive path segments containing IDs in Collector: When generating the path label, we now use framework-specific information from the request environment to produce better labels for apps written in the Sinatra and Grape frameworks. Rails doesn't provide the information we need to do the same there, but we hope to get such functionality added in a future release.

    Our framework-agnostic fallback (which Rails apps will use) has also been improved. It now supports stripping IDs/UUIDs from consecutive path segments, where previously only alternating segments would be correctly stripped.

    This may be a breaking change. Labels may change in existing metrics.

  • #209 Automatically initialize metrics without labels. Following the Prometheus Best Practices, client libraries are expected to automatically export a 0 value when declaring a metric that has no labels. We missed this recommendation in the past, and this wasn't happening. Starting from this version, all metrics without labels will be immediately exported with 0 value, without need for an increment / observation.

    This may be a breaking change. Depending on your particular metrics, this may result in a significant increase to the number of time series being exported. We recommend you test this and make sure it doesn't cause problems.

  • #220 and #234 Improvements to Pushgateway client:

    • The job parameter is now mandatory when instantiating Prometheus::Client::Push and will raise ArgumentError if not specified, or if nil or an empty string/object are passed.
    • The Prometheus::Client::Push initializer now takes keyword arguments.

... (truncated)

Commits
  • 82d41f1 Merge pull request #246 from prometheus/sinjo-update-readme-date
  • 16a8c54 Fill in placeholder date in CHANGELOG.md
  • 9431ca2 Merge pull request #244 from prometheus/sinjo-release-3.0.0
  • 57feffb Merge pull request #245 from prometheus/sinjo-better-path-labels
  • e213a71 Bump version for 3.0.0 release
  • 39b3fa4 Strip trailing whitespace in CHANGELOG.md
  • 0b23ea3 Update CHANGELOG.md for 3.0.0
  • e0456e9 Update CHANGELOG in preparation for 2.2.0 release
  • 9d8ba56 Update UPGRADING.md
  • 1b159e5 Handle consecutive path segments containing IDs in collector
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually 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)

Bumps [prometheus-client](https://github.com/prometheus/client_ruby) from 2.1.0 to 3.0.0.
- [Release notes](https://github.com/prometheus/client_ruby/releases)
- [Changelog](https://github.com/prometheus/client_ruby/blob/master/CHANGELOG.md)
- [Commits](prometheus/client_ruby@v2.1.0...v3.0.0)

---
updated-dependencies:
- dependency-name: prometheus-client
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file ruby Pull requests that update Ruby code labels Feb 7, 2022
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Mar 28, 2022

Superseded by #189.

@dependabot dependabot bot closed this Mar 28, 2022
@dependabot dependabot bot deleted the dependabot/bundler/prometheus-client-3.0.0 branch March 28, 2022 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file ruby Pull requests that update Ruby code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants