Deprecation done properly
On This Lesson 4 topics
This lesson is planned. The outline below lists the topics it will cover. The full lesson has not been published yet.
In this lesson
retire an API or field in four steps.
Planned topics
- Announce: changelog, docs,
DeprecationandSunsetheaders (verify the current RFC status before recording), direct message to known consumers. - Measure: log or metric of who still calls the old field or endpoint, by client id.
- Migrate: help the remaining consumers; give a date and keep to it.
- Remove: only when usage is zero or the deadline passed with owners informed.
- Removal in the same release as the announcement is not deprecation.
Draft outline details
Demonstration
a Grafana panel "calls per client to total field" dropping to zero over six weeks.
Check your understanding
What must you know before removing an old field?
Show answer
Who still uses it, from usage measurement.
Practice
Apply this lesson with the module's lab, exercises and quiz.
Marking a lesson complete is optional and you can undo it any time. Your progress stays in this browser.