diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..65b05480 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,122 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +--- + +## [Unreleased] + +### Added +- + +### Changed +- + +### Deprecated +- + +### Removed +- + +### Fixed +- + +### Security +- + +--- + +## [0.4.1](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.4.1) - 2023-05-05 + +### Changed + +- Overhaul documentation + +### Fixed + +- Generated latency query needs additional labels to show lines for 95th and 99th percentiles + +## [0.4.0](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.4.0) - 2023-04-26 + +### Added + +- `build_info` metric tracks software version and commit +- Queries now use `build_info` metric to correlate version info with problems + +### Fixed + +- Prometheus rules handle when the counter metric name has a `_total` suffix + +## [0.3.3](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.3.3) - 2023-04-14 + +### Added + +- Alerts have minimum traffic threshold of 1 request / minute + +### Fixed + +- Latency SLO total query in alerting rules + +## [0.3.1](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.3.1) - 2023-03-21 + +### Added + +- `custom-objective-latency` and `custom-objective-percentile` feature flags + +### Changed + +- Use the OpenTelemetry default histogram buckets + +### Removed + +- Remove the latency objective values for 150, 200, and 350 milliseconds +- `custom-objectives` feature flag + +## [0.3.0](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.3.0) - 2023-03-14 + +### Added + +- Support defining Service-Level Objectives (SLOs) in code +- CLI to generate Sloth file, which is then used to generate Prometheus alerting rules +- `#[skip_autometrics]` annotation when applying autometrics to an `impl` block +- `ok_if` and `error_if` autometrics parameters + +## [0.2.4](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.2.4) - 2023-02-08 + +### Fixed + +- Histogram buckets + + +## [0.2.3](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.2.3) - 2023-01-31 + +### Fixed + +- Building of documentation on docs.rs + +## [0.2.0](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.2.0) - 2023-01-31 + +### Added + +- Support `opentelemetry` and `metrics` crates for tracking metrics +- Support applying autometrics to an `impl` block + +### Changed + +- Tracking function concurrency is optional + +## [0.1.1](https://github.com/autometrics-dev/autometrics-rs/releases/tag/v0.1.1) - 2023-01-27 + +### Added + +- Track concurrent requests +- Add return types as labels +- Separate function call counter +- `caller` label + +### Changed + +- Use OpenTelemetry metric naming conventions