Add --description-as-label flag for filesystem and generate

Author: maitesin

filesystem.go

@@ -89,7 +89,7 @@ Objectives:
 	return objectives
 }
 
-func cmdFilesystem(logger log.Logger, reg *prometheus.Registry, promClient api.Client, configFiles, prometheusFolder string, genericRules bool) int {
+func cmdFilesystem(logger log.Logger, reg *prometheus.Registry, promClient api.Client, configFiles, prometheusFolder string, genericRules, descriptionAsLabel bool) int {
 	reconcilesTotal := prometheus.NewCounter(prometheus.CounterOpts{
 		Name: "pyrra_filesystem_reconciles_total",
 		Help: "The total amount of reconciles.",
@@ -179,7 +179,7 @@ func cmdFilesystem(logger log.Logger, reg *prometheus.Registry, promClient api.C
 					level.Debug(logger).Log("msg", "processing", "file", f)
 					reconcilesTotal.Inc()
 
-					err := writeRuleFile(logger, f, prometheusFolder, genericRules, false)
+					err := writeRuleFile(logger, f, prometheusFolder, genericRules, false, descriptionAsLabel)
 					if err != nil {
 						reconcilesErrors.Inc()
 						level.Error(logger).Log("msg", "error creating rule file", "file", f, "err", err)
@@ -301,7 +301,7 @@ func (s *FilesystemObjectiveServer) List(_ context.Context, req *connect.Request
 	}), nil
 }
 
-func writeRuleFile(logger log.Logger, file, prometheusFolder string, genericRules, operatorRule bool) error {
+func writeRuleFile(logger log.Logger, file, prometheusFolder string, genericRules, operatorRule, descriptionAsLabel bool) error {
 	kubeObjective, objective, err := objectiveFromFile(file)
 	if err != nil {
 		return fmt.Errorf("failed to get objective: %w", err)
@@ -336,7 +336,7 @@ func writeRuleFile(logger log.Logger, file, prometheusFolder string, genericRule
 	}
 
 	if genericRules {
-		rules, err := objective.GenericRules()
+		rules, err := objective.GenericRules(descriptionAsLabel)
 		if err == nil {
 			rule.Groups = append(rule.Groups, rules)
 		} else {

generate.go

@@ -20,15 +20,15 @@ import (
 	"github.com/go-kit/log/level"
 )
 
-func cmdGenerate(logger log.Logger, configFiles, prometheusFolder string, genericRules, operatorRule bool) int {
+func cmdGenerate(logger log.Logger, configFiles, prometheusFolder string, genericRules, operatorRule, descriptionAsLabel bool) int {
 	filenames, err := filepath.Glob(configFiles)
 	if err != nil {
 		level.Error(logger).Log("msg", "getting file names", "err", err)
 		return 1
 	}
 
 	for _, file := range filenames {
-		err := writeRuleFile(logger, file, prometheusFolder, genericRules, operatorRule)
+		err := writeRuleFile(logger, file, prometheusFolder, genericRules, operatorRule, descriptionAsLabel)
 		if err != nil {
 			level.Error(logger).Log("msg", "generating rule files", "err", err)
 			return 1

kubernetes/api/v1alpha1/servicelevelobjective_types.go

@@ -566,13 +566,14 @@ func (in *ServiceLevelObjective) Internal() (slo.Objective, error) {
 	}
 
 	return slo.Objective{
-		Labels:      ls,
-		Annotations: in.Annotations,
-		Description: in.Spec.Description,
-		Target:      target / 100,
-		Window:      window,
-		Config:      string(config),
-		Alerting:    alerting,
+		Labels:             ls,
+		Annotations:        in.Annotations,
+		Description:        in.Spec.Description,
+		DescriptionAsLabel: false,
+		Target:             target / 100,
+		Window:             window,
+		Config:             string(config),
+		Alerting:           alerting,
 		Indicator: slo.Indicator{
 			Ratio:         ratio,
 			Latency:       latency,

kubernetes/controllers/servicelevelobjective.go

@@ -239,7 +239,7 @@ func makeConfigMap(name string, kubeObjective pyrrav1alpha1.ServiceLevelObjectiv
 	}
 
 	if genericRules {
-		rules, err := objective.GenericRules()
+		rules, err := objective.GenericRules(false)
 		if err != nil {
 			if err != slo.ErrGroupingUnsupported {
 				return nil, fmt.Errorf("failed to get generic rules: %w", err)
@@ -307,7 +307,7 @@ func makeMimirRuleGroup(kubeObjective pyrrav1alpha1.ServiceLevelObjective, gener
 
 	genericMimirRules := []rulefmt.RuleNode{}
 	if genericRules {
-		rules, err := objective.GenericRules()
+		rules, err := objective.GenericRules(false)
 		if err != nil {
 			if err != slo.ErrGroupingUnsupported {
 				return nil, fmt.Errorf("failed to get generic rules: %w", err)
@@ -399,7 +399,7 @@ func makePrometheusRule(kubeObjective pyrrav1alpha1.ServiceLevelObjective, gener
 	}
 
 	if genericRules {
-		rules, err := objective.GenericRules()
+		rules, err := objective.GenericRules(false)
 		if err != nil {
 			if err != slo.ErrGroupingUnsupported {
 				return nil, fmt.Errorf("failed to get generic rules: %w", err)

main.go

@@ -67,10 +67,11 @@ var CLI struct {
 		TLSClientCAFile             string            `default:"" help:"File containing the CA certificate for the client"`
 	} `cmd:"" help:"Runs Pyrra's API and UI."`
 	Filesystem struct {
-		ConfigFiles      string   `default:"/etc/pyrra/*.yaml" help:"The folder where Pyrra finds the config files to use. Any non yaml files will be ignored."`
-		PrometheusURL    *url.URL `default:"http://localhost:9090" help:"The URL to the Prometheus to query."`
-		PrometheusFolder string   `default:"/etc/prometheus/pyrra/" help:"The folder where Pyrra writes the generates Prometheus rules and alerts."`
-		GenericRules     bool     `default:"false" help:"Enabled generic recording rules generation to make it easier for tools like Grafana."`
+		ConfigFiles        string   `default:"/etc/pyrra/*.yaml" help:"The folder where Pyrra finds the config files to use. Any non yaml files will be ignored."`
+		PrometheusURL      *url.URL `default:"http://localhost:9090" help:"The URL to the Prometheus to query."`
+		PrometheusFolder   string   `default:"/etc/prometheus/pyrra/" help:"The folder where Pyrra writes the generates Prometheus rules and alerts."`
+		GenericRules       bool     `default:"false" help:"Enabled generic recording rules generation to make it easier for tools like Grafana."`
+		DescriptionAsLabel bool     `default:"false" help:"Enable description of objective to be added as label."`
 	} `cmd:"" help:"Runs Pyrra's filesystem operator and backend for the API."`
 	Kubernetes struct {
 		MetricsAddr             string   `default:":8080" help:"The address the metric endpoint binds to."`
@@ -86,10 +87,11 @@ var CLI struct {
 		MimirWriteAlertingRules bool     `default:"false" help:"If alerting rules should be provisioned to the Mimir Ruler."`
 	} `cmd:"" help:"Runs Pyrra's Kubernetes operator and backend for the API."`
 	Generate struct {
-		ConfigFiles      string `default:"/etc/pyrra/*.yaml" help:"The folder where Pyrra finds the config files to use."`
-		PrometheusFolder string `default:"/etc/prometheus/pyrra/" help:"The folder where Pyrra writes the generated Prometheus rules and alerts."`
-		GenericRules     bool   `default:"false" help:"Enabled generic recording rules generation to make it easier for tools like Grafana."`
-		OperatorRule     bool   `default:"false" help:"Generate rule files as prometheus-operator PrometheusRule: https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.PrometheusRule."`
+		ConfigFiles        string `default:"/etc/pyrra/*.yaml" help:"The folder where Pyrra finds the config files to use."`
+		PrometheusFolder   string `default:"/etc/prometheus/pyrra/" help:"The folder where Pyrra writes the generated Prometheus rules and alerts."`
+		GenericRules       bool   `default:"false" help:"Enabled generic recording rules generation to make it easier for tools like Grafana."`
+		OperatorRule       bool   `default:"false" help:"Generate rule files as prometheus-operator PrometheusRule: https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.PrometheusRule."`
+		DescriptionAsLabel bool   `default:"false" help:"Enable description of objective to be added as label."`
 	} `cmd:"" help:"Read SLO config files and rewrites them as Prometheus rules and alerts."`
 }
 
@@ -198,6 +200,7 @@ func main() {
 			CLI.Filesystem.ConfigFiles,
 			CLI.Filesystem.PrometheusFolder,
 			CLI.Filesystem.GenericRules,
+			CLI.Filesystem.DescriptionAsLabel,
 		)
 	case "kubernetes":
 		code = cmdKubernetes(
@@ -218,6 +221,7 @@ func main() {
 			CLI.Generate.PrometheusFolder,
 			CLI.Generate.GenericRules,
 			CLI.Generate.OperatorRule,
+			CLI.Generate.DescriptionAsLabel,
 		)
 	}
 	os.Exit(code)

slo/promql_test.go

@@ -14,9 +14,10 @@ import (
 var (
 	objectiveHTTPRatio = func() Objective {
 		return Objective{
-			Labels: labels.FromStrings(labels.MetricName, "monitoring-http-errors"),
-			Target: 0.99,
-			Window: model.Duration(28 * 24 * time.Hour),
+			Labels:      labels.FromStrings(labels.MetricName, "monitoring-http-errors"),
+			Description: "HTTP Ratio",
+			Target:      0.99,
+			Window:      model.Duration(28 * 24 * time.Hour),
 			Alerting: Alerting{
 				Burnrates: true,
 				Absent:    true,
@@ -61,7 +62,7 @@ var (
 	objectiveGRPCRatio = func() Objective {
 		return Objective{
 			Labels:      labels.FromStrings(labels.MetricName, "monitoring-grpc-errors"),
-			Description: "",
+			Description: "GRPC Ratio",
 			Target:      0.999,
 			Window:      model.Duration(28 * 24 * time.Hour),
 			Alerting: Alerting{
@@ -100,9 +101,10 @@ var (
 	}
 	objectiveHTTPLatency = func() Objective {
 		return Objective{
-			Labels: labels.FromStrings(labels.MetricName, "monitoring-http-latency"),
-			Target: 0.995,
-			Window: model.Duration(28 * 24 * time.Hour),
+			Labels:      labels.FromStrings(labels.MetricName, "monitoring-http-latency"),
+			Description: "HTTP Latency",
+			Target:      0.995,
+			Window:      model.Duration(28 * 24 * time.Hour),
 			Alerting: Alerting{
 				Burnrates: true,
 				Absent:    true,
@@ -165,9 +167,10 @@ var (
 	}
 	objectiveGRPCLatency = func() Objective {
 		return Objective{
-			Labels: labels.FromStrings(labels.MetricName, "monitoring-grpc-latency"),
-			Target: 0.995,
-			Window: model.Duration(7 * 24 * time.Hour),
+			Labels:      labels.FromStrings(labels.MetricName, "monitoring-grpc-latency"),
+			Description: "GRPC Latency",
+			Target:      0.995,
+			Window:      model.Duration(7 * 24 * time.Hour),
 			Alerting: Alerting{
 				Burnrates: true,
 				Absent:    true,
@@ -204,9 +207,10 @@ var (
 	}
 	objectiveOperator = func() Objective {
 		return Objective{
-			Labels: labels.FromStrings(labels.MetricName, "monitoring-prometheus-operator-errors"),
-			Target: 0.99,
-			Window: model.Duration(14 * 24 * time.Hour),
+			Labels:      labels.FromStrings(labels.MetricName, "monitoring-prometheus-operator-errors"),
+			Description: "Operator",
+			Target:      0.99,
+			Window:      model.Duration(14 * 24 * time.Hour),
 			Alerting: Alerting{
 				Burnrates: true,
 				Absent:    true,
@@ -236,9 +240,10 @@ var (
 	}
 	objectiveAPIServerRatio = func() Objective {
 		return Objective{
-			Labels: labels.FromStrings(labels.MetricName, "apiserver-write-response-errors"),
-			Target: 0.99,
-			Window: model.Duration(14 * 24 * time.Hour),
+			Labels:      labels.FromStrings(labels.MetricName, "apiserver-write-response-errors"),
+			Description: "API Server Ratio",
+			Target:      0.99,
+			Window:      model.Duration(14 * 24 * time.Hour),
 			Alerting: Alerting{
 				Name:       "APIServerErrorBudgetBurn",
 				AbsentName: "APIServerMetricAbsent",
@@ -328,9 +333,10 @@ var (
 	}
 	objectiveUpTargets = func() Objective {
 		return Objective{
-			Labels: labels.FromStrings(labels.MetricName, "up-targets"),
-			Target: 0.99,
-			Window: model.Duration(28 * 24 * time.Hour),
+			Labels:      labels.FromStrings(labels.MetricName, "up-targets"),
+			Description: "Up targets",
+			Target:      0.99,
+			Window:      model.Duration(28 * 24 * time.Hour),
 			Alerting: Alerting{
 				Burnrates: true,
 				Absent:    true,

slo/rules.go

@@ -1147,12 +1147,16 @@ func burnratesFromWindows(ws []Window) []time.Duration {
 
 var ErrGroupingUnsupported = errors.New("objective with grouping not supported in generic rules")
 
-func (o Objective) GenericRules() (monitoringv1.RuleGroup, error) {
+func (o Objective) GenericRules(descriptionAsLabel bool) (monitoringv1.RuleGroup, error) {
 	sloName := o.Labels.Get(labels.MetricName)
 	var rules []monitoringv1.Rule
 
 	ruleLabels := o.commonRuleLabels(sloName)
 
+	if descriptionAsLabel {
+		ruleLabels["description"] = o.Description
+	}
+
 	rules = append(rules, monitoringv1.Rule{
 		Record: "pyrra_objective",
 		Expr:   intstr.FromString(strconv.FormatFloat(o.Target, 'f', -1, 64)),