Skip to content

SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.

2.9 KB
Raw Blame
package ruler

import (
	"context"

	"github.com/SigNoz/signoz/pkg/factory"
	"github.com/SigNoz/signoz/pkg/statsreporter"
	"github.com/SigNoz/signoz/pkg/types/alertmanagertypes"
	"github.com/SigNoz/signoz/pkg/types/ruletypes"
	"github.com/SigNoz/signoz/pkg/valuer"
)

type Ruler interface {
	factory.ServiceWithHealthy
	statsreporter.StatsCollector

	// ListRuleStates returns all rules with their current evaluation state.
	ListRuleStates(ctx context.Context) (*ruletypes.GettableRules, error)

	// ListRules returns a filtered, sorted page of rules with state, plus label pairs and reserved filter keys.
	ListRules(ctx context.Context, params *ruletypes.ListRulesParams) (*ruletypes.ListableRules, error)

	// GetRule returns a single rule by ID.
	GetRule(ctx context.Context, id valuer.UUID) (*ruletypes.GettableRule, error)

	// CreateRule persists a new rule from a JSON string and starts its evaluator.
	// TODO: accept PostableRule instead of raw string; the manager currently unmarshals
	// internally because it stores the raw JSON as Data. Requires changing the storage
	// model to store structured data.
	CreateRule(ctx context.Context, ruleStr string) (*ruletypes.GettableRule, error)

	// CloneRule creates a new rule from the stored definition of id, with a " - Copy" suffixed name.
	CloneRule(ctx context.Context, id valuer.UUID) (*ruletypes.GettableRule, error)

	// EditRule replaces the rule identified by id with the given JSON string.
	// TODO: same as CreateRule — accept PostableRule instead of raw string.
	EditRule(ctx context.Context, ruleStr string, id valuer.UUID) error

	// DeleteRule removes the rule identified by the string ID.
	// TODO: accept valuer.UUID instead of string for consistency with other methods.
	DeleteRule(ctx context.Context, idStr string) error

	// PatchRule applies a partial update to the rule identified by id.
	// TODO: same as CreateRule — accept PostableRule instead of raw string.
	PatchRule(ctx context.Context, ruleStr string, id valuer.UUID) (*ruletypes.GettableRule, error)

	// TestNotification fires a test alert for the rule defined in ruleStr.
	// TODO: same as CreateRule — accept PostableRule instead of raw string.
	TestNotification(ctx context.Context, orgID valuer.UUID, ruleStr string) (int, error)

	// MaintenanceStore returns the store for planned maintenance / downtime schedules.
	// TODO: expose downtime CRUD as methods on Ruler directly instead of leaking the
	// store interface. The handler should not call store methods directly.
	MaintenanceStore() alertmanagertypes.MaintenanceStore

	CreateRuleView(ctx context.Context, orgID valuer.UUID, postable ruletypes.PostableRuleView) (*ruletypes.RuleView, error)
	ListRuleViews(ctx context.Context, orgID valuer.UUID) (*ruletypes.ListableRuleViews, error)
	UpdateRuleView(ctx context.Context, orgID valuer.UUID, id valuer.UUID, updatable ruletypes.UpdatableRuleView) (*ruletypes.RuleView, error)
	DeleteRuleView(ctx context.Context, orgID valuer.UUID, id valuer.UUID) error
}