promtorture v0.1

Author: ringerc

testcases/promtorture/.gitignore

@@ -0,0 +1 @@
+promtorture

testcases/promtorture/Dockerfile

@@ -0,0 +1,18 @@
+# syntax=docker/dockerfile:1
+
+# docker buildx build -t promtorture .
+FROM golang:1.22-alpine AS builder
+
+WORKDIR /app
+COPY go.mod go.sum .
+RUN --mount=type=cache,target=/go/pkg/mod \
+  go mod download
+
+COPY . .
+RUN --mount=type=cache,target=/go/pkg/mod \
+  go build -o /app/promtorture .
+
+FROM scratch
+COPY --from=builder /app/promtorture /app/promtorture
+
+ENTRYPOINT ["/app/promtorture"]

testcases/promtorture/LICENSE

@@ -0,0 +1 @@
+Do what you want

testcases/promtorture/cmd/root.go

@@ -0,0 +1,84 @@
+package cmd
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"strconv"
+	"strings"
+
+	"github.com/ringerc/scrapcode/testcases/promtorture/internal/generator"
+	"github.com/ringerc/scrapcode/testcases/promtorture/internal/server"
+	"github.com/spf13/cobra"
+)
+
+var rootCmd = &cobra.Command{
+	Use:   "promtorture",
+	Short: "Generate metrics to make Prometheus sad",
+	Long: `Generate varied sets of metrics to test
+Prometheus (and compatible) memory, CPU, disk consumption,
+computed cardinality etc.
+
+This is intended as a torture test for Prometheus, Thanos,
+VictoriaMetrics etc resource use.
+`,
+	Run: func(cmd *cobra.Command, args []string) {
+		var err error
+		cfg := generator.Config{}
+		cfg.Port, err = cmd.Flags().GetInt("port")
+		if err != nil {
+			log.Fatalf("while parsing --port: %v", err)
+		}
+		targetsArg, err := cmd.Flags().GetString("targets")
+		if err != nil {
+			log.Fatalf("while reading --targets: %v", err)
+		}
+		cfg.Targets, err = parseTargets(targetsArg)
+		if err != nil {
+			log.Fatalf("while parsing --targets: %v", err)
+		}
+		cfg.InfoMetricsLabels, err = cmd.Flags().GetInt("info-metrics-labels")
+		if err != nil {
+			log.Fatalf("while parsing --info-metrics-labels: %v", err)
+		}
+		cfg.GaugeMetrics, err = cmd.Flags().GetInt("gauge-metrics")
+		if err != nil {
+			log.Fatalf("while parsing --gauge-metrics: %v", err)
+		}
+
+		reg := generator.CreateRegistry(cfg)
+		server.ServeForever(reg)
+	},
+}
+
+func Execute() {
+	err := rootCmd.Execute()
+	if err != nil {
+		os.Exit(1)
+	}
+}
+
+func init() {
+	rootCmd.Flags().String("targets", "1", "Number of unique targets to generate. Can be a comma separated list of numbers in which case multiple labels will be used and each number specifies the number of unique values in that label.")
+	rootCmd.Flags().Int("info-metrics-labels", 0, "Number of labels per info metric. If 0, no info-metric will be generated.")
+	rootCmd.Flags().Int("gauge-metrics", 1, "Number of gauge metrics to generate for each target.")
+	rootCmd.Flags().IntP("port", "p", 8080, "Port to listen on for scrape requests")
+}
+
+/*
+ * Parse comma-separated list of target label counts into a slice of integers
+ */
+func parseTargets(targetsParam string) ([]int, error) {
+	targets := make([]int, 0)
+	for i, t := range strings.Split(targetsParam, ",") {
+		tn, err := strconv.ParseInt(t, 10, 32)
+		if err != nil {
+			return nil, fmt.Errorf("\"%v\" element \"%s\" (#%d): %v", targetsParam, t, i, err)
+		}
+		if tn < 1 {
+			return nil, fmt.Errorf("\"%v\" element \"%s\" (#%d): must be >= 1", targetsParam, t, i)
+		}
+		targets = append(targets, int(tn))
+	}
+	return targets, nil
+}

testcases/promtorture/go.mod

