Skip to content

Releases: prometheus/client_golang

v1.22.0 - 2025-04-07

08 Apr 08:08
v1.22.0
d50be25
Compare
Choose a tag to compare

⚠️ This release contains potential breaking change if you use experimental zstd support introduce in #1496 ⚠️

Experimental support for zstd on scrape was added, controlled by the request Accept-Encoding header.
It was enabled by default since version 1.20, but now you need to add a blank import to enable it.
The decision to make it opt-in by default was originally made because the Go standard library was expected to have default zstd support added soon,
golang/go#62513 however, the work took longer than anticipated and it will be postponed to upcoming major Go versions.

e.g.:

import (
  _ "github.com/prometheus/client_golang/prometheus/promhttp/zstd"
)
  • [FEATURE] prometheus: Add new CollectorFunc utility #1724
  • [CHANGE] Minimum required Go version is now 1.22 (we also test client_golang against latest go version - 1.24) #1738
  • [FEATURE] api: WithLookbackDelta and WithStats options have been added to API client. #1743
  • [CHANGE] ⚠️ promhttp: Isolate zstd support and klauspost/compress library use to promhttp/zstd package. #1765
All Changes

New Contributors

Full Changelog: v1.21.1...v1.22.0-rc.0

v1.22.0-rc.0 / 2025-03-07

07 Mar 17:00
v1.22.0-rc.0
1043db7
Compare
Choose a tag to compare
Pre-release

⚠️ This release contains potential breaking change if you use experimental zstd support introduce in #1496 ⚠️

Experimental support for zstd on scrape was added, controlled by the request Accept-Encoding header.
It was enabled by default since version 1.20, but now you need to add a blank import to enable it.
The decision to make it opt-in by default was originally made because the Go standard library was expected to have default zstd support added soon,
golang/go#62513 however, the work took longer than anticipated and it will be postponed to upcoming major Go versions.

e.g.:

import (
  _ "github.com/prometheus/client_golang/prometheus/promhttp/zstd"
)
  • [FEATURE] prometheus: Add new CollectorFunc utility #1724
  • [CHANGE] Minimum required Go version is now 1.22 (we also test client_golang against latest go version - 1.24) #1738
  • [FEATURE] api: WithLookbackDelta and WithStats options have been added to API client. #1743
  • [CHANGE] ⚠️ promhttp: Isolate zstd support and klauspost/compress library use to promhttp/zstd package. #1765
All Changes

New Contributors

Full Changelog: v1.21.1...v1.22.0-rc.0

v1.21.1 / 2025-03-04

04 Mar 14:29
v1.21.1
8a42da3
Compare
Choose a tag to compare

This release addresses a performance regression introduced in #1661 -- thanks to all who reported this quickly:
@chlunde, @dethi, @aaronbee @tsuna @kakkoyun 💪🏽. This patch release also fixes the iOS build.

