New option to specify Prometheus Pushgateway job name (#193)

Author: spasche

config/profile.go

@@ -89,6 +89,7 @@ type Profile struct {
 	StatusFile              string                            `mapstructure:"status-file" description:"Path to the status file to update with a summary of last restic command result"`
 	PrometheusSaveToFile    string                            `mapstructure:"prometheus-save-to-file" description:"Path to the prometheus metrics file to update with a summary of the last restic command result"`
 	PrometheusPush          string                            `mapstructure:"prometheus-push" format:"uri" description:"URL of the prometheus push gateway to send the summary of the last restic command result to"`
+	PrometheusPushJob       string                            `mapstructure:"prometheus-push-job" description:"Prometheus push gateway job name. $command placeholder is replaced with restic command"`
 	PrometheusLabels        map[string]string                 `mapstructure:"prometheus-labels" description:"Additional prometheus labels to set"`
 	Environment             map[string]ConfidentialValue      `mapstructure:"env" description:"Additional environment variables to set in any child process"`
 	Init                    *InitSection                      `mapstructure:"init"`

docs/content/status/prometheus/index.md

@@ -129,6 +129,12 @@ resticprofile_build_info{goversion="go1.19",version="0.19.0"} 1
 
 ```
 
+## Prometheus Pushgateway
+
+Prometheus Pushgateway uses the job label as a grouping key. All metrics with the same grouping key get replaced when pushed. To prevent metrics from multiple profiles getting overwritten by each other, the default job label is set to `<profile_name>.<command>` (e.g. `root.backup`).
+
+If you need more control over the job label, you can use the `prometheus-push-job` property. This property can contain the `$command` placeholder, which is replaced with the name of the executed command.
+
 ## User defined labels
 
 You can add your own prometheus labels. Please note they will be applied to **all** the metrics.

monitor/prom/progress.go

@@ -1,6 +1,10 @@
 package prom
 
 import (
+	"fmt"
+	"os"
+	"strings"
+
 	"github.com/creativeprojects/clog"
 	"github.com/creativeprojects/resticprofile/config"
 	"github.com/creativeprojects/resticprofile/constants"
@@ -55,7 +59,17 @@ func (p *Progress) Summary(command string, summary monitor.Summary, stderr strin
 		}
 	}
 	if p.profile.PrometheusPush != "" {
-		err := p.metrics.Push(p.profile.PrometheusPush, command)
+		jobName := p.profile.PrometheusPushJob
+		if jobName == "" {
+			jobName = fmt.Sprintf("%s.%s", p.profile.Name, command)
+		}
+		jobName = os.Expand(jobName, func(name string) string {
+			if strings.EqualFold(name, "command") {
+				return command
+			}
+			return ""
+		})
+		err := p.metrics.Push(p.profile.PrometheusPush, jobName)
 		if err != nil {
 			// not important enough to throw an error here
 			clog.Warningf("pushing prometheus metrics to %q: %v", p.profile.PrometheusPush, err)