@@ -0,0 +1,23 @@
+module github.com/ringerc/scrapcode/testcases/promtorture
+
+go 1.22.0
+
+require (
+	github.com/prometheus/client_golang v1.19.1
+	github.com/spf13/cobra v1.8.1
+	honnef.co/go/tools v0.4.7
+)
+
+require (
+	github.com/BurntSushi/toml v1.2.1 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/prometheus/client_model v0.5.0 // indirect
+	github.com/prometheus/common v0.48.0 // indirect
+	github.com/prometheus/procfs v0.12.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/sys v0.17.0 // indirect
+	golang.org/x/tools v0.12.1-0.20230825192346-2191a27a6dc5 // indirect
+	google.golang.org/protobuf v1.33.0 // indirect
+)

testcases/promtorture/go.sum

@@ -0,0 +1,36 @@
+github.com/BurntSushi/toml v1.2.1 h1:9F2/+DoOYIOksmaJFPw1tGFy1eDnIJXg+UHjuD8lTak=
+github.com/BurntSushi/toml v1.2.1/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
+github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
+github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
+github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
+github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
+github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/prometheus/client_golang v1.19.1 h1:wZWJDwK+NameRJuPGDhlnFgx8e8HN3XHQeLaYJFJBOE=
+github.com/prometheus/client_golang v1.19.1/go.mod h1:mP78NwGzrVks5S2H6ab8+ZZGJLZUq1hoULYBAYBw1Ho=
+github.com/prometheus/client_model v0.5.0 h1:VQw1hfvPvk3Uv6Qf29VrPF32JB6rtbgI6cYPYQjL0Qw=
+github.com/prometheus/client_model v0.5.0/go.mod h1:dTiFglRmd66nLR9Pv9f0mZi7B7fk5Pm3gvsjB5tr+kI=
+github.com/prometheus/common v0.48.0 h1:QO8U2CdOzSn1BBsmXJXduaaW+dY/5QLjfB8svtSzKKE=
+github.com/prometheus/common v0.48.0/go.mod h1:0/KsvlIEfPQCQ5I2iNSAWKPZziNCvRs5EC6ILDTlAPc=
+github.com/prometheus/procfs v0.12.0 h1:jluTpSng7V9hY0O2R9DzzJHYb2xULk9VTR1V1R/k6Bo=
+github.com/prometheus/procfs v0.12.0/go.mod h1:pcuDEFsWDnvcgNzo4EEweacyhjeA9Zk3cnaOZAZEfOo=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
+github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+golang.org/x/sys v0.17.0 h1:25cE3gD+tdBA7lp7QfhuV+rJiE9YXTcS3VG1SqssI/Y=
+golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/tools v0.12.1-0.20230825192346-2191a27a6dc5 h1:Vk4mysSz+GqQK2eqgWbo4zEO89wkeAjJiFIr9bpqa8k=
+golang.org/x/tools v0.12.1-0.20230825192346-2191a27a6dc5/go.mod h1:Sc0INKfu04TlqNoRA1hgpFZbhYXHPr4V5DzpSBTPqQM=
+google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
+google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+honnef.co/go/tools v0.4.7 h1:9MDAWxMoSnB6QoSqiVr7P5mtkT9pOc1kSxchzPCnqJs=
+honnef.co/go/tools v0.4.7/go.mod h1:+rnGS1THNh8zMwnd2oVOTL9QF6vmfyG6ZXBULae2uc0=

testcases/promtorture/internal/generator/generator.go

