github.com/prebid/prebid-server/v2@v2.18.0/metrics/prometheus/prometheus_test.go

package prometheusmetrics

import (
	"fmt"
	"testing"
	"time"

	"github.com/prebid/prebid-server/v2/config"
	"github.com/prebid/prebid-server/v2/metrics"
	"github.com/prebid/prebid-server/v2/openrtb_ext"
	"github.com/prometheus/client_golang/prometheus"
	dto "github.com/prometheus/client_model/go"
	"github.com/stretchr/testify/assert"
)

var modulesStages = map[string][]string{"foobar": {"entry", "raw"}, "another_module": {"raw", "auction"}}

func createMetricsForTesting() *Metrics {
	syncerKeys := []string{}
	return NewMetrics(config.PrometheusMetrics{
		Port:      8080,
		Namespace: "prebid",
		Subsystem: "server",
	}, config.DisabledMetrics{}, syncerKeys, modulesStages)
}

func TestMetricCountGatekeeping(t *testing.T) {
	m := createMetricsForTesting()

	// Gather All Metrics
	metricFamilies, err := m.Gatherer.Gather()
	assert.NoError(t, err, "gather metics")

	// Summarize By Adapter Cardinality
	// - This requires metrics to be preloaded. We don't preload account metrics, so we can't test those.
	generalCardinalityCount := 0
	adapterCardinalityCount := 0
	for _, metricFamily := range metricFamilies {
		for _, metric := range metricFamily.GetMetric() {
			isPerAdapter := false
			for _, label := range metric.GetLabel() {
				if label.GetName() == adapterLabel {
					isPerAdapter = true
				}
			}

			if isPerAdapter {
				adapterCardinalityCount++
			} else {
				generalCardinalityCount++
			}
		}
	}

	// Calculate Per-Adapter Cardinality
	adapterCount := len(openrtb_ext.CoreBidderNames())
	perAdapterCardinalityCount := adapterCardinalityCount / adapterCount
	// Verify General Cardinality
	// - This assertion provides a warning for newly added high-cardinality non-adapter specific metrics. The hardcoded limit
	//   is an arbitrary soft ceiling. Thought should be given as to the value of the new metrics if you find yourself
	//   needing to increase this number.
	assert.True(t, generalCardinalityCount <= 500, "General Cardinality")

	// Verify Per-Adapter Cardinality
	// - This assertion provides a warning for newly added adapter metrics. Threre are 40+ adapters which makes the
	//   cost of new per-adapter metrics rather expensive. Thought should be given when adding new per-adapter metrics.
	assert.True(t, perAdapterCardinalityCount <= 31, "Per-Adapter Cardinality count equals %d \n", perAdapterCardinalityCount)
}

func TestConnectionMetrics(t *testing.T) {
	testCases := []struct {
		description              string
		testCase                 func(m *Metrics)
		expectedOpenedCount      float64
		expectedOpenedErrorCount float64
		expectedClosedCount      float64
		expectedClosedErrorCount float64
	}{
		{
			description: "Open Success",
			testCase: func(m *Metrics) {
				m.RecordConnectionAccept(true)
			},
			expectedOpenedCount:      1,
			expectedOpenedErrorCount: 0,
			expectedClosedCount:      0,
			expectedClosedErrorCount: 0,
		},
		{
			description: "Open Error",
			testCase: func(m *Metrics) {
				m.RecordConnectionAccept(false)
			},
			expectedOpenedCount:      0,
			expectedOpenedErrorCount: 1,
			expectedClosedCount:      0,
			expectedClosedErrorCount: 0,
		},
		{
			description: "Closed Success",
			testCase: func(m *Metrics) {
				m.RecordConnectionClose(true)
			},
			expectedOpenedCount:      0,
			expectedOpenedErrorCount: 0,
			expectedClosedCount:      1,
			expectedClosedErrorCount: 0,
		},
		{
			description: "Closed Error",
			testCase: func(m *Metrics) {
				m.RecordConnectionClose(false)
			},
			expectedOpenedCount:      0,
			expectedOpenedErrorCount: 0,
			expectedClosedCount:      0,
			expectedClosedErrorCount: 1,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		assertCounterValue(t, test.description, "connectionsClosed", m.connectionsClosed,
			test.expectedClosedCount)
		assertCounterValue(t, test.description, "connectionsOpened", m.connectionsOpened,
			test.expectedOpenedCount)
		assertCounterVecValue(t, test.description, "connectionsError[type=accept]", m.connectionsError,
			test.expectedOpenedErrorCount, prometheus.Labels{
				connectionErrorLabel: connectionAcceptError,
			})
		assertCounterVecValue(t, test.description, "connectionsError[type=close]", m.connectionsError,
			test.expectedClosedErrorCount, prometheus.Labels{
				connectionErrorLabel: connectionCloseError,
			})
	}
}

func TestRequestMetric(t *testing.T) {
	m := createMetricsForTesting()
	requestType := metrics.ReqTypeORTB2Web
	requestStatus := metrics.RequestStatusBlacklisted

	m.RecordRequest(metrics.Labels{
		RType:         requestType,
		RequestStatus: requestStatus,
	})

	expectedCount := float64(1)
	assertCounterVecValue(t, "", "requests", m.requests,
		expectedCount,
		prometheus.Labels{
			requestTypeLabel:   string(requestType),
			requestStatusLabel: string(requestStatus),
		})
}

func TestDebugRequestMetric(t *testing.T) {
	testCases := []struct {
		description                      string
		givenDebugEnabledFlag            bool
		givenAccountDebugMetricsDisabled bool
		expectedAccountDebugCount        float64
		expectedDebugCount               float64
	}{
		{
			description:                      "Debug is enabled and account debug is enabled, both metrics should be updated",
			givenDebugEnabledFlag:            true,
			givenAccountDebugMetricsDisabled: false,
			expectedDebugCount:               1,
			expectedAccountDebugCount:        1,
		},
		{
			description:                      "Debug and account debug are disabled, niether metrics should be updated",
			givenDebugEnabledFlag:            false,
			givenAccountDebugMetricsDisabled: true,
			expectedDebugCount:               0,
			expectedAccountDebugCount:        0,
		},
		{
			description:                      "Debug is enabled but account debug is disabled, only non-account debug count should increment",
			givenDebugEnabledFlag:            true,
			givenAccountDebugMetricsDisabled: true,
			expectedDebugCount:               1,
			expectedAccountDebugCount:        0,
		},
		{
			description:                      "Debug is disabled and account debug is enabled, niether metrics should increment",
			givenDebugEnabledFlag:            false,
			givenAccountDebugMetricsDisabled: false,
			expectedDebugCount:               0,
			expectedAccountDebugCount:        0,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()
		m.metricsDisabled.AccountDebug = test.givenAccountDebugMetricsDisabled
		m.RecordDebugRequest(test.givenDebugEnabledFlag, "acct-id")

		assertCounterVecValue(t, "", "account debug requests", m.accountDebugRequests, test.expectedAccountDebugCount, prometheus.Labels{accountLabel: "acct-id"})
		assertCounterValue(t, "", "debug requests", m.debugRequests, test.expectedDebugCount)
	}
}

func TestBidValidationCreativeSizeMetric(t *testing.T) {
	testCases := []struct {
		description                        string
		givenDebugEnabledFlag              bool
		givenAccountAdapterMetricsDisabled bool
		expectedAdapterCount               float64
		expectedAccountCount               float64
	}{
		{
			description:                        "Account Metric isn't disabled, so both metrics should be incremented",
			givenAccountAdapterMetricsDisabled: false,
			expectedAdapterCount:               1,
			expectedAccountCount:               1,
		},
		{
			description:                        "Account Metric is disabled, so only adapter metric should be incremented",
			givenAccountAdapterMetricsDisabled: true,
			expectedAdapterCount:               1,
			expectedAccountCount:               0,
		},
	}
	adapterName := openrtb_ext.BidderName("AnyName")
	lowerCasedAdapterName := "anyname"
	for _, test := range testCases {
		m := createMetricsForTesting()
		m.metricsDisabled.AccountAdapterDetails = test.givenAccountAdapterMetricsDisabled
		m.RecordBidValidationCreativeSizeError(adapterName, "acct-id")
		m.RecordBidValidationCreativeSizeWarn(adapterName, "acct-id")

		assertCounterVecValue(t, "", "account bid validation", m.accountBidResponseValidationSizeError, test.expectedAccountCount, prometheus.Labels{accountLabel: "acct-id", successLabel: successLabel})
		assertCounterVecValue(t, "", "adapter bid validation", m.adapterBidResponseValidationSizeError, test.expectedAdapterCount, prometheus.Labels{adapterLabel: lowerCasedAdapterName, successLabel: successLabel})

		assertCounterVecValue(t, "", "account bid validation", m.accountBidResponseValidationSizeWarn, test.expectedAccountCount, prometheus.Labels{accountLabel: "acct-id", successLabel: successLabel})
		assertCounterVecValue(t, "", "adapter bid validation", m.adapterBidResponseValidationSizeWarn, test.expectedAdapterCount, prometheus.Labels{adapterLabel: lowerCasedAdapterName, successLabel: successLabel})
	}
}

func TestBidValidationSecureMarkupMetric(t *testing.T) {
	testCases := []struct {
		description                        string
		givenDebugEnabledFlag              bool
		givenAccountAdapterMetricsDisabled bool
		expectedAdapterCount               float64
		expectedAccountCount               float64
	}{
		{
			description:                        "Account Metric isn't disabled, so both metrics should be incremented",
			givenAccountAdapterMetricsDisabled: false,
			expectedAdapterCount:               1,
			expectedAccountCount:               1,
		},
		{
			description:                        "Account Metric is disabled, so only adapter metric should be incremented",
			givenAccountAdapterMetricsDisabled: true,
			expectedAdapterCount:               1,
			expectedAccountCount:               0,
		},
	}

	adapterName := openrtb_ext.BidderName("AnyName")
	lowerCasedAdapterName := "anyname"
	for _, test := range testCases {
		m := createMetricsForTesting()
		m.metricsDisabled.AccountAdapterDetails = test.givenAccountAdapterMetricsDisabled
		m.RecordBidValidationSecureMarkupError(adapterName, "acct-id")
		m.RecordBidValidationSecureMarkupWarn(adapterName, "acct-id")

		assertCounterVecValue(t, "", "Account Secure Markup Error", m.accountBidResponseSecureMarkupError, test.expectedAccountCount, prometheus.Labels{accountLabel: "acct-id", successLabel: successLabel})
		assertCounterVecValue(t, "", "Adapter Secure Markup Error", m.adapterBidResponseSecureMarkupError, test.expectedAdapterCount, prometheus.Labels{adapterLabel: lowerCasedAdapterName, successLabel: successLabel})

		assertCounterVecValue(t, "", "Account Secure Markup Warn", m.accountBidResponseSecureMarkupWarn, test.expectedAccountCount, prometheus.Labels{accountLabel: "acct-id", successLabel: successLabel})
		assertCounterVecValue(t, "", "Adapter Secure Markup Warn", m.adapterBidResponseSecureMarkupWarn, test.expectedAdapterCount, prometheus.Labels{adapterLabel: lowerCasedAdapterName, successLabel: successLabel})
	}
}

func TestRequestMetricWithoutCookie(t *testing.T) {
	requestType := metrics.ReqTypeORTB2Web
	performTest := func(m *Metrics, cookieFlag metrics.CookieFlag) {
		m.RecordRequest(metrics.Labels{
			RType:         requestType,
			RequestStatus: metrics.RequestStatusBlacklisted,
			CookieFlag:    cookieFlag,
		})
	}

	testCases := []struct {
		description   string
		testCase      func(m *Metrics)
		cookieFlag    metrics.CookieFlag
		expectedCount float64
	}{
		{
			description: "Yes",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagYes)
			},
			expectedCount: 0,
		},
		{
			description: "No",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagNo)
			},
			expectedCount: 1,
		},
		{
			description: "Unknown",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagUnknown)
			},
			expectedCount: 0,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		assertCounterVecValue(t, test.description, "requestsWithoutCookie", m.requestsWithoutCookie,
			test.expectedCount,
			prometheus.Labels{
				requestTypeLabel: string(requestType),
			})
	}
}