We will be hardening the release process even further (#1759, #1761) to prevent this in future, sorry for the inconvenience!

The high concurrency optimization is planned to be eventually reintroduced, however in a much safer manner, potentially in a separate API.

  • [BUGFIX] prometheus: Revert of Inc, Add and Observe cumulative metric CAS optimizations (#1661), causing regressions on low concurrency cases #1757
  • [BUGFIX] prometheus: Fix GOOS=ios build, broken due to process_collector_* wrong build tags. #1758
All commits
  • Revert "exponential backoff for CAS operations on floats" and cut 1.21.1 by @bwplotka in #1757
  • Fix ios build for 1.21.1 by @bwplotka in #1758

Full Changelog: v1.21.0...v1.21.1

v1.21.0 / 2025-02-19

19 Feb 08:46
v1.21.0
eaf03ef
Compare
Choose a tag to compare

⚠️ This release contains potential breaking change if you upgrade github.com/prometheus/common to 0.62+ together with client_golang (and depend on the strict, legacy validation for the label names). New common version changes model.NameValidationScheme global variable, which relaxes the validation of label names and metric name, allowing all UTF-8 characters. Typically, this should not break any user, unless your test or usage expects strict certain names to panic/fail on client_golang metric registration, gathering or scrape. In case of problems change model.NameValidationScheme to old model.LegacyValidation value in your project init function. ⚠️

  • [BUGFIX] gocollector: Fix help message for runtime/metric metrics. #1583
  • [BUGFIX] prometheus: Fix Desc.String() method for no labels case. #1687
  • [PERF] prometheus: Optimize popular prometheus.BuildFQName function; now up to 30% faster. #1665
  • [PERF] prometheus: Optimize Inc, Add and Observe cumulative metrics; now up to 50% faster under high concurrent contention. #1661
  • [CHANGE] Upgrade prometheus/common to 0.62.0 which changes model.NameValidationScheme global variable. #1712
  • [CHANGE] Add support for Go 1.23. #1602
  • [FEATURE] process_collector: Add support for Darwin systems. #1600 #1616 #1625 #1675 #1715
  • [FEATURE] api: Add ability to invoke CloseIdleConnections on api.Client using api.Client.(CloseIdler).CloseIdleConnections() casting. #1513
  • [FEATURE] promhttp: Add promhttp.HandlerOpts.EnableOpenMetricsTextCreatedSamples option to create OpenMetrics _created lines. Not recommended unless you want to use opt-in Created Timestamp feature. Community works on OpenMetrics 2.0 format that should make those lines obsolete (they increase cardinality significantly). #1408
  • [FEATURE] prometheus: Add NewConstNativeHistogram function. #1654
All commits * Merge release-1.20 to main by @bwplotka in https://github.com//pull/1582 * gocollector: Tiny fix for help message with runtime/metrics source. by @bwplotka in https://github.com//pull/1583 * ci: bump dagger to the latest version by @marcosnils in https://github.com//pull/1588 * Merge release-1.20 back to main by @ArthurSens in https://github.com//pull/1593 * Update linting by @SuperQ in https://github.com//pull/1603 * Update supported Go versions by @SuperQ in https://github.com//pull/1602 * build(deps): bump golang.org/x/sys from 0.22.0 to 0.24.0 by @dependabot in https://github.com//pull/1611 * build(deps): bump github.com/prometheus/common from 0.55.0 to 0.57.0 by @dependabot in https://github.com//pull/1612 * changed the name of all variables with min/max name by @parthlaw in https://github.com//pull/1606 * Update Dagger and build. by @SuperQ in https://github.com//pull/1610 * build(deps): bump github/codeql-action from 3.25.15 to 3.26.6 in the github-actions group across 1 directory by @dependabot in https://github.com//pull/1614 * examples: Improved GoCollector example. by @bwplotka in https://github.com//pull/1589 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com//pull/1615 * process_collector: fill in most statistics on macOS by @mharbison72 in https://github.com//pull/1600 * ⚡ http client defer CloseIdleConnections by @cuisongliu in https://github.com//pull/1513 * Set allow-utf-8 in Format during tests to avoid escaping. by @ywwg in https://github.com//pull/1618 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com//pull/1622 * Merge Release 1.20 back to main by @ArthurSens in https://github.com//pull/1627 * examples: Add custom labels example by @ying-jeanne in https://github.com//pull/1626 * Refactor default runtime metrics tests for Go collector so that default runtime metric set autogenerates by @vesari in https://github.com//pull/1631 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com//pull/1628 * process_xxx_memory statistics for macOS (cgo) by @mharbison72 in https://github.com//pull/1616 * build(deps): bump github.com/klauspost/compress from 1.17.9 to 1.17.10 by @dependabot in https://github.com//pull/1633 * build(deps): bump golang.org/x/sys from 0.24.0 to 0.25.0 by @dependabot in https://github.com//pull/1632 * process_collector: Add Platform-Specific Describe for processCollector by @ying-jeanne in https://github.com//pull/1625 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com//pull/1635 * build(deps): bump the github-actions group with 4 updates by @dependabot in https://github.com//pull/1634 * Optionally print OM created lines by @ArthurSens in https://github.com//pull/1408 * process_collector: merge wasip1 and js into a single implementation by @ying-jeanne in https://github.com//pull/1644 * Merge release 1.20 to main by @bwplotka in https://github.com//pull/1647 * Add Arianna as maintainer 💪 by @ArthurSens in https://github.com//pull/1651 * test add headers round tripper by @Manask322 in https://github.com//pull/1657 * build(deps): bump github.com/klauspost/compress from 1.17.10 to 1.17.11 by @dependabot in https://github.com//pull/1668 * build(deps): bump golang.org/x/sys from 0.25.0 to 0.26.0 by @dependabot in https://github.com//pull/1669 * build(deps): bump github.com/prometheus/common from 0.59.1 to 0.60.1 by @dependabot in https://github.com//pull/1667 * build(deps): bump google.golang.org/protobuf from 1.34.2 to 1.35.1 by @dependabot in https://github.com//pull/1670 * Optimize BuildFQName function by @jkroepke in https://github.com//pull/1665 * fix: use injected now() instead of time.Now() in summary methods by @imorph in https://github.com//pull/1672 * process_collector: avoid a compiler warning on macOS (fixes #1660) by @mharbison72 in https://github.com//pull/1675 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com//pull/1674 * build(deps): bump the github-actions group across 1 directory with 3 updates by @dependabot in https://github.com//pull/1678 * [chore]: enable perfsprint linter by @mmorel-35 in https://github.com//pull/1676 * Duplicate of #1662 by @imorph in https://github.com//pull/1673 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com//pull/1679 * chore: enable usestdlibvars linter by @mmorel-35 in https://github.com//pull/1680 * Add: exponential backoff for CAS operations on floats by @imorph in https://github.com//pull/1661 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com//pull/1683 * [1617] Add ConstnativeHistogram by @shivanthzen in https://github.com//pull/1654 * fix: replace fmt.Errorf with errors.New by @kakkoyun in https://github.com//pull/1689 * Add codeowners by @kakkoyun in https://github.com//pull/1688 * fix: add very small delay between observations in `TestHistogramAtomicObserve` by @imorph in https://github.com//pull/1691 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com//pull/1692 * Fix: handle nil variableLabels in Desc.String() method and add tests for nil label values by @kakkoyun in https://github.com//pull/1687 * examples: Follow best practices and established naming conventions by @lilic in https://github.com//pull/1650 * setup OSSF Scorecard workflow by @mmorel-35 in https://github.com//pull/1432 * build(deps): bump google.golang.org/protobuf from 1.35.1 to 1.35.2 by @dependabot in https://github.com//pull/1697 * build(deps): bump golang.org/x/sys from 0.26.0 to 0.27.0 by @dependabot in https://github.com//pull/1696 * build(deps): bump the github-actions group with 5 updates by @dependabot in https://github.com//pull/1695 * update links to openmetrics to reference the v1.0.0 release by @dashpole in https://github.com//pull/1699 * build(deps): bump google.golang.org/protobuf from 1.35.2 to 1.36.1 by @dependabot in https://github.com//pull/1706 * build(deps): bump golang.org/x/sys from 0.27.0 to 0.28.0 by @dependabot in https://github.com//pull/1705 * build(deps): bump the github-actions group with 5 updates by @dependabot in https://github.com//pull/1707 * build(deps): bump github.com/prometheus/common from 0.60.1 to 0.61.0 by @dependabot in https://github.com//pull/1704 * Synchronize common files from prometheus/prometheus by @prombot in https://github.com/prom...
Read more

v1.21.0-rc.0 / 2025-01-21

21 Jan 18:03
v1.21.0-rc.0
f1f89dc
Compare
Choose a tag to compare
Pre-release

⚠️ This release contains potential breaking change if you upgrade github.com/prometheus/common to 0.62+ together with client_golang. ⚠️

New common version changes model.NameValidationScheme global variable, which relaxes the validation of label names and metric name, allowing all UTF-8 characters. Typically, this should not break any user, unless your test or usage expects strict certain names to panic/fail on client_golang metric registration, gathering or scrape. In case of problems change model.NameValidationScheme to old model.LegacyValidation value in your project init function.

  • [BUGFIX] gocollector: Fix help message for runtime/metric metrics. #1583
  • [BUGFIX] prometheus: Fix Desc.String() method for no labels case. #1687
  • [ENHANCEMENT] prometheus: Optimize popular prometheus.BuildFQName function; now up to 30% faster. #1665
  • [ENHANCEMENT] prometheus: Optimize Inc, Add and Observe cumulative metrics; now up to 50% faster under high concurrent contention. #1661
  • [CHANGE] Upgrade prometheus/common to 0.62.0 which changes model.NameValidationScheme global variable. #1712
  • [CHANGE] Add support for Go 1.23. #1602
  • [FEATURE] process_collector: Add support for Darwin systems. #1600 #1616 #1625 #1675 #1715
  • [FEATURE] api: Add ability to invoke CloseIdleConnections on api.Client using api.Client.(CloseIdler).CloseIdleConnections() casting. #1513
  • [FEATURE] promhttp: Add promhttp.HandlerOpts.EnableOpenMetricsTextCreatedSamples option to create OpenMetrics _created lines. Not recommended unless you want to use opt-in Created Timestamp feature. Community works on OpenMetrics 2.0 format that should make those lines obsolete (they increase cardinality significantly). #1408
  • [FEATURE] prometheus: Add NewConstNativeHistogram function. #1654
All commits
  • Merge release-1.20 to main by @bwplotka in #1582
  • gocollector: Tiny fix for help message with runtime/metrics source. by @bwplotka in #1583
  • ci: bump dagger to the latest version by @marcosnils in #1588
  • Merge release-1.20 back to main by @ArthurSens in #1593
  • Update linting by @SuperQ in #1603
  • Update supported Go versions by @SuperQ in #1602
  • build(deps): bump golang.org/x/sys from 0.22.0 to 0.24.0 by @dependabot in #1611
  • build(deps): bump github.com/prometheus/common from 0.55.0 to 0.57.0 by @dependabot in #1612
  • changed the name of all variables with min/max name by @parthlaw in #1606
  • Update Dagger and build. by @SuperQ in #1610
  • build(deps): bump github/codeql-action from 3.25.15 to 3.26.6 in the github-actions group across 1 directory by @dependabot in #1614
  • examples: Improved GoCollector example. by @bwplotka in #1589
  • Synchronize common files from prometheus/prometheus by @prombot in #1615
  • process_collector: fill in most statistics on macOS by @mharbison72 in #1600
  • ⚡ http client defer CloseIdleConnections by @cuisongliu in #1513
  • Set allow-utf-8 in Format during tests to avoid escaping. by @ywwg in #1618
  • Synchronize common files from prometheus/prometheus by @prombot in #1622
  • Merge Release 1.20 back to main by @ArthurSens in #1627
  • examples: Add custom labels example by @ying-jeanne in #1626
  • Refactor default runtime metrics tests for Go collector so that default runtime metric set autogenerates by @vesari in #1631
  • Synchronize common files from prometheus/prometheus by @prombot in #1628
  • process_xxx_memory statistics for macOS (cgo) by @mharbison72 in #1616
  • build(deps): bump github.com/klauspost/compress from 1.17.9 to 1.17.10 by @dependabot in #1633
  • build(deps): bump golang.org/x/sys from 0.24.0 to 0.25.0 by @dependabot in #1632
  • process_collector: Add Platform-Specific Describe for processCollector by @ying-jeanne in #1625
  • Synchronize common files from prometheus/prometheus by @prombot in #1635
  • build(deps): bump the github-actions group with 4 updates by @dependabot in #1634
  • Optionally print OM created lines by @ArthurSens in #1408
  • process_collector: merge wasip1 and js into a single implementation by @ying-jeanne in #1644
  • Merge release 1.20 to main by @bwplotka in #1647
  • Add Arianna as maintainer 💪 by @ArthurSens in #1651
  • test add headers round tripper by @Manask322 in #1657
  • build(deps): bump github.com/klauspost/compress from 1.17.10 to 1.17.11 by @dependabot in #1668
  • build(deps): bump golang.org/x/sys from 0.25.0 to 0.26.0 by @dependabot in #1669
  • build(deps): bump github.com/prometheus/common from 0.59.1 to 0.60.1 by @dependabot in #1667
  • build(deps): bump google.golang.org/protobuf from 1.34.2 to 1.35.1 by @dependabot in #1670
  • Optimize BuildFQName function by @jkroepke in #1665
  • fix: use injected now() instead of time.Now() in summary methods by @imorph in #1672
  • process_collector: avoid a compiler warning on macOS (fixes #1660) by @mharbison72 in #1675
  • Synchronize common files from prometheus/prometheus by @prombot in #1674
  • build(deps): bump the github-actions group across 1 directory with 3 updates by @dependabot in #1678
  • [chore]: enable perfsprint linter by @mmorel-35 in #1676
  • Duplicate of #1662 by @imorph in #1673
  • Synchronize common files from prometheus/prometheus by @prombot in #1679
  • chore: enable usestdlibvars linter by @mmorel-35 in #1680
  • Add: exponential backoff for CAS operations on floats by @imorph in #1661
  • Synchronize common files from prometheus/prometheus by @prombot in #1683
  • [1617] Add ConstnativeHistogram by @shivanthzen in #1654
  • fix: replace fmt.Errorf with errors.New by @kakkoyun in #1689
  • Add codeowners by @kakkoyun in #1688
  • fix: add very small delay between observations in TestHistogramAtomicObserve by @imorph in #1691
  • Synchronize common files from prometheus/prometheus by @prombot in #1692
  • Fix: handle nil variableLabels in Desc.String() method and add tests for nil label values by @kakkoyun in #1687
  • examples: Follow best practices and established naming conventions by @lilic in #1650
  • setup OSSF Scorecard workflow by @mmorel-35 in #1432
  • build(deps): bump google.golang.org/protobuf from 1.35.1 to 1.35.2 by @dependabot in #1697
  • build(deps): bump golang.org/x/sys from 0.26.0 to 0.27.0 by @dependabot in #1696
  • build(deps): bump the github-actions group with 5 updates by @dependabot in #1695
  • update links to openmetrics to reference the v1.0.0 release by @dashpole in #1699
  • build(deps): bump google.golang.org/protobuf from 1.35.2 to 1.36.1 by @dependabot in #1706
  • build(deps): bump golang.org/x/sys from 0.27.0 to 0.28.0 by @dependabot in #1705
  • build(deps): bump the github-actions group with 5 updates by @dependabot in #1707
  • build(deps): bump github.com/prometheus/common from 0.60.1 to 0.61.0 by @dependabot in #1704
  • Synchronize common files from prometheus/prometheus by @prombot in #1703
  • Synchronize c...
Read more

v1.20.5 / 2024-10-15

15 Oct 10:05
48e12a1
Compare
Choose a tag to compare

We decided to revert the testutil change that made our util functions less error-prone, but created a lot of work for our downstream users. Apologies for the pain! This revert should not cause any major breaking change, even if you already did the work--unless you depend on the exact error message.

Going forward, we plan to reinforce our release testing strategy [1],[2] and deliver an enhanced testutil package/module with more flexible and safer APIs.

Thanks to @dashpole @dgrisonnet @kakkoyun @ArthurSens @vesari @logicalhan @krajorama @bwplotka who helped in this patch release! 🤗

Changelog

[BUGFIX] testutil: Reverted #1424; functions using compareMetricFamilies are (again) only failing if filtered metricNames are in the expected input. #1645

v1.20.4

17 Sep 08:01
05fcde9
Compare
Choose a tag to compare
  • [BUGFIX] histograms: Fix a possible data race when appending exemplars vs metrics gather. #1623

v1.20.3

05 Sep 12:31
ef2f87e
Compare
Choose a tag to compare
  • [BUGFIX] histograms: Fix possible data race when appending exemplars. #1608

v1.20.2

23 Aug 19:10
67121dc
Compare
Choose a tag to compare
  • [BUGFIX] promhttp: Unset Content-Encoding header when data is uncompressed. #1596

v1.20.1

20 Aug 11:47
2254d6c
Compare
Choose a tag to compare

This release contains the critical fix for the issue. Thanks to @geberl, @CubicrootXYZ, @zetaab and @timofurrer for helping us with the investigation!

  • [BUGFIX] process-collector: Fixed unregistered descriptor error when using process collector with PedanticRegistry on Linux machines. #1587