AdGuardDNS/internal/experiment/experiment.go

// Package experiment occasionally contains code for one-off experiments.
// Experiments can be enabled using the EXPERIMENTS environment variable, which
// is a comma-separated list of experiment IDs.
//
// Please keep every experiment in its own file.
//
// Since the code living here is short-living, the following requirements do not
// apply:
//
//   - Comments may be skipped.
//   - Some errors may be logged or ignored.
//   - Tests may be lacking.
//   - The environment may be read here as opposed to package cmd.
//   - init() is allowed.
package experiment

import (
	"os"

	"github.com/AdguardTeam/AdGuardDNS/internal/metrics"
	"github.com/AdguardTeam/golibs/log"
	"github.com/AdguardTeam/golibs/stringutil"
	"github.com/prometheus/client_golang/prometheus"
)

func init() {
	expStr := os.Getenv("EXPERIMENTS")
	if expStr == "" {
		return
	}

	expIDs := stringutil.SplitTrimmed(expStr, ",")
	for _, id := range expIDs {
		switch id {
		// NOTE: Add experiments here in the following format:
		//	case idMyExp:
		//		enableMyExp()
		default:
			log.Error("experiment: no experiment with id %q", id)
		}
	}

	enableMetrics()
}

// enableMetrics sets the labels with enabled experiments and sets the gauge
// value to 1.
func enableMetrics() {
	expGauge := metrics.ExperimentGauge(prometheus.Labels{
		// NOTE: Add experiments here in the following format:
		//	idMyExp: metrics.BoolString(expMyExpEnabled),
	})

	expGauge.Set(1)
}