Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add Rule Name and Type to Query Tags #15055

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+60 −1
Open

feat: Add Rule Name and Type to Query Tags #15055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aab3185
Add Rule Name and Type to Query Tags
bentonam Nov 21, 2024
2ae5be2
Merge branch 'main' into benton/ruler-tags
bentonam Nov 21, 2024
33d5dcf
Merge branch 'main' into benton/ruler-tags
bentonam Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions pkg/ruler/compat.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,12 @@ func queryFunc(evaluator Evaluator, checker readyChecker, userID string, logger
return nil, errNotReady
}

// Extract rule details
ruleName := detail.Name
ruleType := detail.Kind

// Add rule details to context
ctx = AddRuleDetailsToContext(ctx, ruleName, ruleType)
res, err := evaluator.Eval(ctx, qs, t)

if err != nil {
Expand Down Expand Up @@ -357,3 +363,25 @@ type noopRuleDependencyController struct{}
func (*noopRuleDependencyController) AnalyseRules([]rules.Rule) {
// Do nothing
}

// Define context keys to avoid collisions
type contextKey string

const (
ruleNameKey contextKey = "rule_name"
ruleTypeKey contextKey = "rule_type"
)

// AddRuleDetailsToContext adds rule details to the context
func AddRuleDetailsToContext(ctx context.Context, ruleName string, ruleType string) context.Context {
ctx = context.WithValue(ctx, ruleNameKey, ruleName)
ctx = context.WithValue(ctx, ruleTypeKey, ruleType)
return ctx
}

// GetRuleDetailsFromContext retrieves rule details from the context
func GetRuleDetailsFromContext(ctx context.Context) (string, string) {
ruleName, _ := ctx.Value(ruleNameKey).(string)
ruleType, _ := ctx.Value(ruleTypeKey).(string)
return ruleName, ruleType
}
16 changes: 16 additions & 0 deletions pkg/ruler/compat_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,19 @@ type fakeChecker struct{}
func (f fakeChecker) isReady(_ string) bool {
return true
}

func TestAddAndGetRuleDetailsFromContext(t *testing.T) {
ctx := context.Background()
ruleName := "test_rule"
ruleType := "test_type"

// Add rule details to context
ctx = AddRuleDetailsToContext(ctx, ruleName, ruleType)

// Retrieve rule details from context
retrievedRuleName, retrievedRuleType := GetRuleDetailsFromContext(ctx)

// Assert that the retrieved values match the expected values
assert.Equal(t, ruleName, retrievedRuleName, "Expected rule name to match")
assert.Equal(t, ruleType, retrievedRuleType, "Expected rule type to match")
}
7 changes: 6 additions & 1 deletion pkg/ruler/evaluator_remote.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,11 @@ func (r *RemoteEvaluator) query(ctx context.Context, orgID, query string, ts tim
body := []byte(args.Encode())
hash := util.HashedQuery(query)

// Retrieve rule details from context
ruleName, ruleType := GetRuleDetailsFromContext(ctx)

// Construct the X-Query-Tags header value
queryTags := fmt.Sprintf("source=ruler,rule_name=%s,rule_type=%s", ruleName, ruleType)
req := httpgrpc.HTTPRequest{
Method: http.MethodPost,
Url: queryEndpointPath,
Expand All @@ -228,7 +233,7 @@ func (r *RemoteEvaluator) query(ctx context.Context, orgID, query string, ts tim
{Key: textproto.CanonicalMIMEHeaderKey("User-Agent"), Values: []string{userAgent}},
{Key: textproto.CanonicalMIMEHeaderKey("Content-Type"), Values: []string{mimeTypeFormPost}},
{Key: textproto.CanonicalMIMEHeaderKey("Content-Length"), Values: []string{strconv.Itoa(len(body))}},
{Key: textproto.CanonicalMIMEHeaderKey(string(httpreq.QueryTagsHTTPHeader)), Values: []string{"source=ruler"}},
{Key: textproto.CanonicalMIMEHeaderKey(string(httpreq.QueryTagsHTTPHeader)), Values: []string{queryTags}},
{Key: textproto.CanonicalMIMEHeaderKey(user.OrgIDHeaderName), Values: []string{orgID}},
},
}
Expand Down
10 changes: 10 additions & 0 deletions pkg/ruler/evaluator_remote_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ func TestRemoteEvalQueryTimeout(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

_, err = ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", time.Now())
require.Error(t, err)
Expand Down Expand Up @@ -98,6 +99,7 @@ func TestRemoteEvalMaxResponseSize(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

_, err = ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", time.Now())
require.Error(t, err)
Expand Down Expand Up @@ -146,6 +148,7 @@ func TestRemoteEvalScalar(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

res, err := ev.Eval(ctx, "19", now)
require.NoError(t, err)
Expand Down Expand Up @@ -189,6 +192,7 @@ func TestRemoteEvalEmptyScalarResponse(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

res, err := ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", time.Now())
require.NoError(t, err)
Expand Down Expand Up @@ -247,6 +251,7 @@ func TestRemoteEvalVectorResponse(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

res, err := ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", now)
require.NoError(t, err)
Expand Down Expand Up @@ -294,6 +299,7 @@ func TestRemoteEvalEmptyVectorResponse(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

_, err = ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", time.Now())
require.NoError(t, err)
Expand All @@ -317,6 +323,7 @@ func TestRemoteEvalErrorResponse(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

_, err = ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", time.Now())
require.ErrorContains(t, err, "rule evaluation failed")
Expand All @@ -343,6 +350,7 @@ func TestRemoteEvalNon2xxResponse(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

_, err = ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", time.Now())
require.ErrorContains(t, err, fmt.Sprintf("unsuccessful/unexpected response - status code %d", httpErr))
Expand All @@ -367,6 +375,7 @@ func TestRemoteEvalNonJSONResponse(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

_, err = ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", time.Now())
require.ErrorContains(t, err, "unexpected body encoding, not valid JSON")
Expand Down Expand Up @@ -406,6 +415,7 @@ func TestRemoteEvalUnsupportedResultResponse(t *testing.T) {

ctx := context.Background()
ctx = user.InjectOrgID(ctx, "test")
ctx = AddRuleDetailsToContext(ctx, "test_rule_name", "test_rule_type")

_, err = ev.Eval(ctx, "sum(rate({foo=\"bar\"}[5m]))", time.Now())
require.ErrorContains(t, err, fmt.Sprintf("unsupported result type: %q", loghttp.ResultTypeStream))
Expand Down
Loading