Adding the alert group info API by qinxx108 · Pull Request #3364 · prometheus/alertmanager

qinxx108 · 2023-05-16T17:23:21Z

Implement the proposal here #3361

emanlodovice

lgtm

yeya24 · 2023-06-05T18:49:26Z

api/v2/api.go

+	rf := func(receiverFilter *regexp.Regexp) func(r *dispatch.Route) bool {
+		return func(r *dispatch.Route) bool {
+			receiver := r.RouteOpts.Receiver
+			if receiverFilter != nil && !receiverFilter.MatchString(receiver) {


Question, do we need to use regex here? That means the input params.Receiver contains multiple receivers?

This is more about support regex search for receivers, i am following convention of receiver filter parameter in the other apis
See https://github.com/prometheus/alertmanager/blob/main/api/v2/api.go#L250-L260

yeya24 · 2023-06-05T18:52:10Z

api/v2/api.go

+
+func validateNextToken(nextToken *string) error {
+	if nextToken != nil && *nextToken != "" {
+		match, _ := regexp.MatchString("^[a-fA-F0-9]{40}$", *nextToken)


Let's compile the regex once and match here?

removed the nextToken != ""

yeya24 · 2023-06-05T18:56:07Z

api/v2/api.go

+	for _, alertGroup := range ags {
+
+		// Skip the aggregation group if the next token is set and hasn't arrived the nextToken item yet.
+		if params.NextToken != nil && *params.NextToken != "" && *params.NextToken >= alertGroup.ID {


Can you simplify to if len(params.NextToken) > 0 && *params.NextToken >= alertGroup.ID

removed *params.NextToken != "" check as it won't be empty string from validateNextToken. I won't remove the params.NextToken != nil as won't len(params.NextToken) result in NPE when params.NextToken is nil?

Nvm. I thought params.NextToken is a string type from the hints when doing code review on GH. If it is *string I am good.

yeya24 · 2023-06-05T18:58:54Z

api/v2/api.go

+	return nil
+}
+
+func validateNextToken(nextToken *string) error {


I think we can use string here as param?

I want to escape the validation when nextToken is nil, kind of want to keep that if into this function rather in main function

yeya24 · 2023-06-05T19:08:04Z

dispatch/dispatch.go

 }

+func (ag *aggrGroup) GroupID() string {
+	h := sha1.New()


Any reason to use sha1? Will xxhash or other libraries works

only reason of using sha1 is wanting to keep the output of the hash to be short as this is going to be nexttoken for user to use

yeya24 · 2023-06-05T19:11:50Z

dispatch/route.go

+func (r *Route) ID() string {
+	b := strings.Builder{}
+
+	var position *int


I prefer to not use pointer... We can use int and initialize it to an invalid value like -1 then we will have less pointer reference operations

gotjosh · 2023-06-08T21:05:19Z

The overall direction looks good, great job @qinxx108 ! I have comments but let's finish with #3372 first before we continue here.

* Add tests to TestMatchers This commit adds a number of tests to TestMatchers that asserts some of the more nuanced behavior when parsing label matchers. Signed-off-by: George Robinson <george.robinson@grafana.com> --------- Signed-off-by: George Robinson <george.robinson@grafana.com> Signed-off-by: Yijie Qin <qinyijie@amazon.com>

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

siavashs · 2025-10-31T16:26:17Z

api/v2/openapi.yaml

          $ref: '#/responses/BadRequest'
        '500':
          $ref: '#/responses/InternalServerError'
+  /alertgroups:


Why not make this a flag or a subpath on the existing API?
This naming can be confusing with the existing /alerts/groups.

siavashs · 2025-10-31T16:27:46Z

@qinxx108 can you please update the PR?
Then we can do a proper review.

qinxx108 changed the title ~~Adding the alert group info API spec~~ Adding the alert group info API May 16, 2023

qinxx108 force-pushed the alert-group-api branch 6 times, most recently from 31caabd to cf65ed4 Compare May 23, 2023 15:48

qinxx108 force-pushed the alert-group-api branch 2 times, most recently from e8d049c to ff168b1 Compare June 2, 2023 00:39

emanlodovice approved these changes Jun 3, 2023

View reviewed changes

yeya24 reviewed Jun 5, 2023

View reviewed changes

qinxx108 force-pushed the alert-group-api branch from ff168b1 to c87d345 Compare June 7, 2023 05:05

qinxx108 force-pushed the alert-group-api branch 2 times, most recently from 80fad23 to e16034e Compare July 6, 2023 21:20

grobinson-grafana and others added 13 commits July 7, 2023 02:50

Adding the alert group info API spec

bd3c88b

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

Add API implementation

0476e0e

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

fix lint

a3da05c

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

add parameter validation

8a60bc3

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

fix lint

242e3e4

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

use the make apiv2

e382ded

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

change the ID for groups

054a525

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

change infos to infolist

9f06e14

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

fix comments

3578acb

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

add the signature

4370e49

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

return ID in the api group info

fe45b95

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

change to use utility function

6d88d43

Signed-off-by: Yijie Qin <qinyijie@amazon.com>

qinxx108 force-pushed the alert-group-api branch from e16034e to 6d88d43 Compare July 7, 2023 06:51

fix 0 maxItem case

f4fd6ad

siavashs reviewed Oct 31, 2025

View reviewed changes

Conversation

qinxx108 commented May 16, 2023

Uh oh!

emanlodovice left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gotjosh commented Jun 8, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

siavashs commented Oct 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants