github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/scripts/comparator/compare.go

// Copyright (c) 2019 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package main

import (
	"bytes"
	"encoding/json"
	"errors"
	"flag"
	"fmt"
	"io/ioutil"
	"net/http"
	"os"
	"time"

	"github.com/m3db/m3/scripts/comparator/utils"
	"github.com/m3db/m3/src/query/api/v1/handler/prometheus"
	xerrors "github.com/m3db/m3/src/x/errors"
	"github.com/m3db/m3/src/x/instrument"

	"go.uber.org/zap"
)

func paramError(err string, log *zap.Logger) {
	log.Error(err)
	flag.Usage()
}

func main() {
	var (
		iOpts = instrument.NewOptions()
		log   = iOpts.Logger()

		now = time.Now()

		pQueryFile    = flag.String("input", "", "the query file")
		pPromAddress  = flag.String("promAdress", "0.0.0.0:9090", "prom address")
		pQueryAddress = flag.String("queryAddress", "0.0.0.0:7201/m3query", "M3 query address")

		pComparatorAddress = flag.String("comparator", "", "comparator address")
		pRegressionDir     = flag.String("regressionDir", "", "optional directory for regression tests")

		pStart = flag.Int64("s", now.Add(time.Hour*-3).Unix(), "start time")
		pEnd   = flag.Int64("e", now.Unix(), "start end")
	)

	flag.Parse()
	var (
		queryFile    = *pQueryFile
		promAddress  = *pPromAddress
		queryAddress = *pQueryAddress

		regressionDir     = *pRegressionDir
		comparatorAddress = *pComparatorAddress

		start = *pStart
		end   = *pEnd
	)

	fmt.Println(queryFile, start, end)

	if len(queryFile) == 0 {
		paramError("No query found", log)
		os.Exit(1)
	}

	if len(promAddress) == 0 {
		paramError("No prom address found", log)
		os.Exit(1)
	}

	if len(queryAddress) == 0 {
		paramError("No query server address found", log)
		os.Exit(1)
	}

	if end < start {
		paramError(fmt.Sprintf("start(%d) is before end (%d)", start, end), log)
		os.Exit(1)
	}

	queries, err := utils.ParseFileToPromQLQueryGroup(queryFile, start, end, log)
	if err != nil {
		log.Error("could not parse file to PromQL queries", zap.Error(err))
		os.Exit(1)
	}

	var multiErr xerrors.MultiError
	for _, queryGroup := range queries {
		runs := 1
		if queryGroup.Reruns > 1 {
			runs = queryGroup.Reruns
		}

		for i := 0; i < runs; i++ {
			log.Info("running query group",
				zap.String("group", queryGroup.QueryGroup),
				zap.Int("run", i+1))
			if err := runQueryGroup(
				queryGroup,
				promAddress,
				queryAddress,
				log,
			); err != nil {
				multiErr = multiErr.Add(err)
				log.Error("query group encountered failure",
					zap.String("group", queryGroup.QueryGroup),
					zap.Int("run", i+1),
					zap.Error(err))
			}
		}
	}

	if !multiErr.Empty() {
		log.Fatal("mismatched queries detected in base queries")
	}
	log.Info("base queries success")

	if err := runRegressionSuite(regressionDir, comparatorAddress,
		promAddress, queryAddress, log); err != nil {
		log.Fatal("failure or mismatched queries detected in regression suite", zap.Error(err))
	}
	log.Info("regression success")
}

