adding support to filter /api/v1/rules response

[victoramsantos]

Is your feature request related to a problem? Please describe

By the Prometheus doc we have the possibility to filter the rules by alert or record rules (using the type param). On the vm-alert doc it's just saying that this api list of all loaded groups and rules . When I run with the type it returns the same info for both param value.

Describe the solution you'd like

I would like that this API have the same behavior as in Prometheus, if I pass the parameter ?type=alert it would return only the alerts, if I pass ?type=record only the record rules and if it's without type both data.

Describe alternatives you've considered

No response

Additional information

• I know it's possible to iterate over the response and filter each rule however I trying to make a cardinality analyzer that works seamless between Prometheus and VM
• I didn't change the vmalert/api/v1/rules endpoint, since I don't know if it's desired to it be equal to api/v1/rules. Feedbacks here please 😊

Related feature-request: #5743

[Haleygo]

Hey @victoramsantos , thanks for the PR!

I didn't change the vmalert/api/v1/rules endpoint, since I don't know if it's desired to it be equal to api/v1/rules.

Yes, they should behave the same.
And since we're adding this, I think below apis could share the same extra filter parameter:

1. /vmalert/groups
2. /rules
3. /vmalert/api/v1/rules, /api/v1/rules

And I think we can add this filter parameter in

VictoriaMetrics/app/vmalert/web.go

Line 210 in de9a954

func (rh *requestHandler) groups() []apiGroup {

[victoramsantos]

Hi @Haleygo job done!
Please any concern or feedback are very welcome 😊

[victoramsantos]

Yes, I like it :)
I just changed the if ruleType != "" because for cases where the type is wrong I think we should ignore it and return everything. Do you agree? It's the same behavior I found for Prometheus' API.

[Haleygo]

Looks good to me!
Could you help add a feature description to the changelog?

[victoramsantos]

@Haleygo I think I did it right 😅

[Haleygo]

LGTM!
Thanks!

[victoramsantos]

Nice! @Haleygo I need to do something else or just wait for the merge?

[hagen1778]

LGTM!

[hagen1778]

Please also see #5787

[valyala]

FYI, this pull request has been included in vmalert v1.98.0.