Refactor Rules Protos #2226
Merged
Refactor Rules Protos #2226
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pstibrany
reviewed
Mar 10, 2020
pkg/ruler/rules/rules.proto
Outdated
| import "github.com/cortexproject/cortex/pkg/ingester/client/cortex.proto"; | ||
|
|
||
| option (gogoproto.marshaler_all) = true; | ||
| option (gogoproto.unmarshaler_all) = true; | ||
|
|
||
| // RuleGroupDesc is a proto representation of a cortex rule group | ||
| message RuleGroupDesc { | ||
| reserved 5; |
pstibrany
reviewed
Mar 10, 2020
pkg/ruler/rules/rules.proto
Outdated
| } | ||
|
|
||
| // RuleDesc is a proto representation of a Prometheus Rule | ||
| message RuleDesc { | ||
| reserved 7 to 10; |
pstibrany
reviewed
Mar 10, 2020
pkg/ruler/ruler.go
Outdated
| } | ||
| groupDescs = append(groupDescs, groupDesc) | ||
| } | ||
| return groupDescs, nil | ||
| } | ||
|
|
||
| func (r *Ruler) getShardedRules(ctx context.Context, userID string) ([]*rules.RuleGroupDesc, error) { | ||
| func (r *Ruler) getShardedRules(ctx context.Context, userID string) ([]*GroupStateDesc, error) { |
There was a problem hiding this comment.
userID parameter is unused here
There was a problem hiding this comment.
Makes sense, it should be safe to remove. An early version of this function used it but it was removed at some point. The history of that was squashed when the PR for this was merged. I've removed the parameter and added some code to ensure the context has a user set.
pstibrany
approved these changes
Mar 10, 2020
Signed-off-by: Jacob Lisi <[email protected]>
Signed-off-by: Jacob Lisi <[email protected]>
Signed-off-by: Jacob Lisi <[email protected]>
Signed-off-by: Jacob Lisi <[email protected]>
jtlisi
force-pushed
the
20200306_separate_rulestate_proto
branch
from
fffb87d to
6177192
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does:
The
ruler/rules/rules.protofile defines a proto for storing Prometheus rule groups. In order to make this proto message more amenable to the storage of rules, information that communicates the state of a running rule was removed and placed into a separateGroupStateDescmessage in theruler/ruler.protofile.This PR executes the above change and updates all the consumers that utilize this change.
When rolling out this change, the experimental ruler API will be unable to serve the status of running rules until the rollout is complete. This will only affect the
/api/v1/rulesand/api/v1/alertsendpoint. It will not affect the evaluation of running rule groups.Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]Signed-off-by: Jacob Lisi [email protected]