Skip to content
This repository has been archived by the owner on Mar 5, 2024. It is now read-only.

Adding upgrade notes for v3 to v4 #444

Merged
merged 2 commits into from
Dec 7, 2020
Merged

Adding upgrade notes for v3 to v4 #444

merged 2 commits into from
Dec 7, 2020

Conversation

stefansedich
Copy link
Contributor

@stefansedich stefansedich commented Dec 1, 2020 •
edited
Loading

This PR adds the upgrade notes for v3 to v4 release which contains breaking changes which need to be documented.

Closes #436

@stefansedich stefansedich force-pushed the v4-upgrade-docs branch 3 times, most recently from d32edb8 to efc8e17 Compare December 1, 2020 21:19
stefansedich
stefansedich commented Dec 1, 2020
View reviewed changes
docs/UPGRADING.md
We would suggest upgrading in the following way:

1. TODO
2. If you still require StatsD metrics you may need to look at something like [veneur-prometheus](https://github.com/stripe/veneur/tree/master/cmd/veneur-prometheus) to scrape the /metrics endpoint and push them to StatsD.
Copy link
Contributor Author

@stefansedich stefansedich Dec 1, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pingles I am not sure what to say here, this the only possible prom->statsd route that I have heard of, any other ideas? We can always ignore it but I would like to at least give the StatsD users some hope.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not aware of any others. @Joseph-Irving aware of anything worth calling out?

If not, I'm hopeful that it affects a tiny number of users. Thanks for putting in something.

@stefansedich stefansedich force-pushed the v4-upgrade-docs branch 5 times, most recently from 6d8e96b to a218788 Compare December 1, 2020 21:58
@stefansedich
Copy link
Contributor Author

@pingles made a rough first cut at the upgrade docs. Let me know what you think and where I should look at adding more info.

@pingles
Copy link
Contributor

pingles commented Dec 2, 2020

Thanks.

There's a few other PRs that will have changed flags (#437 #440 #329 #427). I don't know whether it's worth calling out specific renames/drops in a table to help guide people?

@stefansedich
Copy link
Contributor Author

stefansedich commented Dec 2, 2020 •
edited
Loading

Thanks.

There's a few other PRs that will have changed flags (#437 #440 #329 #427). I don't know whether it's worth calling out specific renames/drops in a table to help guide people?

I made an attempt to move to tables splitting between the breaking agent flags and the new server flags, let me know how that looks. I pushed it out of draft as it should be ready for a real review.

@stefansedich stefansedich marked this pull request as ready for review December 2, 2020 16:56
@pingles pingles merged commit 87a83d3 into uswitch:master Dec 7, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@pingles pingles pingles approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create docs for upgrading to v4
2 participants
@stefansedich @pingles