Ruler: Add support for arbitrary extra URL parameters to Alertmanager client's OAuth config #10030
Conversation
| // LimitsMap is a generic map that can hold either float64 or int as values. | ||
| type LimitsMap[T float64 | int] struct { | ||
| // LimitsMap is a flag.Value implementation that looks like a generic map, holding float64s, ints, or strings as values. | ||
| type LimitsMap[T float64 | int | string] struct { |
There was a problem hiding this comment.
So far, the only place where we really use map flags is in Limits, that's why this was called LimitsMap. But, nothing in this file is really specific to limits.
This new use case isn't really a limit, but I felt it gives a better configuration experience to be consistent with existing flags here, rather than invent a second map format that behaves differently.
I've kept the name LimitsMap and package as i feel it's close enough to being descriptive and would muddy the diff to include renames/moves. I also think there's a valid case for moving this to dskit's flagext package in the future anyway, so it didn't make sense to do a big rename yet.
I'm happy to change the name, or explore moving this to dskit, if reviewers would prefer. Or, this can be left to a subsequent PR.
| @@ -73,6 +81,7 @@ func (m LimitsMap[T]) updateMap(newMap map[string]T) error { | |||
| } | |||
| } | |||
|
|
|||
| clear(m.data) | |||
There was a problem hiding this comment.
drive-by bugfix i happened to notice. added corresponding test.
What this PR does
This PR allows you to specify arbitrary URL parameters to send alongside OAuth token requests, when the Alertmanager client is configured in OAuth mode.
Some OAuth providers require extra fields here that are not normally part of the spec - for example,
audienceis a common one. The Go stdlib followed a similar convention for such fields: golang/oauth2#216 where arbitrary extra URL values are allowed.Which issue(s) this PR fixes or relates to
n/a
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.