check_sampler_bench_test.go

// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016-present Datadog, Inc.

package aggregator

import (
	"testing"

	"go.uber.org/fx"

	"github.com/DataDog/datadog-agent/comp/core"
	"github.com/DataDog/datadog-agent/comp/core/hostname"
	"github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl"
	log "github.com/DataDog/datadog-agent/comp/core/log/def"
	secretsmock "github.com/DataDog/datadog-agent/comp/core/secrets/mock"
	taggerfxmock "github.com/DataDog/datadog-agent/comp/core/tagger/fx-mock"
	"github.com/DataDog/datadog-agent/comp/core/telemetry/def"
	filterlistimpl "github.com/DataDog/datadog-agent/comp/filterlist/impl"
	eventplatform "github.com/DataDog/datadog-agent/comp/forwarder/eventplatform/def"
	eventplatformimpl "github.com/DataDog/datadog-agent/comp/forwarder/eventplatform/impl"
	haagentmock "github.com/DataDog/datadog-agent/comp/haagent/mock"
	logscompressionmock "github.com/DataDog/datadog-agent/comp/serializer/logscompression/fx-mock"

	forwarder "github.com/DataDog/datadog-agent/comp/forwarder/defaultforwarder/def"
	forwarderimpl "github.com/DataDog/datadog-agent/comp/forwarder/defaultforwarder/impl"
	forwardernoop "github.com/DataDog/datadog-agent/comp/forwarder/defaultforwarder/noop-impl"
	"github.com/DataDog/datadog-agent/comp/forwarder/defaultforwarder/resolver"
	compression "github.com/DataDog/datadog-agent/comp/serializer/metricscompression/def"
	"github.com/DataDog/datadog-agent/pkg/aggregator/ckey"
	"github.com/DataDog/datadog-agent/pkg/aggregator/internal/tags"
	"github.com/DataDog/datadog-agent/pkg/config/utils"

	checkid "github.com/DataDog/datadog-agent/pkg/collector/check/id"
	configmock "github.com/DataDog/datadog-agent/pkg/config/mock"
	"github.com/DataDog/datadog-agent/pkg/metrics"
	"github.com/DataDog/datadog-agent/pkg/util/fxutil"
	"github.com/DataDog/datadog-agent/pkg/util/option"
)

type benchmarkDeps struct {
	fx.In
	Log        log.Component
	Hostname   hostname.Component
	Compressor compression.Component
	Telemetry  telemetry.Component
}

func benchmarkAddBucket(bucketValue int64, b *testing.B) {
	// Because these benchs can run for a long time, the aggregator is trying to
	// flush and because the serializer is not initialized it panics with a nil.
	// For some reasons using InitAggregator[WithInterval] doesn't fix the problem,
	// but this do.
	mockConfig := configmock.New(b)
	deps := fxutil.Test[benchmarkDeps](b, core.MockBundle(), hostnameimpl.MockModule())
	taggerComponent := taggerfxmock.SetupFakeTagger(b)
	resolver, _ := resolver.NewSingleDomainResolvers(map[string][]utils.APIKeys{"hello": {utils.NewAPIKeys("", "world")}})
	forwarderOpts := forwarderimpl.NewOptionsWithResolvers(mockConfig, deps.Log, resolver)
	options := DefaultAgentDemultiplexerOptions()
	options.DontStartForwarders = true
	secrets := secretsmock.New(b)
	forwarderOpts.Secrets = secrets
	sharedForwarder := forwarderimpl.NewDefaultForwarder(mockConfig, deps.Log, forwarderOpts)
	orchestratorForwarder := option.New[forwarder.Forwarder](forwardernoop.NewComponent())
	eventPlatformForwarder := option.NewPtr[eventplatform.Forwarder](eventplatformimpl.NewNoopEventPlatformForwarder(deps.Hostname, logscompressionmock.NewMockCompressor()))
	haAgent := haagentmock.NewMockHaAgent()
	filterList := filterlistimpl.NewFilterList(deps.Log, mockConfig, deps.Telemetry)
	demux := InitAndStartAgentDemultiplexer(deps.Log, sharedForwarder, &orchestratorForwarder, options, eventPlatformForwarder, haAgent, deps.Compressor, taggerComponent, filterList, "hostname")
	defer demux.Stop()

	checkSampler := newCheckSampler(1, true, true, 1000, true, tags.NewStore(true, "bench"), checkid.ID("hello:world:1234"), taggerComponent)
	matcher := filterlistimpl.NewNoopTagMatcher()

	bucket := &metrics.HistogramBucket{
		Name:       "my.histogram",
		Value:      bucketValue,
		LowerBound: 10.0,
		UpperBound: 20.0,
		Tags:       []string{"foo", "bar"},
		Timestamp:  12345.0,
	}

	for n := 0; n < b.N; n++ {
		checkSampler.addBucket(bucket, matcher)
		// reset bucket cache
		checkSampler.lastBucketValue = make(map[ckey.ContextKey]int64)
	}
}

func benchmarkAddBucketWideBounds(bucketValue int64, b *testing.B) {
	taggerComponent := taggerfxmock.SetupFakeTagger(b)
	checkSampler := newCheckSampler(1, true, true, 1000, true, tags.NewStore(true, "bench"), checkid.ID("hello:world:1234"), taggerComponent)
	matcher := filterlistimpl.NewNoopTagMatcher()

	bounds := []float64{0, .0005, .001, .003, .005, .007, .01, .015, .02, .025, .03, .04, .05, .06, .07, .08, .09, .1, .5, 1, 5, 10}
	bucket := &metrics.HistogramBucket{
		Name:      "my.histogram",
		Value:     bucketValue,
		Tags:      []string{"foo", "bar"},
		Timestamp: 12345.0,
	}

	for n := 0; n < b.N; n++ {
		for i := range bounds {
			if i == 0 {
				continue
			}
			bucket.LowerBound = bounds[i-1]
			bucket.UpperBound = bounds[i]
			checkSampler.addBucket(bucket, matcher)
		}
		// reset bucket cache
		checkSampler.lastBucketValue = make(map[ckey.ContextKey]int64)
	}
}

func BenchmarkAddBucket1(b *testing.B)        { benchmarkAddBucket(1, b) }
func BenchmarkAddBucket10(b *testing.B)       { benchmarkAddBucket(10, b) }
func BenchmarkAddBucket100(b *testing.B)      { benchmarkAddBucket(100, b) }
func BenchmarkAddBucket1000(b *testing.B)     { benchmarkAddBucket(1000, b) }
func BenchmarkAddBucket10000(b *testing.B)    { benchmarkAddBucket(10000, b) }
func BenchmarkAddBucket1000000(b *testing.B)  { benchmarkAddBucket(1000000, b) }
func BenchmarkAddBucket10000000(b *testing.B) { benchmarkAddBucket(10000000, b) }

func BenchmarkAddBucketWide1e10(b *testing.B) { benchmarkAddBucketWideBounds(1e10, b) }