Add migration guide for push_config deprecation #534
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mapno
commented
Apr 12, 2021
docs/migration-guide.md
Outdated
| @@ -31,6 +31,55 @@ sigv4: | |||
| region: us-east-1 | |||
| ``` | |||
|
|
|||
| ## Tempo: `push_config` deprecation | |||
|
|
|||
| NOTE: `push_config` is still being supported as it was before v0.14.0. | |||
There was a problem hiding this comment.
I'm not very convinced about this paragraph. Maybe it should be dropped or placed elsewhere.
There was a problem hiding this comment.
I'd just change the wording here, something like:
push_configis now deprecated in favor of aremote_writearray which allows for sending spans to multiple endpoints.push_configwill be removed in a future release, and it is recommended to migrate toremote_writeas soon as possible.
WDYT? Feel free to play around with the wording.
There was a problem hiding this comment.
I like that much better. Thanks.
rfratto
approved these changes
Apr 12, 2021
mattdurham
pushed a commit
that referenced
this pull request
Nov 11, 2021
* Add migration guide for push_config deprecation * Rewording
github-actions
bot
added
the
frozen-due-to-age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Description
Add migration guide in v0.14.0 for
push_configdeprecation. Initially nothing was added becausepush_configis still supported, but seeing onlyremote_writein the reference and examples with no migration guide can be very confusing.Which issue(s) this PR fixes
None
Notes to the Reviewer
None
PR Checklist