Skip to content

Commit

Permalink
rel: prep for release of 1.21 (#668)
Browse files Browse the repository at this point in the history
Documenting release 1.21.

---------

Co-authored-by: Kent Quirk <kentquirk@honeycomb.io>
  • Loading branch information
fchikwekwe and kentquirk authored Apr 14, 2023
1 parent 281ae43 commit 36aa2ca
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 5 deletions.
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
# Refinery Changelog

## 1.21.0 2023-04-14

### Summary
Adds many fixes for existing features such as meta fields for use with stress relief mode. Adds ability to annotate sample rates that
were already set upstream before refinery sampling for debugging purposes.

### Enhancements
- feat: annotate incoming sample rate (#658) | [Faith Chikwekwe](https://github.com/fchikwekwe)

### Bug Fixes
- fix: Replace incorrectly used Systemd Alias directive with a WantedBy (#657) | [Irving Popovetsky](https://github.com/IrvingPopovetsky)
- fix: add hostname to span during stress relief mode (#666) | [Faith Chikwekwe](https://github.com/fchikwekwe)
- fix: only decorate late spans when configured to do so (#665) | [Faith Chikwekwe](https://github.com/fchikwekwe)
- fix: validate cache overrun strategy for stress relief mode (#664) | [Faith Chikwekwe](https://github.com/fchikwekwe)
- docs: update doc to remove deprecated field name (#659) | [Faith Chikwekwe](https://github.com/fchikwekwe)
- fix: Remove Stop() function from stress relief (#645) | [Kent Quirk](https://github.com/kentquirk)
- chore: Spelling (#644) | [Josh Soref](https://github.com/JoshSoref)
- fix: tweak timeouts (#647) | [Faith Chikwekwe](https://github.com/fchikwekwe)
- fix: correct syntax error in config_complete.toml (#639) | [Hazel Weakly](https://github.com/HazelWeakly)

### Maintenance
- chore: Update MetricsReportingInterval in config_complete.toml (#653) | [Davin](https://github.com/Davin)
- maint: switch dependabot to collection (#660) | [Vera Reynolds](https://github.com/Vera Reynolds)
- maint(deps): bump google.golang.org/protobuf from 1.28.1 to 1.30.0 (#663) | [dependabot[bot]](https://github.com/dependabot[bot])
- maint(deps): bump github.com/honeycombio/husky from 0.21.0 to 0.22.2 (#662) | [dependabot[bot]](https://github.com/dependabot[bot])
- maint(deps): bump github.com/klauspost/compress from 1.16.3 to 1.16.4 (#661) | [dependabot[bot]](https://github.com/dependabot[bot])
- maint(deps): bump go.uber.org/automaxprocs from 1.5.1 to 1.5.2 (#650) | [dependabot[bot]](https://github.com/dependabot[bot])
- maint(deps): bump github.com/honeycombio/dynsampler-go from 0.3.0 to 0.4.0 (#649) | [dependabot[bot]](https://github.com/dependabot[bot])
- maint(deps): bump google.golang.org/grpc from 1.52.3 to 1.54.0 (#652) | [dependabot[bot]](https://github.com/dependabot[bot])
- maint(deps): bump github.com/honeycombio/husky from 0.21.0 to 0.22.2 (#651) | [dependabot[bot]](https://github.com/dependabot[bot])
- maint(deps): bump github.com/klauspost/compress from 1.16.0 to 1.16.3 (#648) | [dependabot[bot]](https://github.com/dependabot[bot])
- maint: Add labels to docker image (#640) | [Tyler Helmuth](https://github.com/TylerHelmuth)
- maint: Add LICENSES dir (#638) | [Tyler Helmuth](https://github.com/TylerHelmuth)

## 1.20.0 2023-03-10

### Summary
Expand Down
18 changes: 18 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

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 1.21.0

This is a small release with mostly bug fixes and minor changes related to Stress Relief Mode.

### Fixes for Stress Relief

This update includes many small changes geared at making Stress Relief Mode work better.
- Hostname is now annotated when Stress Relief is active.
- Stress Relief Mode can now only be activated when CacheOverrunStrategy is set to "impact" since it is not compatible with "legacy".
- The `Stop()` function was removed from Stress Relief Mode; it wasn't needed and was causing confusing errors.

### General Bug Fixes

There were other small changes to other parts of refinery.
- Systemd `Alias=` directive was replaced with `WantedBy=` directive which is more in line with best practices.
- Late spans are now only decorated when `AddRuleReasonToTrace` is set.
- Some potential fixes for flaky tests were added.

## Version 1.20.0

This is a significant new release of Refinery, with several features designed to help when operating Refinery at scale:
Expand Down
11 changes: 6 additions & 5 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Release Process

1. Add release entry to [changelog](./CHANGELOG.md)
2. Open a PR with the above, and merge that into main
3. Create new tag on merged commit with the new version (e.g. `v1.4.1`)
4. Push the tag upstream (this will kick off the release pipeline in CI)
5. Copy change log entry for newest version into draft GitHub release created as part of CI publish steps
6. Update the `appVersion` and any relevant chart changes in [helm-charts](https://github.com/honeycombio/helm-charts/tree/main/charts/refinery)
2. Add a summary of release changes to [release notes](./RELEASE_NOTES.md)
3. Open a PR with the above, and merge that into main
4. Create new tag on merged commit with the new version (e.g. `v1.4.1`)
5. Push the tag upstream (this will kick off the release pipeline in CI)
6. Copy change log entry for newest version into draft GitHub release created as part of CI publish steps
7. Update the `appVersion` and any relevant chart changes in [helm-charts](https://github.com/honeycombio/helm-charts/tree/main/charts/refinery)

0 comments on commit 36aa2ca

Please sign in to comment.