func runRegressionSuite(
	regressionDir string,
	comparatorAddress string,
	promAddress string,
	queryAddress string,
	log *zap.Logger,
) error {
	fmt.Println("dir", regressionDir, "add", comparatorAddress)
	if len(regressionDir) == 0 {
		log.Info("no regression directory supplied.")
		return nil
	}

	if len(comparatorAddress) == 0 {
		err := errors.New("no comparator address")
		log.Error("regression turned on but no comparator address", zap.Error(err))
		return err
	}

	regressions, err := utils.ParseRegressionFilesToPromQLQueryGroup(regressionDir, log)
	if err != nil {
		log.Error("could not parse regressions to PromQL queries", zap.Error(err))
		return err
	}

	var multiErr xerrors.MultiError
	for _, regressionGroup := range regressions {
		runs := 1
		if regressionGroup.Reruns > 1 {
			runs = regressionGroup.Reruns
		}

		for i := 0; i < runs; i++ {
			log.Info("running query group",
				zap.String("group", regressionGroup.QueryGroup),
				zap.Int("run", i+1))

			if err := runRegression(
				regressionGroup,
				comparatorAddress,
				promAddress,
				queryAddress,
				log,
			); err != nil {
				multiErr = multiErr.Add(err)
			}
		}
	}

	if err := multiErr.LastError(); err != nil {
		log.Error("mismatched queries detected in regression queries", zap.Error(err))
		return err
	}

	return nil
}

func runRegression(
	queryGroup utils.PromQLRegressionQueryGroup,
	comparatorAddress string,
	promAddress string,
	queryAddress string,
	log *zap.Logger,
) error {
	data, err := json.Marshal(queryGroup.Data)
	if err != nil {
		log.Error("could not marshall data", zap.Error(err))
		return err
	}

	comparatorURL := fmt.Sprintf("http://%s", comparatorAddress)
	resp, err := http.Post(comparatorURL, "application/json", bytes.NewReader(data))
	if err != nil {
		log.Error("could not seed regression data", zap.Error(err))
		return err
	}

	if resp.StatusCode/200 != 1 {
		log.Error("seed status code not 2XX",
			zap.Int("code", resp.StatusCode),
			zap.String("status", resp.Status))
		return fmt.Errorf("status code %d", resp.StatusCode)
	}

	var multiErr xerrors.MultiError
	for _, query := range queryGroup.Queries {
		promURL := fmt.Sprintf("http://%s%s", promAddress, query)
		queryURL := fmt.Sprintf("http://%s%s", queryAddress, query)
		if err := runComparison(promURL, queryURL, log); err != nil {
			multiErr = multiErr.Add(err)
			log.Error(
				"mismatched query",
				zap.String("promURL", promURL),
				zap.String("queryURL", queryURL),
			)
		}
	}

	return multiErr.FinalError()
}

func runQueryGroup(
	queryGroup utils.PromQLQueryGroup,
	promAddress string,
	queryAddress string,
	log *zap.Logger,
) error {
	var multiErr xerrors.MultiError
	for _, query := range queryGroup.Queries {
		promURL := fmt.Sprintf("http://%s%s", promAddress, query)
		queryURL := fmt.Sprintf("http://%s%s", queryAddress, query)
		if err := runComparison(promURL, queryURL, log); err != nil {
			multiErr = multiErr.Add(err)
			log.Error(
				"mismatched query",
				zap.String("promURL", promURL),
				zap.String("queryURL", queryURL),
			)
		}
	}

	return multiErr.FinalError()
}

func runComparison(
	promURL string,
	queryURL string,
	log *zap.Logger,
) error {
	promResult, err := parseResult(promURL)
	if err != nil {
		log.Error("failed to parse Prometheus result", zap.Error(err))
		return err
	}

	queryResult, err := parseResult(queryURL)
	if err != nil {
		log.Error("failed to parse M3Query result", zap.Error(err))
		return err
	}

	_, err = promResult.Matches(queryResult)
	if err != nil {
		log.Error("mismatch", zap.Error(err))
		return err
	}

	return nil
}

func parseResult(endpoint string) (prometheus.Response, error) {
	var result prometheus.Response
	response, err := http.Get(endpoint)
	if err != nil {
		return result, err
	}

	if response.StatusCode != http.StatusOK {
		return result, fmt.Errorf("response failed with code %s", response.Status)
	}

	body := response.Body
	defer func() {
		body.Close()
	}()

	data, err := ioutil.ReadAll(body)
	if err != nil {
		return result, err
	}

	if err = json.Unmarshal(data, &result); err != nil {
		return result, err
	}

	return result, nil
}