From 26e337ebda5839d019d96f553a62b2eba399a96c Mon Sep 17 00:00:00 2001 From: Yingrong Zhao Date: Mon, 4 Dec 2023 18:09:54 -0500 Subject: [PATCH] maint: update release docs for v2.2 (#930) ## Which problem is this PR solving? - Prepare release docs for v2.2 ## Short description of the changes Update CHANGELOG and Release Notes --------- Co-authored-by: Kent Quirk --- CHANGELOG.md | 41 +++++++++++++++++++++++++++++++++++++++++ RELEASE_NOTES.md | 17 +++++++++++++++++ 2 files changed, 58 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b783e26c98..1d2efdb0bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,46 @@ # Refinery Changelog +## 2.2.0 2023-12-04 + +This is a minor release with several new configuration options and bug fixes, and is recommended for all Refinery users. See [Release Notes](./RELEASE_NOTES.md) for a summary of changes. + +## Features +- feat(config): expose IdleTimeout for http.Server (#919) | [Yingrong Zhao](https://github.com/vinozzZ) +- feat: Add GRPC configuration option, rework grpc config a bit (#917) | [Kent Quirk](https://github.com/kentquirk) +- feat(config): allow separate config for peer and incoming span queue (#916) | [Yingrong Zhao](https://github.com/vinozzZ) +- feat(config): add AddCountsToRoot to report counts data for traces (#910) | [Yingrong Zhao](https://github.com/vinozzZ) +- feat: enable sampling for stdout logger (#892) | [Yingrong Zhao](https://github.com/vinozzZ) +- feat: Add Redis Auth Authentication (#859) | [Davin Taddeo](https://github.com/tdarwin) + +## Fixes +- fix(config/metadata): fix reference in description for MaxMemoryPercentage (#926) | [Yingrong Zhao](https://github.com/vinozzZ) +- fix: default values in new config parameters (#925) | [Kent Quirk](https://github.com/kentquirk) +- fix: Allow non-ints in memorysize (#914) | [Kent Quirk](https://github.com/kentquirk) +- fix: load default config and rules file in service file (#900) | [Yingrong Zhao](https://github.com/vinozzZ) +- fix: add refinery version to refinery metric and log (#899) | [Yingrong Zhao](https://github.com/vinozzZ) +- fix: add steps for local setup and config changes to CONTRIBUTING.md (#895) | [Yingrong Zhao](https://github.com/vinozzZ) +- fix: Correct defaults that got messed up in 2.x. (#894) | [Kent Quirk](https://github.com/kentquirk) +- fix: change sample key to not include args in honeycomb logger (#893) | [Yingrong Zhao](https://github.com/vinozzZ) +- fix: [config]: fix structured logging (#884) | [Yingrong Zhao](https://github.com/vinozzZ) +- fix: ClearFrequencySec crash (#880) | [Kent Quirk](https://github.com/kentquirk) +- fix: Fix AvailableMemory parsing on the cmd line (#875) | [Kent Quirk](https://github.com/kentquirk) +- fix: [build] disable cgo for binary-only deploys (#846) | [Liz Fong-Jones](https://github.com/lizthegrey) +- fix: Updating metric registrations in the start function of the EMAThroughputSampler (#845) | [Davin Taddeo](https://github.com/tdarwin) + +## Maintenance +- maint: Respond to docs feedback. (#931) | [Kent Quirk](https://github.com/kentquirk) +- maint: Bump all dependabot deps at once (#927) | [Kent Quirk](https://github.com/kentquirk) +- maint: Add some detail about release tasks (#915) | [Kent Quirk](https://github.com/kentquirk) +- maint: update circleci config to build docker images with go 1.20 (#913) | [Ryan Katkov](https://github.com/solidspark) +- maint: Update msgpack to v5 (#911) | [Kent Quirk](https://github.com/kentquirk) +- maint: update hashicorp/golang-lru (#909) | [Kent Quirk](https://github.com/kentquirk) +- maint: update dependency for x/exp (#908) | [Kent Quirk](https://github.com/kentquirk) +- maint: bump dependencies (#891) | [Tyler Helmuth](https://github.com/TylerHelmuth) +- maint: Bump all dependencies at once (#876) | [Kent Quirk](https://github.com/kentquirk) +- maint: bump dependencies (#856) | [Tyler Helmuth](https://github.com/TylerHelmuth) +- maint: Refinery Readme improvements (#837) | [Mary J](https://github.com/mjingle) + + ## 2.1.0 2023-08-04 This is a minor release with several new features and bug fixes, and is recommended for all Refinery users. See [Release Notes](./RELEASE_NOTES.md) for a summary of changes. diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 24455d3b19..5cce390f76 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -2,6 +2,23 @@ While [CHANGELOG.md](./CHANGELOG.md) contains detailed documentation and links to all of the source code changes in a given release, this document is intended to be aimed at a more comprehensible version of the contents of the release from the point of view of users of Refinery. +## Version 2.2.0 + +This is a minor release with several new features and bug fixes mostly around config values. This release is recommended for all Refinery users. + +### Configuration +- `HTTPIdleTimeout` allows users to configure Refinery's http server's idle timeout. +- New GRPC config values that control the max size of send and receive blocks. +- New config values that provide separate control of the peer and incoming span queue. +- `AddCountsToRoot`, used instead of `AddSpanCountToRoot`, reports 4 separate values on a trace: child spans, span events, span links, and total child elements. +- Redis now supports Auth string for connection. + +### Notable fixes +- The default stdout logger now supports sampling, so that in error loop situations, the number of log messages is constrained. +- Config values that need a memory size input can now use floating point values, which should mean that Refinery's parsing of memory size is compatible with that of Kubernetes, making helm charts easier to write. +- Documentation was improved. + +See [the Changelog](./CHANGELOG.md) for the full list of changes. ## Version 2.1.0 This is a minor release with several new features and bug fixes, and is recommended for all Refinery users.