-
Notifications
You must be signed in to change notification settings - Fork 487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add migration guide for push_config deprecation #534
Conversation
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not very convinced about this paragraph. Maybe it should be dropped or placed elsewhere.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd just change the wording here, something like:
push_config
is now deprecated in favor of aremote_write
array which allows for sending spans to multiple endpoints.push_config
will be removed in a future release, and it is recommended to migrate toremote_write
as soon as possible.
WDYT? Feel free to play around with the wording.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like that much better. Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for adding this. Feel free to merge whenever :)
* Add migration guide for push_config deprecation * Rewording
PR Description
Add migration guide in v0.14.0 for
push_config
deprecation. Initially nothing was added becausepush_config
is still supported, but seeing onlyremote_write
in 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