Deprecate and remove api/v1/ by gotjosh · Pull Request #2970 · prometheus/alertmanager

gotjosh · 2022-06-29T12:12:50Z

This is intentionally incomplete and is open mostly as a guideline to see what breaks.

The description will be updated once the work is finished and serves as a checklist to give visibility of a plan for reviewers.

fixes #2469

The steps to take are:

Allow /api/v1/alerts to behave like /api/v2/alerts.
Update comments and resolve TODOs if applicable - I don't have any context on them yet but I'll find out.
Revise any configuration options to see if there are any applicable only to api/v1

Edit:

Instead of making api/v1/* redirect to the /api/v2 I opted for adding a deprecation notice in JSON to all of the v1 routes. On top of that, each time a v1 route is called it'll log a warning letting the operator know that something is not going right.
I checked, TODOs and the removed code to see if there was anything I was missing but I couldn't find anything.

Signed-off-by: gotjosh <josue.abreu@gmail.com>

gotjosh · 2023-11-21T18:38:02Z

api/v1/api.go

-		uptime:         time.Now(),
-		peer:           peer,
-		logger:         l,
-		m:              metrics.NewAlerts("v1", r),


Technically, we can remove this distinction now but it would be a rather critical breaking change - I would rather not risk it.

nvm, I made it permament.

Signed-off-by: gotjosh <josue.abreu@gmail.com>

gotjosh · 2023-11-21T18:56:16Z

@simonpasquier I think this ready for review - this is currently blocking the progress on #3567 as making API v1 compatible with that work is a large endeavour for something we don't need.

Would appreciate a speedy review - I think the changes to the deprecation router are good enough to let users know that something that we deprecated back in 0.18 is now gone.

grobinson-grafana

Tested and LGTM! ❤️

grobinson-grafana · 2023-11-21T19:23:27Z

api/v1_deprecation_router.go

+		Error  string `json:"error"`
+	}{
+		"deprecated",
+		"The Alertmanager v1 API was deprecated in version 0.16.0 and entirely removed since version 0.28.0 - please use the equivalent route in the v2 API",


Small nit, feel free to ignore 😄

Suggested change

"The Alertmanager v1 API was deprecated in version 0.16.0 and entirely removed since version 0.28.0 - please use the equivalent route in the v2 API",

"The Alertmanager v1 API was deprecated in version 0.16.0 and is removed as of version 0.28.0 - please use the equivalent route in the v2 API",

grobinson-grafana · 2023-11-21T19:25:17Z

api/v1_deprecation_router.go

+	}
+
+	w.Header().Set("Content-Type", "application/json")
+	w.WriteHeader(410)


Nice! ❤️

grobinson-grafana · 2023-11-21T19:26:56Z

api/v1_deprecation_router.go

+	w.WriteHeader(410)
+
+	// We don't care about errors for this route.
+	b, _ := json.Marshal(resp)


You don't need to change this, but you can also use:

if err := json.NewEncoder(w).Encode(resp); err != nil { level.Error(dr.logger).Log("msg", "failed to write response", "err", err) }

beorn7 · 2023-11-23T17:35:24Z

Looks great in general, but you are so deep into the weeds here that I don't feel qualified to evaluate the details. :)

Signed-off-by: gotjosh <josue.abreu@gmail.com>

gotjosh · 2023-11-24T09:07:26Z

Thanks @beorn7 - With the amount of context you have, you'll always be overqualified to review anything we throw at you.

alanprot · 2024-04-02T18:02:13Z

Should we follow up with a change on prometheus to now allow configuring v1 endpoints anymore?

https://github.com/prometheus/prometheus/blob/9b7de4778732ca2f2ab5028e9d1955109f440c4c/config/config.go#L910-L921

grobinson-grafana · 2024-04-02T18:16:01Z

Should we follow up with a change on prometheus to now allow configuring v1 endpoints anymore?

https://github.com/prometheus/prometheus/blob/9b7de4778732ca2f2ab5028e9d1955109f440c4c/config/config.go#L910-L921

Yes please Alan! Would you be happy to open a PR for that?

alanprot · 2024-04-02T23:06:55Z

Np: prometheus/prometheus#13883

* [CHANGE] Deprecate and remove api/v1/ #2970 * [CHANGE] Remove unused feature flags #3676 * [CHANGE] Newlines in smtp password file are now ignored #3681 * [CHANGE] Change compat metrics to counters #3686 * [CHANGE] Do not register compat metrics in amtool #3713 * [CHANGE] Remove metrics from compat package #3714 * [CHANGE] Mark muted alerts #3793 * [FEATURE] Add metric for inhibit rules #3681 * [FEATURE] Support UTF-8 label matchers #3453, #3507, #3523, #3483, #3567, #3568, #3569, #3571, #3595, #3604, #3619, #3658, #3659, #3662, #3668, 3572 * [FEATURE] Add counter to track alerts dropped outside of time_intervals #3565 * [FEATURE] Add date and tz functions to templates #3812 * [FEATURE] Add limits for silences #3852 * [FEATURE] Add time helpers for templates #3863 * [FEATURE] Add auto GOMAXPROCS #3837 * [FEATURE] Add auto GOMEMLIMIT #3895 * [FEATURE] Add Jira receiver integration #3590 * [ENHANCEMENT] Add the receiver name to notification metrics #3045 * [ENHANCEMENT] Add the route ID to uuid #3372 * [ENHANCEMENT] Add duration to the notify success message #3559 * [ENHANCEMENT] Implement webhook_url_file for discord and msteams #3555 * [ENHANCEMENT] Add debug logs for muted alerts #3558 * [ENHANCEMENT] API: Allow the Silences API to use their own 400 response #3610 * [ENHANCEMENT] Add summary to msteams notification #3616 * [ENHANCEMENT] Add context reasons to notifications failed counter #3631 * [ENHANCEMENT] Add optional native histogram support to latency metrics #3737 * [ENHANCEMENT] Enable setting ThreadId for Telegram notifications #3638 * [ENHANCEMENT] Allow webex roomID from template #3801 * [BUGFIX] Add missing integrations to notify metrics #3480 * [BUGFIX] Add missing ttl in pushhover #3474 * [BUGFIX] Fix scheme required for webhook url in amtool #3409 * [BUGFIX] Remove duplicate integration from metrics #3516 * [BUGFIX] Reflect Discord's max length message limits #3597 * [BUGFIX] Fix nil error in warn logs about incompatible matchers #3683 * [BUGFIX] Fix a small number of inconsistencies in compat package logging #3718 * [BUGFIX] Fix log line in featurecontrol #3719 * [BUGFIX] Fix panic in acceptance tests #3592 * [BUGFIX] Fix flaky test TestClusterJoinAndReconnect/TestTLSConnection #3722 * [BUGFIX] Fix crash on errors when url_file is used #3800 * [BUGFIX] Fix race condition in dispatch.go #3826 * [BUGFIX] Fix race conditions in the memory alerts store #3648 * [BUGFIX] Hide config.SecretURL when the URL is incorrect. #3887 * [BUGFIX] Fix invalid silence causes incomplete updates #3898 * [BUGFIX] Fix leaking of Silences matcherCache entries #3930 * [BUGFIX] Close SMTP submission correctly to handle errors #4006 Signed-off-by: SuperQ <superq@gmail.com>

* Deprecate and remove api/v1/ Signed-off-by: gotjosh <josue.abreu@gmail.com> --------- Signed-off-by: gotjosh <josue.abreu@gmail.com>

gotjosh force-pushed the remove-api-v1 branch 2 times, most recently from e0d9502 to cac28d3 Compare June 29, 2022 12:29

Deprecate and remove api/v1/

a0d920f

Signed-off-by: gotjosh <josue.abreu@gmail.com>

gotjosh force-pushed the remove-api-v1 branch from cac28d3 to a0d920f Compare November 21, 2023 17:47

gotjosh commented Nov 21, 2023

View reviewed changes

more changes to the API v1 removal

119e1c4

Signed-off-by: gotjosh <josue.abreu@gmail.com>

gotjosh requested a review from simonpasquier November 21, 2023 18:54

gotjosh marked this pull request as ready for review November 21, 2023 19:04

gotjosh requested a review from beorn7 November 21, 2023 19:04

grobinson-grafana approved these changes Nov 21, 2023

View reviewed changes

address review feedback

0cf6797

Signed-off-by: gotjosh <josue.abreu@gmail.com>

gotjosh force-pushed the remove-api-v1 branch from 93c6ea4 to 0cf6797 Compare November 23, 2023 19:36

gotjosh merged commit b4f7027 into main Nov 24, 2023

gotjosh deleted the remove-api-v1 branch November 24, 2023 09:06

jakekeeys mentioned this pull request Feb 7, 2024

rule: default to alertmanager v2 api thanos-io/thanos#7123

Merged

federicopires mentioned this pull request Mar 13, 2024

Thanos ruler: Alertmanager v0.27.0 /api/v1 endpoints deprecated thanos-io/thanos#7208

Closed

TomHellier mentioned this pull request Mar 22, 2024

[kube-prometheus-stack] thanos-ruler can no longer communicate with Alertmanager prometheus-community/helm-charts#4381

Closed

alanprot mentioned this pull request Apr 2, 2024

Chore: Update Prometheus cortexproject/cortex#5841

Merged

alanprot mentioned this pull request Apr 2, 2024

Disallowing configure AM with the v1 api prometheus/prometheus#13883

Merged

jsedy7 mentioned this pull request Apr 22, 2024

feat: change alertmanagerAPIPath to v2 grafana/mimir#7928

Closed

4 tasks

SuperQ mentioned this pull request Oct 16, 2024

Release v0.28.0-rc.0 #4072

Merged

juzhao mentioned this pull request Dec 24, 2024

MON-4118: chore: use alertmanager v2 in tests as v1 is not longer supported in Prometheus 3 openshift/cluster-monitoring-operator#2544

Merged

2 tasks

tjhop pushed a commit to tjhop/alertmanager that referenced this pull request Nov 13, 2025

Deprecate and remove api/v1/ (prometheus#2970)

d6a88f2

* Deprecate and remove api/v1/ Signed-off-by: gotjosh <josue.abreu@gmail.com> --------- Signed-off-by: gotjosh <josue.abreu@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate and remove api/v1/#2970

Deprecate and remove api/v1/#2970
gotjosh merged 3 commits intomainfrom
remove-api-v1

gotjosh commented Jun 29, 2022 •

edited

Loading

Uh oh!

gotjosh Nov 21, 2023

Uh oh!

gotjosh Nov 21, 2023

Uh oh!

gotjosh commented Nov 21, 2023

Uh oh!

grobinson-grafana left a comment

Uh oh!

grobinson-grafana Nov 21, 2023

Uh oh!

grobinson-grafana Nov 21, 2023

Uh oh!

grobinson-grafana Nov 21, 2023

Uh oh!

beorn7 commented Nov 23, 2023

Uh oh!

gotjosh commented Nov 24, 2023

Uh oh!

alanprot commented Apr 2, 2024

Uh oh!

grobinson-grafana commented Apr 2, 2024

Uh oh!

alanprot commented Apr 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	"The Alertmanager v1 API was deprecated in version 0.16.0 and entirely removed since version 0.28.0 - please use the equivalent route in the v2 API",
	"The Alertmanager v1 API was deprecated in version 0.16.0 and is removed as of version 0.28.0 - please use the equivalent route in the v2 API",

Conversation

gotjosh commented Jun 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gotjosh Nov 21, 2023

Choose a reason for hiding this comment

Uh oh!

gotjosh Nov 21, 2023

Choose a reason for hiding this comment

Uh oh!

gotjosh commented Nov 21, 2023

Uh oh!

grobinson-grafana left a comment

Choose a reason for hiding this comment

Uh oh!

grobinson-grafana Nov 21, 2023

Choose a reason for hiding this comment

Uh oh!

grobinson-grafana Nov 21, 2023

Choose a reason for hiding this comment

Uh oh!

grobinson-grafana Nov 21, 2023

Choose a reason for hiding this comment

Uh oh!

beorn7 commented Nov 23, 2023

Uh oh!

gotjosh commented Nov 24, 2023

Uh oh!

alanprot commented Apr 2, 2024

Uh oh!

grobinson-grafana commented Apr 2, 2024

Uh oh!

alanprot commented Apr 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gotjosh commented Jun 29, 2022 •

edited

Loading