Skip to content

Commit df4ca4c

Browse files
authored
docs: update to document v2.x limited support (#1729)
## Which problem is this PR solving? - Communicating support level and lifetime for Refinery v2.x. ## Short description of the changes - Update README and RELEASE_NOTES with support level and end-of-support date.
1 parent c8f5895 commit df4ca4c

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
For a detailed list of linked pull requests merged in each release, see [CHANGELOG.md](./CHANGELOG.md).
1111
For more readable information about recent changes, please see [RELEASE_NOTES.md](./RELEASE_NOTES.md).
1212

13+
📝 With the release of v3.0.0, v2.x enters [maintenance](https://docs.honeycomb.io/troubleshoot/product-lifecycle/release-stages/#maintenance) for support until April 1, 2026.
14+
We recommend [migrating to Refinery 3](https://docs.honeycomb.io/troubleshoot/product-lifecycle/recommended-migrations/upgrade-refinery/).
15+
1316
## Purpose
1417

1518
Refinery is a tail-based sampling proxy and operates at the level of an entire [trace](https://docs.honeycomb.io/concepts/tracing/). Refinery examines whole traces and intelligently applies sampling decisions to each trace. These decisions determine whether to keep or drop the trace data in the sampled data forwarded to Honeycomb.

RELEASE_NOTES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ While [CHANGELOG.md](./CHANGELOG.md) contains detailed documentation and links t
77
This is a performance improvement release, focused on memory and CPU efficiency.
88
The improvements introduce some backwards breaking changes which are covered in detail below.
99

10+
📝 With the release of v3.0.0, v2.x enters [maintenance](https://docs.honeycomb.io/troubleshoot/product-lifecycle/release-stages/#maintenance) for support until April 1, 2026.
11+
We recommend [migrating to Refinery 3](https://docs.honeycomb.io/troubleshoot/product-lifecycle/recommended-migrations/upgrade-refinery/).
12+
1013
### Performance Improvements
1114

1215
The improvements are the result of reducing the number of data transformations performed during the receipt and retransmission of traces.

0 commit comments

Comments
 (0)