func TestAccountMetric(t *testing.T) {
	knownPubID := "knownPublisher"
	performTest := func(m *Metrics, pubID string) {
		m.RecordRequest(metrics.Labels{
			RType:         metrics.ReqTypeORTB2Web,
			RequestStatus: metrics.RequestStatusBlacklisted,
			PubID:         pubID,
		})
	}

	testCases := []struct {
		description   string
		testCase      func(m *Metrics)
		expectedCount float64
	}{
		{
			description: "Known",
			testCase: func(m *Metrics) {
				performTest(m, knownPubID)
			},
			expectedCount: 1,
		},
		{
			description: "Unknown",
			testCase: func(m *Metrics) {
				performTest(m, metrics.PublisherUnknown)
			},
			expectedCount: 0,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		assertCounterVecValue(t, test.description, "accountRequests", m.accountRequests,
			test.expectedCount,
			prometheus.Labels{
				accountLabel: knownPubID,
			})
	}
}

func TestImpressionsMetric(t *testing.T) {
	performTest := func(m *Metrics, isBanner, isVideo, isAudio, isNative bool) {
		m.RecordImps(metrics.ImpLabels{
			BannerImps: isBanner,
			VideoImps:  isVideo,
			AudioImps:  isAudio,
			NativeImps: isNative,
		})
	}

	testCases := []struct {
		description         string
		testCase            func(m *Metrics)
		expectedBannerCount float64
		expectedVideoCount  float64
		expectedAudioCount  float64
		expectedNativeCount float64
	}{
		{
			description: "Banner Only",
			testCase: func(m *Metrics) {
				performTest(m, true, false, false, false)
			},
			expectedBannerCount: 1,
			expectedVideoCount:  0,
			expectedAudioCount:  0,
			expectedNativeCount: 0,
		},
		{
			description: "Video Only",
			testCase: func(m *Metrics) {
				performTest(m, false, true, false, false)
			},
			expectedBannerCount: 0,
			expectedVideoCount:  1,
			expectedAudioCount:  0,
			expectedNativeCount: 0,
		},
		{
			description: "Audio Only",
			testCase: func(m *Metrics) {
				performTest(m, false, false, true, false)
			},
			expectedBannerCount: 0,
			expectedVideoCount:  0,
			expectedAudioCount:  1,
			expectedNativeCount: 0,
		},
		{
			description: "Native Only",
			testCase: func(m *Metrics) {
				performTest(m, false, false, false, true)
			},
			expectedBannerCount: 0,
			expectedVideoCount:  0,
			expectedAudioCount:  0,
			expectedNativeCount: 1,
		},
		{
			description: "Multiple Types",
			testCase: func(m *Metrics) {
				performTest(m, true, false, false, true)
			},
			expectedBannerCount: 1,
			expectedVideoCount:  0,
			expectedAudioCount:  0,
			expectedNativeCount: 1,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		var bannerCount float64
		var videoCount float64
		var audioCount float64
		var nativeCount float64
		processMetrics(m.impressions, func(m dto.Metric) {
			value := m.GetCounter().GetValue()
			for _, label := range m.GetLabel() {
				if label.GetValue() == "true" {
					switch label.GetName() {
					case isBannerLabel:
						bannerCount += value
					case isVideoLabel:
						videoCount += value
					case isAudioLabel:
						audioCount += value
					case isNativeLabel:
						nativeCount += value
					}
				}
			}
		})
		assert.Equal(t, test.expectedBannerCount, bannerCount, test.description+":banner")
		assert.Equal(t, test.expectedVideoCount, videoCount, test.description+":video")
		assert.Equal(t, test.expectedAudioCount, audioCount, test.description+":audio")
		assert.Equal(t, test.expectedNativeCount, nativeCount, test.description+":native")
	}
}

func TestRequestTimeMetric(t *testing.T) {
	requestType := metrics.ReqTypeORTB2Web
	performTest := func(m *Metrics, requestStatus metrics.RequestStatus, timeInMs float64) {
		m.RecordRequestTime(metrics.Labels{
			RType:         requestType,
			RequestStatus: requestStatus,
		}, time.Duration(timeInMs)*time.Millisecond)
	}

	testCases := []struct {
		description   string
		testCase      func(m *Metrics)
		expectedCount uint64
		expectedSum   float64
	}{
		{
			description: "Success",
			testCase: func(m *Metrics) {
				performTest(m, metrics.RequestStatusOK, 500)
			},
			expectedCount: 1,
			expectedSum:   0.5,
		},
		{
			description: "Error",
			testCase: func(m *Metrics) {
				performTest(m, metrics.RequestStatusErr, 500)
			},
			expectedCount: 0,
			expectedSum:   0,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		result := getHistogramFromHistogramVec(m.requestsTimer, requestTypeLabel, string(requestType))
		assertHistogram(t, test.description, result, test.expectedCount, test.expectedSum)
	}
}

func TestRecordOverheadTimeMetric(t *testing.T) {
	testCases := []struct {
		description   string
		overheadType  metrics.OverheadType
		timeInMs      float64
		expectedCount uint64
		expectedSum   float64
	}{
		{
			description:   "record-pre-bidder-overhead-time-1",
			overheadType:  metrics.PreBidder,
			timeInMs:      500,
			expectedCount: 1,
			expectedSum:   0.5,
		},
		{
			description:   "record-pre-bidder-overhead-time-2",
			overheadType:  metrics.PreBidder,
			timeInMs:      400,
			expectedCount: 2,
			expectedSum:   0.9,
		},
		{
			description:   "record-auction-response-overhead-time",
			overheadType:  metrics.MakeAuctionResponse,
			timeInMs:      500,
			expectedCount: 1,
			expectedSum:   0.5,
		},
		{
			description:   "record-make-bidder-requests-overhead-time",
			overheadType:  metrics.MakeBidderRequests,
			timeInMs:      500,
			expectedCount: 1,
			expectedSum:   0.5,
		},
	}

	metric := createMetricsForTesting()
	for _, test := range testCases {
		metric.RecordOverheadTime(test.overheadType, time.Duration(test.timeInMs)*time.Millisecond)
		resultingHistogram := getHistogramFromHistogramVec(metric.overheadTimer, overheadTypeLabel, test.overheadType.String())
		assertHistogram(t, test.description, resultingHistogram, test.expectedCount, test.expectedSum)
	}
}

func TestRecordStoredDataFetchTime(t *testing.T) {
	tests := []struct {
		description string
		dataType    metrics.StoredDataType
		fetchType   metrics.StoredDataFetchType
	}{
		{
			description: "Update stored account histogram with all label",
			dataType:    metrics.AccountDataType,
			fetchType:   metrics.FetchAll,
		},
		{
			description: "Update stored AMP histogram with all label",
			dataType:    metrics.AMPDataType,
			fetchType:   metrics.FetchAll,
		},
		{
			description: "Update stored category histogram with all label",
			dataType:    metrics.CategoryDataType,
			fetchType:   metrics.FetchAll,
		},
		{
			description: "Update stored request histogram with all label",
			dataType:    metrics.RequestDataType,
			fetchType:   metrics.FetchAll,
		},
		{
			description: "Update stored video histogram with all label",
			dataType:    metrics.VideoDataType,
			fetchType:   metrics.FetchAll,
		},
		{
			description: "Update stored account histogram with delta label",
			dataType:    metrics.AccountDataType,
			fetchType:   metrics.FetchDelta,
		},
		{
			description: "Update stored AMP histogram with delta label",
			dataType:    metrics.AMPDataType,
			fetchType:   metrics.FetchDelta,
		},
		{
			description: "Update stored category histogram with delta label",
			dataType:    metrics.CategoryDataType,
			fetchType:   metrics.FetchDelta,
		},
		{
			description: "Update stored request histogram with delta label",
			dataType:    metrics.RequestDataType,
			fetchType:   metrics.FetchDelta,
		},
		{
			description: "Update stored video histogram with delta label",
			dataType:    metrics.VideoDataType,
			fetchType:   metrics.FetchDelta,
		},
		{
			description: "Update stored responses histogram with delta label",
			dataType:    metrics.ResponseDataType,
			fetchType:   metrics.FetchDelta,
		},
	}

	for _, tt := range tests {
		m := createMetricsForTesting()

		fetchTime := time.Duration(0.5 * float64(time.Second))
		m.RecordStoredDataFetchTime(metrics.StoredDataLabels{
			DataType:      tt.dataType,
			DataFetchType: tt.fetchType,
		}, fetchTime)

		var metricsTimer *prometheus.HistogramVec
		switch tt.dataType {
		case metrics.AccountDataType:
			metricsTimer = m.storedAccountFetchTimer
		case metrics.AMPDataType:
			metricsTimer = m.storedAMPFetchTimer
		case metrics.CategoryDataType:
			metricsTimer = m.storedCategoryFetchTimer
		case metrics.RequestDataType:
			metricsTimer = m.storedRequestFetchTimer
		case metrics.VideoDataType:
			metricsTimer = m.storedVideoFetchTimer
		case metrics.ResponseDataType:
			metricsTimer = m.storedResponsesFetchTimer
		}

		result := getHistogramFromHistogramVec(
			metricsTimer,
			storedDataFetchTypeLabel,
			string(tt.fetchType))
		assertHistogram(t, tt.description, result, 1, 0.5)
	}
}

func TestRecordStoredDataError(t *testing.T) {
	tests := []struct {
		description string
		dataType    metrics.StoredDataType
		errorType   metrics.StoredDataError
		metricName  string
	}{
		{
			description: "Update stored_account_errors counter with network label",
			dataType:    metrics.AccountDataType,
			errorType:   metrics.StoredDataErrorNetwork,
			metricName:  "stored_account_errors",
		},
		{
			description: "Update stored_amp_errors counter with network label",
			dataType:    metrics.AMPDataType,
			errorType:   metrics.StoredDataErrorNetwork,
			metricName:  "stored_amp_errors",
		},
		{
			description: "Update stored_category_errors counter with network label",
			dataType:    metrics.CategoryDataType,
			errorType:   metrics.StoredDataErrorNetwork,
			metricName:  "stored_category_errors",
		},
		{
			description: "Update stored_request_errors counter with network label",
			dataType:    metrics.RequestDataType,
			errorType:   metrics.StoredDataErrorNetwork,
			metricName:  "stored_request_errors",
		},
		{
			description: "Update stored_video_errors counter with network label",
			dataType:    metrics.VideoDataType,
			errorType:   metrics.StoredDataErrorNetwork,
			metricName:  "stored_video_errors",
		},
		{
			description: "Update stored_account_errors counter with undefined label",
			dataType:    metrics.AccountDataType,
			errorType:   metrics.StoredDataErrorUndefined,
			metricName:  "stored_account_errors",
		},
		{
			description: "Update stored_amp_errors counter with undefined label",
			dataType:    metrics.AMPDataType,
			errorType:   metrics.StoredDataErrorUndefined,
			metricName:  "stored_amp_errors",
		},
		{
			description: "Update stored_category_errors counter with undefined label",
			dataType:    metrics.CategoryDataType,
			errorType:   metrics.StoredDataErrorUndefined,
			metricName:  "stored_category_errors",
		},
		{
			description: "Update stored_request_errors counter with undefined label",
			dataType:    metrics.RequestDataType,
			errorType:   metrics.StoredDataErrorUndefined,
			metricName:  "stored_request_errors",
		},
		{
			description: "Update stored_video_errors counter with undefined label",
			dataType:    metrics.VideoDataType,
			errorType:   metrics.StoredDataErrorUndefined,
			metricName:  "stored_video_errors",
		},
		{
			description: "Update stored_response_errors counter with network label",
			dataType:    metrics.ResponseDataType,
			errorType:   metrics.StoredDataErrorNetwork,
			metricName:  "stored_response_errors",
		},
	}

	for _, tt := range tests {
		m := createMetricsForTesting()
		m.RecordStoredDataError(metrics.StoredDataLabels{
			DataType: tt.dataType,
			Error:    tt.errorType,
		})

		var metricsCounter *prometheus.CounterVec
		switch tt.dataType {
		case metrics.AccountDataType:
			metricsCounter = m.storedAccountErrors
		case metrics.AMPDataType:
			metricsCounter = m.storedAMPErrors
		case metrics.CategoryDataType:
			metricsCounter = m.storedCategoryErrors
		case metrics.RequestDataType:
			metricsCounter = m.storedRequestErrors
		case metrics.VideoDataType:
			metricsCounter = m.storedVideoErrors
		case metrics.ResponseDataType:
			metricsCounter = m.storedResponsesErrors
		}

		assertCounterVecValue(t, tt.description, tt.metricName, metricsCounter,
			1,
			prometheus.Labels{
				storedDataErrorLabel: string(tt.errorType),
			})
	}
}

func TestAdapterBidReceivedMetric(t *testing.T) {
	adapterName := openrtb_ext.BidderName("anyName")
	lowerCasedAdapterName := "anyname"
	performTest := func(m *Metrics, hasAdm bool) {
		labels := metrics.AdapterLabels{
			Adapter: adapterName,
		}
		bidType := openrtb_ext.BidTypeBanner
		m.RecordAdapterBidReceived(labels, bidType, hasAdm)
	}

	testCases := []struct {
		description       string
		testCase          func(m *Metrics)
		expectedAdmCount  float64
		expectedNurlCount float64
	}{
		{
			description: "AdM",
			testCase: func(m *Metrics) {
				performTest(m, true)
			},
			expectedAdmCount:  1,
			expectedNurlCount: 0,
		},
		{
			description: "Nurl",
			testCase: func(m *Metrics) {
				performTest(m, false)
			},
			expectedAdmCount:  0,
			expectedNurlCount: 1,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		assertCounterVecValue(t, test.description, "adapterBids[adm]", m.adapterBids,
			test.expectedAdmCount,
			prometheus.Labels{
				adapterLabel:        lowerCasedAdapterName,
				markupDeliveryLabel: markupDeliveryAdm,
			})
		assertCounterVecValue(t, test.description, "adapterBids[nurl]", m.adapterBids,
			test.expectedNurlCount,
			prometheus.Labels{
				adapterLabel:        lowerCasedAdapterName,
				markupDeliveryLabel: markupDeliveryNurl,
			})
	}
}

func TestRecordAdapterPriceMetric(t *testing.T) {
	m := createMetricsForTesting()
	adapterName := "anyName"
	lowerCasedAdapterName := "anyname"
	cpm := float64(42)

	m.RecordAdapterPrice(metrics.AdapterLabels{
		Adapter: openrtb_ext.BidderName(adapterName),
	}, cpm)

	expectedCount := uint64(1)
	expectedSum := cpm
	result := getHistogramFromHistogramVec(m.adapterPrices, adapterLabel, lowerCasedAdapterName)
	assertHistogram(t, "adapterPrices", result, expectedCount, expectedSum)
}

func TestAdapterRequestMetrics(t *testing.T) {
	adapterName := "anyName"
	lowerCasedAdapterName := "anyname"
	performTest := func(m *Metrics, cookieFlag metrics.CookieFlag, adapterBids metrics.AdapterBid) {
		labels := metrics.AdapterLabels{
			Adapter:     openrtb_ext.BidderName(adapterName),
			CookieFlag:  cookieFlag,
			AdapterBids: adapterBids,
		}
		m.RecordAdapterRequest(labels)
	}

	testCases := []struct {
		description                string
		testCase                   func(m *Metrics)
		expectedCount              float64
		expectedCookieNoCount      float64
		expectedCookieYesCount     float64
		expectedCookieUnknownCount float64
		expectedHasBidsCount       float64
	}{
		{
			description: "No Cookie & No Bids",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagNo, metrics.AdapterBidNone)
			},
			expectedCount:              1,
			expectedCookieNoCount:      1,
			expectedCookieYesCount:     0,
			expectedCookieUnknownCount: 0,
			expectedHasBidsCount:       0,
		},
		{
			description: "Unknown Cookie & No Bids",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagUnknown, metrics.AdapterBidNone)
			},
			expectedCount:              1,
			expectedCookieNoCount:      0,
			expectedCookieYesCount:     0,
			expectedCookieUnknownCount: 1,
			expectedHasBidsCount:       0,
		},
		{
			description: "Has Cookie & No Bids",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagYes, metrics.AdapterBidNone)
			},
			expectedCount:              1,
			expectedCookieNoCount:      0,
			expectedCookieYesCount:     1,
			expectedCookieUnknownCount: 0,
			expectedHasBidsCount:       0,
		},
		{
			description: "No Cookie & Bids Present",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagNo, metrics.AdapterBidPresent)
			},
			expectedCount:              1,
			expectedCookieNoCount:      1,
			expectedCookieYesCount:     0,
			expectedCookieUnknownCount: 0,
			expectedHasBidsCount:       1,
		},
		{
			description: "Unknown Cookie & Bids Present",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagUnknown, metrics.AdapterBidPresent)
			},
			expectedCount:              1,
			expectedCookieNoCount:      0,
			expectedCookieYesCount:     0,
			expectedCookieUnknownCount: 1,
			expectedHasBidsCount:       1,
		},
		{
			description: "Has Cookie & Bids Present",
			testCase: func(m *Metrics) {
				performTest(m, metrics.CookieFlagYes, metrics.AdapterBidPresent)
			},
			expectedCount:              1,
			expectedCookieNoCount:      0,
			expectedCookieYesCount:     1,
			expectedCookieUnknownCount: 0,
			expectedHasBidsCount:       1,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		var totalCount float64
		var totalCookieNoCount float64
		var totalCookieYesCount float64
		var totalCookieUnknownCount float64
		var totalHasBidsCount float64
		processMetrics(m.adapterRequests, func(m dto.Metric) {
			isMetricForAdapter := false
			for _, label := range m.GetLabel() {
				if label.GetName() == adapterLabel && label.GetValue() == lowerCasedAdapterName {
					isMetricForAdapter = true
				}
			}

			if isMetricForAdapter {
				value := m.GetCounter().GetValue()
				totalCount += value
				for _, label := range m.GetLabel() {

					if label.GetName() == hasBidsLabel && label.GetValue() == "true" {
						totalHasBidsCount += value
					}

					if label.GetName() == cookieLabel {
						switch label.GetValue() {
						case string(metrics.CookieFlagNo):
							totalCookieNoCount += value
						case string(metrics.CookieFlagYes):
							totalCookieYesCount += value
						case string(metrics.CookieFlagUnknown):
							totalCookieUnknownCount += value
						}
					}
				}
			}
		})
		assert.Equal(t, test.expectedCount, totalCount, test.description+":total")
		assert.Equal(t, test.expectedCookieNoCount, totalCookieNoCount, test.description+":cookie=no")
		assert.Equal(t, test.expectedCookieYesCount, totalCookieYesCount, test.description+":cookie=yes")
		assert.Equal(t, test.expectedCookieUnknownCount, totalCookieUnknownCount, test.description+":cookie=unknown")
		assert.Equal(t, test.expectedHasBidsCount, totalHasBidsCount, test.description+":hasBids")
	}
}