@@ -0,0 +1,128 @@
+/*
+ * Generate varied prometheus metrics
+ */
+package generator
+
+import (
+	"fmt"
+	"log"
+	"strconv"
+
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+type Config struct {
+	Port              int
+	Targets           []int
+	InfoMetricsLabels int
+	GaugeMetrics      int
+}
+
+type target struct {
+	targetNumber  int
+	targetIndexes []int
+	targetLabels  prometheus.Labels
+	infoMetric    *prometheus.Gauge
+	gaugeMetrics  []prometheus.Gauge
+}
+
+// string representation of the target labels
+func (t *target) indexesString() string {
+	s := ""
+	for i, v := range t.targetIndexes {
+		if i > 0 {
+			s += ","
+		}
+		s += strconv.Itoa(v)
+	}
+	return s
+}
+
+func createTarget(cfg Config, targetNumber int, targetIndexes []int) target {
+	t := target{
+		targetNumber:  targetNumber,
+		targetIndexes: targetIndexes,
+	}
+	t.targetLabels = prometheus.Labels{}
+	for i, v := range targetIndexes {
+		t.targetLabels["target_label_"+strconv.Itoa(i)] = strconv.Itoa(v)
+	}
+
+	log.Printf("Creating target %d with indexes %v, labels %v", targetNumber, targetIndexes, t.targetLabels)
+
+	indexesStr := t.indexesString()
+
+	if cfg.InfoMetricsLabels > 0 {
+		infoMetricLabels := prometheus.Labels{}
+		// copy the target labels to the info metric label set
+		for k, v := range t.targetLabels {
+			infoMetricLabels[k] = v
+		}
+		// add info labels. The names must be consistent for each
+		// target, and the values should differ since we presume the
+		// targets are unique. So the target indexes will be used for
+		// the info-metric values.
+		for i := 0; i < cfg.InfoMetricsLabels; i++ {
+			infoMetricLabels["info_label_"+strconv.Itoa(i)] = indexesStr
+		}
+		infoMetric := prometheus.NewGauge(prometheus.GaugeOpts{
+			Name:        "info_metric",
+			Help:        "Info metric",
+			ConstLabels: infoMetricLabels,
+		})
+		t.infoMetric = &infoMetric
+		//log.Printf("Created info-metric %s", (*t.infoMetric).Desc().String())
+	}
+
+	t.gaugeMetrics = make([]prometheus.Gauge, cfg.GaugeMetrics)
+	for i := 0; i < cfg.GaugeMetrics; i++ {
+		t.gaugeMetrics[i] = prometheus.NewGauge(prometheus.GaugeOpts{
+			Name:        fmt.Sprintf("gauge_metric_%d", i),
+			Help:        fmt.Sprintf("Gauge metric %d", i),
+			ConstLabels: t.targetLabels,
+		})
+		//log.Printf("Created gauge metric %s", t.gaugeMetrics[i].Desc().String())
+	}
+
+	return t
+}
+
+func (t *target) register(reg *prometheus.Registry) {
+	if t.infoMetric != nil {
+		reg.MustRegister(*t.infoMetric)
+	}
+	for _, m := range t.gaugeMetrics {
+		reg.MustRegister(m)
+	}
+}
+
+func CreateRegistry(cfg Config) *prometheus.Registry {
+
+	// The number of targets to generate is the array product of
+	// cfg.Targets. The number of labels can vary, so we'll use a counter
+	// array, incrementing each value until it reaches the limit then reset
+	// to 0 and roll over to increment the next counter. Dumb, but easy.
+	totalTargets := 1
+	targetCounters := make([]int, len(cfg.Targets))
+	for i := 0; i < len(cfg.Targets); i++ {
+		targetCounters[i] = 0
+		totalTargets *= cfg.Targets[i]
+	}
+
+	log.Printf("creating registry for %d targets: %v", totalTargets, cfg.Targets)
+
+	reg := prometheus.NewRegistry()
+
+	for targetNumber := 0; targetNumber < totalTargets; targetNumber++ {
+		remainder := targetNumber
+		for i := 0; i < len(targetCounters); i++ {
+			targetCounters[i] = remainder % cfg.Targets[i]
+			remainder = remainder / cfg.Targets[i]
+		}
+
+		t := createTarget(cfg, targetNumber, targetCounters)
+		t.register(reg)
+	}
+
+	return reg
+}

testcases/promtorture/internal/server/http.go

@@ -0,0 +1,18 @@
+/*
+ * prometheus metrics server endpoint
+ */
+package server
+
+import (
+	"log"
+	"net/http"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+)
+
+func ServeForever(reg *prometheus.Registry) {
+	http.Handle("/metrics", promhttp.HandlerFor(reg, promhttp.HandlerOpts{Registry: reg}))
+	log.Printf("Listening on :8080 for /metrics")
+	log.Fatal(http.ListenAndServe(":8080", nil))
+}

testcases/promtorture/main.go

@@ -0,0 +1,11 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+
+*/
+package main
+
+import "github.com/ringerc/scrapcode/testcases/promtorture/cmd"
+
+func main() {
+	cmd.Execute()
+}