metrics-exporter-prometheus

chore: Release metrics-exporter-prometheus version 0.18.3

Fixed

• Tightened the metrics dependency constraint to ^0.24.5 to avoid build failures when an older metrics 0.24.x is locked. (#692)

Added

• New PrometheusHandle::render_protobuf_to_write method to render the Protocol Buffers payload directly into a Write implementation. (#661)

Changed

• Descriptions are now stored in a lock-free evmap, eliminating writer contention with the rendering hot path. (#672)
• PrometheusRecorder uses Key::to_retained() for more efficient long-lived key storage. (#688)
• License updated to reflect the bundled Prometheus protobuf schema. (#683)
• Use write! in write_metric_line for a small rendering perf improvement. (#658)

Fixed

• Fixed a bug where native histograms were incorrectly skipped when serialized the Protocol Buffers payload. (#649)

Added

• Added with_recommended_naming to PrometheusBuilder, which when set to true will use the recommended naming convention for Prometheus metrics: suffixing counters with _total and ensuring unit suffixes are present. Users should prefer this going forward, and set_enable_unit_suffix is deprecated and will be removed in a future release in favor of with_recommended_naming. (#596)
• Added support for emitting metrics in the Protocol Buffers-based scrape format. The exporter automatically detects which format to render responses in based on the presence/value of the Accept header in requests. Additionally, a new method, PrometheusHandle::render_protobuf, has been added to render metrics in this format, similar to PrometheusHandle::render. (#602)
• Added LabelSet, which provides a wrapper around label key/value pairs to ensure consistent sanitization. (#605)
• Added anew feature flag, push-gateway-no-tls-provider, to allow enabling push gateway support without including a default TLS provider via rustls. Users enabling this flag must install a default TLS provider for rustls via rustls::crypto::CryptoProvider::install_default. (#607)
• Added experimental support for native histograms. Users can enable native histograms using the existing matcher approach by calling PrometheusBuilder::set_native_histogram_for_metric. Native histograms are only rendered when the Protocol Buffers-based scrape format is in use. (#610)
• Added a new method (render_to_write) to PrometheusHandle that allows writing directly to a Write implementation. (#641)

Changed

• Slightly updated the logic for rendering Prometheus outputs to be more incremental where possible to allow render_to_write to be roughly constant memory usage regardless of the overall number of metrics being rendered. (#641)

Fixed

• Fixed a bug where the _total suffix for counters was not being appended to the HELP or TYPE lines for counters. (#597)

Changed

• Update metrics-util to 0.20.

Fixed

• Apply unit suffixes in the correct portion of metric names when unit suffixing is enabled. (#582)

Changed

• Updated rand to 0.9. (#556)
• Bumped thiserror to 2.0. (#572)
• Added new flag, use_http_post_method, to PrometheusBuilder::with_push_gateway, to allow changing the HTTP method used for pushing from PUT to POST. This enables usage with systems like Vector which don't natively support PUT. (#574)
• Render scrape endpoint/push gateway payloads in a blocking thread to avoid blocking regular Tokio executor threads. (#576)

Fixed

• Fixed a bug where the configurable unit suffix was not properly applied to the "sum" and "count" lines for histograms. The prior release will be yanked as this represented a backwards-incompatible change.

Changed

• Updated the crate-level documentation, and the documentation for PrometheusBuilder::build_recorder and PrometheusBuilder::install_recorder, to call out the requirements around running upkeep periodically. (#537)
• Updated to new version of metrics-util.

Added

• Added support for suffixing metric names based on their configured units. (#535)

Added

• Added Debug derive to numerous types. (#504)

Changed

• Fixed a number of Clippy lints. (#510)
• Bump MSRV to 1.71.1. (#530)

Republishing 0.15.2 as 0.15.3 to fix an incorrect publish.

Added

• Added support to use a UDS listener for the HTTP gateway mode. (#498)

Changed

• Update the Content-Type response header to text/plain, matching the Exposition format specification. (#496)

Changed

• Switch to rustls. (#489)

Changed

• Bump MSRV to 1.70.0.

Added

• Users can now configure the number of buckets, and bucket widths, for rolling summaries. (#444)
• Added support to run exporter "upkeep" in the background to periodically drain histograms and help avoid unbounded memory growth over time. (#460)

Changed

• Upgrade to hyper 1.x. (#450)
• Enabled upkeep by default, with a five second interval. (#460)

Added

• A new scrape endpoint path, /health, which returns a a basic response to indicate endpoint health. (#435)

Changed

• Bumped the indexmap dependency to the latest version. (#439)

Added

• Support for using HTTPS in Push Gateway mode. (#392)

Changed

• Bump MSRV to 1.65.0.

Fixed

• Fixed overflow/underflow panic with time moving backwards (#423)

Added

• Support for specifying a username/password for HTTP Basic Authentication when pushing to a Push Gateway. (#366)

Changed

• Bump MSRV to 1.61.0.
• Switch to metrics-exposed version of AtomicU64.

Changed

• Aggregated summaries are now rolling, allowing oldering data points to expire and quantile values to reflect the recent past rather than the lifetime of a histogram. (#306)

  They have a default width of three buckets, with each bucket being 20 seconds wide. This means only the last 60 seconds of a histogram -- in 20 second granularity -- will contribute to the quantiles emitted.

  We'll expose the ability to tune these values in the future.

• Switched to using portable_atomic for 64-bit atomics on more architectures. (#313)

Fixed

• In some cases, metric names were being "sanitized" when they were already valid. (#290, #296)

Added

• New top-level module, formatting, which exposes many of the helper methods used to sanitize and render the actual Prometheus exposition format. (#285)

Added

• New builder method, PrometheusBuilder::install_recorder, which builds and installs the recorder and returns a PrometheusHandle that can be used to interact with the recorder.

Changed

• Updated various dependencies in order to properly scope dependencies to only the necessary feature flags, and thus optimize build times and reduce transitive dependencies.
• Updated to the new handle-based design of metrics.
• Renamed tokio-exporter feature flag to http-listener.
• Renamed PrometheusBuilder::build to build_recorder.
• Renamed PrometheusBuilder::build_with_exporter to build.
• InstallError is now BuildError, and contains many more variants with hopefully) better error messages for understanding when something went wrong.
• Most builder methods are now fallible to help avoid runtime panics for invalid data given when building, and to better surface this upfront to users.
• Rendered output for histograms is now stable, based on the order in which a given key (name/labels) was recorded.

Fixed

• Label keys and values, as well as metric descriptions, are now correctly sanitized according to the Prometheus data model and exposition format. (#248)
• Metric descriptions are correctly mapped to metrics whose names have been modified during sanitization.
• Histograms are now correctly removed when they exceed the idle timeout.

Changed

• Calling PrometheusBuilder::install inside a Tokio runtime will spawn the exporter on that runtime rather than spawning a new runtime. (#251)

Changed

• Simple release to bump dependencies.

Added

• Support for pushing to a Push Gateway. (#217)

Added

• PrometheusBuilder::add_allowed, which enables the exporter to be configured with a list of IP addresses or subnets that are allowed to connect. By default, no restrictions are enforced.

Changed

• Bumped metrics dependency to 0.15 and updated the necessary APIs.

Changed

• Bumped metrics dependency to 0.14.

Changed

• Switched from MetricKind for MetricKindMask for PrometheusBuilder::idle_timeout.

Added

• Genesis of the crate.