func TestAdapterRequestErrorMetrics(t *testing.T) {
	adapterName := "anyName"
	lowerCasedAdapterName := "anyname"
	performTest := func(m *Metrics, adapterErrors map[metrics.AdapterError]struct{}) {
		labels := metrics.AdapterLabels{
			Adapter:       openrtb_ext.BidderName(adapterName),
			AdapterErrors: adapterErrors,
			CookieFlag:    metrics.CookieFlagUnknown,
			AdapterBids:   metrics.AdapterBidPresent,
		}
		m.RecordAdapterRequest(labels)
	}

	testCases := []struct {
		description                 string
		testCase                    func(m *Metrics)
		expectedErrorsCount         float64
		expectedBadInputErrorsCount float64
	}{
		{
			description: "No Errors",
			testCase: func(m *Metrics) {
				performTest(m, nil)
			},
			expectedErrorsCount:         0,
			expectedBadInputErrorsCount: 0,
		},
		{
			description: "Bad Input Error",
			testCase: func(m *Metrics) {
				performTest(m, map[metrics.AdapterError]struct{}{
					metrics.AdapterErrorBadInput: {},
				})
			},
			expectedErrorsCount:         1,
			expectedBadInputErrorsCount: 1,
		},
		{
			description: "Other Error",
			testCase: func(m *Metrics) {
				performTest(m, map[metrics.AdapterError]struct{}{
					metrics.AdapterErrorBadServerResponse: {},
				})
			},
			expectedErrorsCount:         1,
			expectedBadInputErrorsCount: 0,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		var errorsCount float64
		var badInputErrorsCount float64
		processMetrics(m.adapterErrors, func(m dto.Metric) {
			isMetricForAdapter := false
			for _, label := range m.GetLabel() {
				if label.GetName() == adapterLabel && label.GetValue() == lowerCasedAdapterName {
					isMetricForAdapter = true
				}
			}

			if isMetricForAdapter {
				value := m.GetCounter().GetValue()
				errorsCount += value
				for _, label := range m.GetLabel() {
					if label.GetName() == adapterErrorLabel && label.GetValue() == string(metrics.AdapterErrorBadInput) {
						badInputErrorsCount += value
					}
				}
			}
		})
		assert.Equal(t, test.expectedErrorsCount, errorsCount, test.description+":errors")
		assert.Equal(t, test.expectedBadInputErrorsCount, badInputErrorsCount, test.description+":badInputErrors")
	}
}

func TestAdapterTimeMetric(t *testing.T) {
	adapterName := "anyName"
	lowerCasedAdapterName := "anyname"
	performTest := func(m *Metrics, timeInMs float64, adapterErrors map[metrics.AdapterError]struct{}) {
		m.RecordAdapterTime(metrics.AdapterLabels{
			Adapter:       openrtb_ext.BidderName(adapterName),
			AdapterErrors: adapterErrors,
		}, time.Duration(timeInMs)*time.Millisecond)
	}

	testCases := []struct {
		description   string
		testCase      func(m *Metrics)
		expectedCount uint64
		expectedSum   float64
	}{
		{
			description: "Success",
			testCase: func(m *Metrics) {
				performTest(m, 500, map[metrics.AdapterError]struct{}{})
			},
			expectedCount: 1,
			expectedSum:   0.5,
		},
		{
			description: "Error",
			testCase: func(m *Metrics) {
				performTest(m, 500, map[metrics.AdapterError]struct{}{
					metrics.AdapterErrorTimeout: {},
				})
			},
			expectedCount: 0,
			expectedSum:   0,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()

		test.testCase(m)

		result := getHistogramFromHistogramVec(m.adapterRequestsTimer, adapterLabel, lowerCasedAdapterName)
		assertHistogram(t, test.description, result, test.expectedCount, test.expectedSum)
	}
}

func TestAdapterPanicMetric(t *testing.T) {
	m := createMetricsForTesting()
	adapterName := openrtb_ext.BidderName("anyName")
	lowerCasedAdapterName := "anyname"
	m.RecordAdapterPanic(metrics.AdapterLabels{
		Adapter: adapterName,
	})

	expectedCount := float64(1)
	assertCounterVecValue(t, "", "adapterPanics", m.adapterPanics,
		expectedCount,
		prometheus.Labels{
			adapterLabel: lowerCasedAdapterName,
		})
}

func TestStoredReqCacheResultMetric(t *testing.T) {
	m := createMetricsForTesting()

	hitCount := 42
	missCount := 108
	m.RecordStoredReqCacheResult(metrics.CacheHit, hitCount)
	m.RecordStoredReqCacheResult(metrics.CacheMiss, missCount)

	assertCounterVecValue(t, "", "storedRequestCacheResult:hit", m.storedRequestCacheResult,
		float64(hitCount),
		prometheus.Labels{
			cacheResultLabel: string(metrics.CacheHit),
		})
	assertCounterVecValue(t, "", "storedRequestCacheResult:miss", m.storedRequestCacheResult,
		float64(missCount),
		prometheus.Labels{
			cacheResultLabel: string(metrics.CacheMiss),
		})
}

func TestStoredImpCacheResultMetric(t *testing.T) {
	m := createMetricsForTesting()

	hitCount := 41
	missCount := 107
	m.RecordStoredImpCacheResult(metrics.CacheHit, hitCount)
	m.RecordStoredImpCacheResult(metrics.CacheMiss, missCount)

	assertCounterVecValue(t, "", "storedImpressionsCacheResult:hit", m.storedImpressionsCacheResult,
		float64(hitCount),
		prometheus.Labels{
			cacheResultLabel: string(metrics.CacheHit),
		})
	assertCounterVecValue(t, "", "storedImpressionsCacheResult:miss", m.storedImpressionsCacheResult,
		float64(missCount),
		prometheus.Labels{
			cacheResultLabel: string(metrics.CacheMiss),
		})
}

func TestAccountCacheResultMetric(t *testing.T) {
	m := createMetricsForTesting()

	hitCount := 37
	missCount := 92
	m.RecordAccountCacheResult(metrics.CacheHit, hitCount)
	m.RecordAccountCacheResult(metrics.CacheMiss, missCount)

	assertCounterVecValue(t, "", "accountCacheResult:hit", m.accountCacheResult,
		float64(hitCount),
		prometheus.Labels{
			cacheResultLabel: string(metrics.CacheHit),
		})
	assertCounterVecValue(t, "", "accountCacheResult:miss", m.accountCacheResult,
		float64(missCount),
		prometheus.Labels{
			cacheResultLabel: string(metrics.CacheMiss),
		})
}

func TestCookieSyncMetric(t *testing.T) {
	tests := []struct {
		status metrics.CookieSyncStatus
		label  string
	}{
		{
			status: metrics.CookieSyncOK,
			label:  "ok",
		},
		{
			status: metrics.CookieSyncBadRequest,
			label:  "bad_request",
		},
		{
			status: metrics.CookieSyncOptOut,
			label:  "opt_out",
		},
		{
			status: metrics.CookieSyncGDPRHostCookieBlocked,
			label:  "gdpr_blocked_host_cookie",
		},
	}

	for _, test := range tests {
		m := createMetricsForTesting()

		m.RecordCookieSync(test.status)

		assertCounterVecValue(t, "", "cookie_sync_requests:"+test.label, m.cookieSync,
			float64(1),
			prometheus.Labels{
				statusLabel: string(test.status),
			})
	}
}

func TestRecordSyncerRequestMetric(t *testing.T) {
	key := "anyKey"

	tests := []struct {
		status metrics.SyncerCookieSyncStatus
		label  string
	}{
		{
			status: metrics.SyncerCookieSyncOK,
			label:  "ok",
		},
		{
			status: metrics.SyncerCookieSyncPrivacyBlocked,
			label:  "privacy_blocked",
		},
		{
			status: metrics.SyncerCookieSyncAlreadySynced,
			label:  "already_synced",
		},
		{
			status: metrics.SyncerCookieSyncTypeNotSupported,
			label:  "type_not_supported",
		},
	}

	for _, test := range tests {
		m := createMetricsForTesting()

		m.RecordSyncerRequest(key, test.status)

		assertCounterVecValue(t, "", "syncer_requests:"+test.label, m.syncerRequests,
			float64(1),
			prometheus.Labels{
				syncerLabel: key,
				statusLabel: string(test.status),
			})
	}
}

func TestSetUidMetric(t *testing.T) {
	tests := []struct {
		status metrics.SetUidStatus
		label  string
	}{
		{
			status: metrics.SetUidOK,
			label:  "ok",
		},
		{
			status: metrics.SetUidBadRequest,
			label:  "bad_request",
		},
		{
			status: metrics.SetUidOptOut,
			label:  "opt_out",
		},
		{
			status: metrics.SetUidGDPRHostCookieBlocked,
			label:  "gdpr_blocked_host_cookie",
		},
		{
			status: metrics.SetUidSyncerUnknown,
			label:  "syncer_unknown",
		},
	}

	for _, test := range tests {
		m := createMetricsForTesting()

		m.RecordSetUid(test.status)

		assertCounterVecValue(t, "", "setuid_requests:"+test.label, m.setUid,
			float64(1),
			prometheus.Labels{
				statusLabel: string(test.status),
			})
	}
}

func TestRecordSyncerSetMetric(t *testing.T) {
	key := "anyKey"

	tests := []struct {
		status metrics.SyncerSetUidStatus
		label  string
	}{
		{
			status: metrics.SyncerSetUidOK,
			label:  "ok",
		},
		{
			status: metrics.SyncerSetUidCleared,
			label:  "cleared",
		},
	}

	for _, test := range tests {
		m := createMetricsForTesting()

		m.RecordSyncerSet(key, test.status)

		assertCounterVecValue(t, "", "syncer_sets:"+test.label, m.syncerSets,
			float64(1),
			prometheus.Labels{
				syncerLabel: key,
				statusLabel: string(test.status),
			})
	}
}

func TestPrebidCacheRequestTimeMetric(t *testing.T) {
	m := createMetricsForTesting()

	m.RecordPrebidCacheRequestTime(true, time.Duration(100)*time.Millisecond)
	m.RecordPrebidCacheRequestTime(false, time.Duration(200)*time.Millisecond)

	successExpectedCount := uint64(1)
	successExpectedSum := float64(0.1)
	successResult := getHistogramFromHistogramVec(m.prebidCacheWriteTimer, successLabel, "true")
	assertHistogram(t, "Success", successResult, successExpectedCount, successExpectedSum)

	errorExpectedCount := uint64(1)
	errorExpectedSum := float64(0.2)
	errorResult := getHistogramFromHistogramVec(m.prebidCacheWriteTimer, successLabel, "false")
	assertHistogram(t, "Error", errorResult, errorExpectedCount, errorExpectedSum)
}

func TestRecordRequestQueueTimeMetric(t *testing.T) {
	performTest := func(m *Metrics, requestStatus bool, requestType metrics.RequestType, timeInSec float64) {
		m.RecordRequestQueueTime(requestStatus, requestType, time.Duration(timeInSec*float64(time.Second)))
	}

	testCases := []struct {
		description   string
		status        string
		testCase      func(m *Metrics)
		expectedCount uint64
		expectedSum   float64
	}{
		{
			description: "Success",
			status:      requestSuccessLabel,
			testCase: func(m *Metrics) {
				performTest(m, true, metrics.ReqTypeVideo, 2)
			},
			expectedCount: 1,
			expectedSum:   2,
		},
		{
			description: "TimeoutError",
			status:      requestRejectLabel,
			testCase: func(m *Metrics) {
				performTest(m, false, metrics.ReqTypeVideo, 50)
			},
			expectedCount: 1,
			expectedSum:   50,
		},
	}

	m := createMetricsForTesting()
	for _, test := range testCases {

		test.testCase(m)

		result := getHistogramFromHistogramVecByTwoKeys(m.requestsQueueTimer, requestTypeLabel, "video", requestStatusLabel, test.status)
		assertHistogram(t, test.description, result, test.expectedCount, test.expectedSum)
	}
}

func TestTimeoutNotifications(t *testing.T) {
	m := createMetricsForTesting()

	m.RecordTimeoutNotice(true)
	m.RecordTimeoutNotice(true)
	m.RecordTimeoutNotice(false)

	assertCounterVecValue(t, "", "timeout_notifications:ok", m.timeoutNotifications,
		float64(2),
		prometheus.Labels{
			successLabel: requestSuccessful,
		})

	assertCounterVecValue(t, "", "timeout_notifications:fail", m.timeoutNotifications,
		float64(1),
		prometheus.Labels{
			successLabel: requestFailed,
		})

}

func TestRecordDNSTime(t *testing.T) {
	type testIn struct {
		dnsLookupDuration time.Duration
	}
	type testOut struct {
		expDuration float64
		expCount    uint64
	}
	testCases := []struct {
		description string
		in          testIn
		out         testOut
	}{
		{
			description: "Five second DNS lookup time",
			in: testIn{
				dnsLookupDuration: time.Second * 5,
			},
			out: testOut{
				expDuration: 5,
				expCount:    1,
			},
		},
		{
			description: "Zero DNS lookup time",
			in:          testIn{},
			out: testOut{
				expDuration: 0,
				expCount:    1,
			},
		},
	}
	for i, test := range testCases {
		pm := createMetricsForTesting()
		pm.RecordDNSTime(test.in.dnsLookupDuration)

		m := dto.Metric{}
		pm.dnsLookupTimer.Write(&m)
		histogram := *m.GetHistogram()

		assert.Equal(t, test.out.expCount, histogram.GetSampleCount(), "[%d] Incorrect number of histogram entries. Desc: %s\n", i, test.description)
		assert.Equal(t, test.out.expDuration, histogram.GetSampleSum(), "[%d] Incorrect number of histogram cumulative values. Desc: %s\n", i, test.description)
	}
}

func TestRecordTLSHandshakeTime(t *testing.T) {
	testCases := []struct {
		description          string
		tLSHandshakeDuration time.Duration
		expectedDuration     float64
		expectedCount        uint64
	}{
		{
			description:          "Five second DNS lookup time",
			tLSHandshakeDuration: time.Second * 5,
			expectedDuration:     5,
			expectedCount:        1,
		},
		{
			description:          "Zero DNS lookup time",
			tLSHandshakeDuration: 0,
			expectedDuration:     0,
			expectedCount:        1,
		},
	}
	for i, test := range testCases {
		pm := createMetricsForTesting()
		pm.RecordTLSHandshakeTime(test.tLSHandshakeDuration)

		m := dto.Metric{}
		pm.tlsHandhakeTimer.Write(&m)
		histogram := *m.GetHistogram()

		assert.Equal(t, test.expectedCount, histogram.GetSampleCount(), "[%d] Incorrect number of histogram entries. Desc: %s\n", i, test.description)
		assert.Equal(t, test.expectedDuration, histogram.GetSampleSum(), "[%d] Incorrect number of histogram cumulative values. Desc: %s\n", i, test.description)
	}
}

func TestRecordBidderServerResponseTime(t *testing.T) {
	testCases := []struct {
		description   string
		timeInMs      float64
		expectedCount uint64
		expectedSum   float64
	}{
		{
			description:   "record-bidder-server-response-time-1",
			timeInMs:      500,
			expectedCount: 1,
			expectedSum:   0.5,
		},
		{
			description:   "record-bidder-server-response-time-2",
			timeInMs:      400,
			expectedCount: 1,
			expectedSum:   0.4,
		},
	}
	for _, test := range testCases {
		pm := createMetricsForTesting()
		pm.RecordBidderServerResponseTime(time.Duration(test.timeInMs) * time.Millisecond)

		m := dto.Metric{}
		pm.bidderServerResponseTimer.Write(&m)
		histogram := *m.GetHistogram()

		assert.Equal(t, test.expectedCount, histogram.GetSampleCount())
		assert.Equal(t, test.expectedSum, histogram.GetSampleSum())
	}
}

func TestRecordAdapterConnections(t *testing.T) {
	adapterName := openrtb_ext.BidderName("Adapter")
	lowerCasedAdapterName := "adapter"

	type testIn struct {
		adapterName   openrtb_ext.BidderName
		connWasReused bool
		connWait      time.Duration
	}

	type testOut struct {
		expectedConnReusedCount  int64
		expectedConnCreatedCount int64
		expectedConnWaitCount    uint64
		expectedConnWaitTime     float64
	}

	testCases := []struct {
		description string
		in          testIn
		out         testOut
	}{
		{
			description: "[1] Successful, new connection created, was idle, has connection wait",
			in: testIn{
				adapterName:   adapterName,
				connWasReused: false,
				connWait:      time.Second * 5,
			},
			out: testOut{
				expectedConnReusedCount:  0,
				expectedConnCreatedCount: 1,
				expectedConnWaitCount:    1,
				expectedConnWaitTime:     5,
			},
		},
		{
			description: "[2] Successful, new connection created, not idle, has connection wait",
			in: testIn{
				adapterName:   adapterName,
				connWasReused: false,
				connWait:      time.Second * 4,
			},
			out: testOut{
				expectedConnReusedCount:  0,
				expectedConnCreatedCount: 1,
				expectedConnWaitCount:    1,
				expectedConnWaitTime:     4,
			},
		},
		{
			description: "[3] Successful, was reused, was idle, no connection wait",
			in: testIn{
				adapterName:   adapterName,
				connWasReused: true,
			},
			out: testOut{
				expectedConnReusedCount:  1,
				expectedConnCreatedCount: 0,
				expectedConnWaitCount:    1,
				expectedConnWaitTime:     0,
			},
		},
		{
			description: "[4] Successful, was reused, not idle, has connection wait",
			in: testIn{
				adapterName:   adapterName,
				connWasReused: true,
				connWait:      time.Second * 5,
			},
			out: testOut{
				expectedConnReusedCount:  1,
				expectedConnCreatedCount: 0,
				expectedConnWaitCount:    1,
				expectedConnWaitTime:     5,
			},
		},
	}

	for i, test := range testCases {
		m := createMetricsForTesting()
		assertDesciptions := []string{
			fmt.Sprintf("[%d] Metric: adapterReusedConnections; Desc: %s", i+1, test.description),
			fmt.Sprintf("[%d] Metric: adapterCreatedConnections; Desc: %s", i+1, test.description),
			fmt.Sprintf("[%d] Metric: adapterWaitConnectionCount; Desc: %s", i+1, test.description),
			fmt.Sprintf("[%d] Metric: adapterWaitConnectionTime; Desc: %s", i+1, test.description),
		}

		m.RecordAdapterConnections(test.in.adapterName, test.in.connWasReused, test.in.connWait)

		// Assert number of reused connections
		assertCounterVecValue(t,
			assertDesciptions[0],
			"adapter_connection_reused",
			m.adapterReusedConnections,
			float64(test.out.expectedConnReusedCount),
			prometheus.Labels{adapterLabel: lowerCasedAdapterName})

		// Assert number of new created connections
		assertCounterVecValue(t,
			assertDesciptions[1],
			"adapter_connection_created",
			m.adapterCreatedConnections,
			float64(test.out.expectedConnCreatedCount),
			prometheus.Labels{adapterLabel: lowerCasedAdapterName})

		// Assert connection wait time
		histogram := getHistogramFromHistogramVec(m.adapterConnectionWaitTime, adapterLabel, lowerCasedAdapterName)
		assert.Equal(t, test.out.expectedConnWaitCount, histogram.GetSampleCount(), assertDesciptions[2])
		assert.Equal(t, test.out.expectedConnWaitTime, histogram.GetSampleSum(), assertDesciptions[3])
	}
}

func TestDisabledMetrics(t *testing.T) {
	prometheusMetrics := NewMetrics(config.PrometheusMetrics{
		Port:      8080,
		Namespace: "prebid",
		Subsystem: "server",
	}, config.DisabledMetrics{
		AdapterBuyerUIDScrubbed:   true,
		AdapterConnectionMetrics:  true,
		AdapterGDPRRequestBlocked: true,
	},
		nil, nil)

	// Assert counter vector was not initialized
	assert.Nil(t, prometheusMetrics.adapterReusedConnections, "Counter Vector adapterReusedConnections should be nil")
	assert.Nil(t, prometheusMetrics.adapterScrubbedBuyerUIDs, "Counter Vector adapterScrubbedBuyerUIDs should be nil")
	assert.Nil(t, prometheusMetrics.adapterCreatedConnections, "Counter Vector adapterCreatedConnections should be nil")
	assert.Nil(t, prometheusMetrics.adapterConnectionWaitTime, "Counter Vector adapterConnectionWaitTime should be nil")
	assert.Nil(t, prometheusMetrics.adapterGDPRBlockedRequests, "Counter Vector adapterGDPRBlockedRequests should be nil")
}

func TestRecordRequestPrivacy(t *testing.T) {
	m := createMetricsForTesting()

	// CCPA
	m.RecordRequestPrivacy(metrics.PrivacyLabels{
		CCPAEnforced: true,
		CCPAProvided: true,
	})
	m.RecordRequestPrivacy(metrics.PrivacyLabels{
		CCPAEnforced: true,
		CCPAProvided: false,
	})
	m.RecordRequestPrivacy(metrics.PrivacyLabels{
		CCPAEnforced: false,
		CCPAProvided: true,
	})

	// COPPA
	m.RecordRequestPrivacy(metrics.PrivacyLabels{
		COPPAEnforced: true,
	})

	// LMT
	m.RecordRequestPrivacy(metrics.PrivacyLabels{
		LMTEnforced: true,
	})

	// GDPR
	m.RecordRequestPrivacy(metrics.PrivacyLabels{
		GDPREnforced:   true,
		GDPRTCFVersion: metrics.TCFVersionErr,
	})
	m.RecordRequestPrivacy(metrics.PrivacyLabels{
		GDPREnforced:   true,
		GDPRTCFVersion: metrics.TCFVersionV2,
	})

	assertCounterVecValue(t, "", "privacy_ccpa", m.privacyCCPA,
		float64(1),
		prometheus.Labels{
			sourceLabel: sourceRequest,
			optOutLabel: "true",
		})

	assertCounterVecValue(t, "", "privacy_ccpa", m.privacyCCPA,
		float64(1),
		prometheus.Labels{
			sourceLabel: sourceRequest,
			optOutLabel: "false",
		})

	assertCounterVecValue(t, "", "privacy_coppa", m.privacyCOPPA,
		float64(1),
		prometheus.Labels{
			sourceLabel: sourceRequest,
		})

	assertCounterVecValue(t, "", "privacy_lmt", m.privacyLMT,
		float64(1),
		prometheus.Labels{
			sourceLabel: sourceRequest,
		})

	assertCounterVecValue(t, "", "privacy_tcf:err", m.privacyTCF,
		float64(1),
		prometheus.Labels{
			sourceLabel:  sourceRequest,
			versionLabel: "err",
		})

	assertCounterVecValue(t, "", "privacy_tcf:v2", m.privacyTCF,
		float64(1),
		prometheus.Labels{
			sourceLabel:  sourceRequest,
			versionLabel: "v2",
		})
}

func assertCounterValue(t *testing.T, description, name string, counter prometheus.Counter, expected float64) {
	m := dto.Metric{}
	counter.Write(&m)
	actual := *m.GetCounter().Value

	assert.Equal(t, expected, actual, description)
}

func assertCounterVecValue(t *testing.T, description, name string, counterVec *prometheus.CounterVec, expected float64, labels prometheus.Labels) {
	counter := counterVec.With(labels)
	assertCounterValue(t, description, name, counter, expected)
}

func getHistogramFromHistogramVec(histogram *prometheus.HistogramVec, labelKey, labelValue string) dto.Histogram {
	var result dto.Histogram
	processMetrics(histogram, func(m dto.Metric) {
		for _, label := range m.GetLabel() {
			if label.GetName() == labelKey && label.GetValue() == labelValue {
				result = *m.GetHistogram()
			}
		}
	})
	return result
}

func getHistogramFromHistogramVecByTwoKeys(histogram *prometheus.HistogramVec, label1Key, label1Value, label2Key, label2Value string) dto.Histogram {
	var result dto.Histogram
	processMetrics(histogram, func(m dto.Metric) {
		for ind, label := range m.GetLabel() {
			if label.GetName() == label1Key && label.GetValue() == label1Value {
				valInd := ind
				if ind == 1 {
					valInd = 0
				} else {
					valInd = 1
				}
				if m.Label[valInd].GetName() == label2Key && m.Label[valInd].GetValue() == label2Value {
					result = *m.GetHistogram()
				}
			}
		}
	})
	return result
}

func processMetrics(collector prometheus.Collector, handler func(m dto.Metric)) {
	collectorChan := make(chan prometheus.Metric)
	go func() {
		collector.Collect(collectorChan)
		close(collectorChan)
	}()

	for metric := range collectorChan {
		dtoMetric := dto.Metric{}
		metric.Write(&dtoMetric)
		handler(dtoMetric)
	}
}

func assertHistogram(t *testing.T, name string, histogram dto.Histogram, expectedCount uint64, expectedSum float64) {
	assert.Equal(t, expectedCount, histogram.GetSampleCount(), name+":count")
	assert.Equal(t, expectedSum, histogram.GetSampleSum(), name+":sum")
}

func TestRecordAdapterBuyerUIDScrubbed(t *testing.T) {

	tests := []struct {
		name          string
		disabled      bool
		expectedCount float64
	}{
		{
			name:          "enabled",
			disabled:      false,
			expectedCount: 1,
		},
		{
			name:          "disabled",
			disabled:      true,
			expectedCount: 0,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			m := createMetricsForTesting()
			m.metricsDisabled.AdapterBuyerUIDScrubbed = tt.disabled
			adapterName := openrtb_ext.BidderName("AnyName")
			lowerCasedAdapterName := "anyname"
			m.RecordAdapterBuyerUIDScrubbed(adapterName)

			assertCounterVecValue(t,
				"Increment adapter buyeruid scrubbed counter",
				"adapter_buyeruids_scrubbed",
				m.adapterScrubbedBuyerUIDs,
				tt.expectedCount,
				prometheus.Labels{
					adapterLabel: lowerCasedAdapterName,
				})
		})
	}
}

func TestRecordAdapterGDPRRequestBlocked(t *testing.T) {
	m := createMetricsForTesting()
	adapterName := openrtb_ext.BidderName("AnyName")
	lowerCasedAdapterName := "anyname"
	m.RecordAdapterGDPRRequestBlocked(adapterName)

	assertCounterVecValue(t,
		"Increment adapter GDPR request blocked counter",
		"adapter_gdpr_requests_blocked",
		m.adapterGDPRBlockedRequests,
		1,
		prometheus.Labels{
			adapterLabel: lowerCasedAdapterName,
		})
}

func TestStoredResponsesMetric(t *testing.T) {
	testCases := []struct {
		description                           string
		publisherId                           string
		accountStoredResponsesMetricsDisabled bool
		expectedAccountStoredResponsesCount   float64
		expectedStoredResponsesCount          float64
	}{

		{
			description:                           "Publisher id is given, account stored responses enabled, expected both account stored responses and stored responses counter to have a record",
			publisherId:                           "acct-id",
			accountStoredResponsesMetricsDisabled: false,
			expectedAccountStoredResponsesCount:   1,
			expectedStoredResponsesCount:          1,
		},
		{
			description:                           "Publisher id is given, account stored responses disabled, expected stored responses counter only to have a record",
			publisherId:                           "acct-id",
			accountStoredResponsesMetricsDisabled: true,
			expectedAccountStoredResponsesCount:   0,
			expectedStoredResponsesCount:          1,
		},
		{
			description:                           "Publisher id is unknown, account stored responses enabled, expected stored responses counter only to have a record",
			publisherId:                           metrics.PublisherUnknown,
			accountStoredResponsesMetricsDisabled: true,
			expectedAccountStoredResponsesCount:   0,
			expectedStoredResponsesCount:          1,
		},
		{
			description:                           "Publisher id is unknown, account stored responses disabled, expected stored responses counter only to have a record",
			publisherId:                           metrics.PublisherUnknown,
			accountStoredResponsesMetricsDisabled: false,
			expectedAccountStoredResponsesCount:   0,
			expectedStoredResponsesCount:          1,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()
		m.metricsDisabled.AccountStoredResponses = test.accountStoredResponsesMetricsDisabled
		m.RecordStoredResponse(test.publisherId)

		assertCounterVecValue(t, "", "account stored responses", m.accountStoredResponses, test.expectedAccountStoredResponsesCount, prometheus.Labels{accountLabel: "acct-id"})
		assertCounterValue(t, "", "stored responses", m.storedResponses, test.expectedStoredResponsesCount)
	}
}

func TestRecordAdsCertReqMetric(t *testing.T) {
	testCases := []struct {
		description                  string
		requestSuccess               bool
		expectedSuccessRequestsCount float64
		expectedFailedRequestsCount  float64
	}{
		{
			description:                  "Record failed request, expected success request count is 0 and failed request count is 1",
			requestSuccess:               false,
			expectedSuccessRequestsCount: 0,
			expectedFailedRequestsCount:  1,
		},
		{
			description:                  "Record successful request, expected success request count is 1 and failed request count is 0",
			requestSuccess:               true,
			expectedSuccessRequestsCount: 1,
			expectedFailedRequestsCount:  0,
		},
	}

	for _, test := range testCases {
		m := createMetricsForTesting()
		m.RecordAdsCertReq(test.requestSuccess)
		assertCounterVecValue(t, test.description, "successfully signed requests", m.adsCertRequests, test.expectedSuccessRequestsCount, prometheus.Labels{successLabel: requestSuccessful})
		assertCounterVecValue(t, test.description, "unsuccessfully signed requests", m.adsCertRequests, test.expectedFailedRequestsCount, prometheus.Labels{successLabel: requestFailed})
	}
}

func TestRecordAdsCertSignTime(t *testing.T) {
	type testIn struct {
		adsCertSignDuration time.Duration
	}
	type testOut struct {
		expDuration float64
		expCount    uint64
	}
	testCases := []struct {
		description string
		in          testIn
		out         testOut
	}{
		{
			description: "Five second AdsCert sign time",
			in: testIn{
				adsCertSignDuration: time.Second * 5,
			},
			out: testOut{
				expDuration: 5,
				expCount:    1,
			},
		},
		{
			description: "Five millisecond AdsCert sign time",
			in: testIn{
				adsCertSignDuration: time.Millisecond * 5,
			},
			out: testOut{
				expDuration: 0.005,
				expCount:    1,
			},
		},
		{
			description: "Zero AdsCert sign time",
			in:          testIn{},
			out: testOut{
				expDuration: 0,
				expCount:    1,
			},
		},
	}
	for i, test := range testCases {
		pm := createMetricsForTesting()
		pm.RecordAdsCertSignTime(test.in.adsCertSignDuration)

		m := dto.Metric{}
		pm.adsCertSignTimer.Write(&m)
		histogram := *m.GetHistogram()

		assert.Equal(t, test.out.expCount, histogram.GetSampleCount(), "[%d] Incorrect number of histogram entries. Desc: %s\n", i, test.description)
		assert.Equal(t, test.out.expDuration, histogram.GetSampleSum(), "[%d] Incorrect number of histogram cumulative values. Desc: %s\n", i, test.description)
	}
}

func TestRecordModuleMetrics(t *testing.T) {
	m := createMetricsForTesting()

	// check that each module has its own metric recorded with correct stage labels
	for module, stages := range modulesStages {
		for _, stage := range stages {
			// first record the metrics
			m.RecordModuleCalled(metrics.ModuleLabels{
				Module: module,
				Stage:  stage,
			}, time.Millisecond*1)
			m.RecordModuleFailed(metrics.ModuleLabels{
				Module: module,
				Stage:  stage,
			})
			m.RecordModuleSuccessNooped(metrics.ModuleLabels{
				Module: module,
				Stage:  stage,
			})
			m.RecordModuleSuccessUpdated(metrics.ModuleLabels{
				Module: module,
				Stage:  stage,
			})
			m.RecordModuleSuccessRejected(metrics.ModuleLabels{
				Module: module,
				Stage:  stage,
			})
			m.RecordModuleExecutionError(metrics.ModuleLabels{
				Module: module,
				Stage:  stage,
			})
			m.RecordModuleTimeout(metrics.ModuleLabels{
				Module: module,
				Stage:  stage,
			})

			// now check that the values are correct
			result := getHistogramFromHistogramVec(m.moduleDuration[module], stageLabel, stage)
			assertHistogram(t, fmt.Sprintf("module_%s_duration", module), result, 1, 0.001)
			assertCounterVecValue(t, "Module calls performed", fmt.Sprintf("%s metric recorded during %s stage", module, stage), m.moduleCalls[module], 1, prometheus.Labels{stageLabel: stage})
			assertCounterVecValue(t, "Module calls failed", fmt.Sprintf("%s metric recorded during %s stage", module, stage), m.moduleFailures[module], 1, prometheus.Labels{stageLabel: stage})
			assertCounterVecValue(t, "Module success noop action", fmt.Sprintf("%s metric recorded during %s stage", module, stage), m.moduleSuccessNoops[module], 1, prometheus.Labels{stageLabel: stage})
			assertCounterVecValue(t, "Module success update action", fmt.Sprintf("%s metric recorded during %s stage", module, stage), m.moduleSuccessUpdates[module], 1, prometheus.Labels{stageLabel: stage})
			assertCounterVecValue(t, "Module success reject action", fmt.Sprintf("%s metric recorded during %s stage", module, stage), m.moduleSuccessRejects[module], 1, prometheus.Labels{stageLabel: stage})
			assertCounterVecValue(t, "Module execution error", fmt.Sprintf("%s metric recorded during %s stage", module, stage), m.moduleExecutionErrors[module], 1, prometheus.Labels{stageLabel: stage})
			assertCounterVecValue(t, "Module timeout", fmt.Sprintf("%s metric recorded during %s stage", module, stage), m.moduleTimeouts[module], 1, prometheus.Labels{stageLabel: stage})
		}
	}
}