traces/modules/overrides/interface.go

package overrides

import (
	"io"
	"net/http"
	"time"

	"github.com/grafana/dskit/services"
	"github.com/prometheus/client_golang/prometheus"

	"github.com/grafana/tempo/modules/overrides/histograms"
	"github.com/grafana/tempo/pkg/sharedconfig"
	"github.com/grafana/tempo/pkg/spanfilter/config"
	"github.com/grafana/tempo/tempodb/backend"
)

type Service interface {
	services.Service
	Interface
}

type Interface interface {
	prometheus.Collector

	// GetTenantIDs returns all tenants that have non-default overrides.
	GetTenantIDs() []string

	// GetRuntimeOverridesFor returns the runtime overrides set for the given user excluding
	// overrides from the user-configurable overrides, if enabled.
	GetRuntimeOverridesFor(userID string) *Overrides

	// Config
	IngestionRateStrategy() string
	MaxLocalTracesPerUser(userID string) int
	MaxGlobalTracesPerUser(userID string) int
	MaxBytesPerTrace(userID string) int
	IngestionArtificialDelay(userID string) (time.Duration, bool)
	IngestionRetryInfoEnabled(userID string) bool
	MaxCompactionRange(userID string) time.Duration
	Forwarders(userID string) []string
	MaxBytesPerTagValuesQuery(userID string) int
	MaxBlocksPerTagValuesQuery(userID string) int
	IngestionRateLimitBytes(userID string) float64
	IngestionBurstSizeBytes(userID string) int
	IngestionTenantShardSize(userID string) int
	IngestionMaxAttributeBytes(userID string) int
	MetricsGeneratorIngestionSlack(userID string) time.Duration
	MetricsGeneratorRingSize(userID string) int
	MetricsGeneratorProcessors(userID string) map[string]struct{}
	MetricsGeneratorMaxActiveSeries(userID string) uint32
	MetricsGeneratorMaxActiveEntities(userID string) uint32
	MetricsGeneratorCollectionInterval(userID string) time.Duration
	MetricsGeneratorDisableCollection(userID string) bool
	MetricsGeneratorGenerateNativeHistograms(userID string) histograms.HistogramMethod
	MetricsGeneratorTraceIDLabelName(userID string) string
	MetricsGeneratorRemoteWriteHeaders(userID string) map[string]string
	MetricsGeneratorForwarderQueueSize(userID string) int
	MetricsGeneratorForwarderWorkers(userID string) int
	MetricsGeneratorProcessorServiceGraphsHistogramBuckets(userID string) []float64
	MetricsGeneratorProcessorServiceGraphsDimensions(userID string) []string
	MetricsGeneratorProcessorServiceGraphsPeerAttributes(userID string) []string
	MetricsGeneratorProcessorServiceGraphsFilterPolicies(userID string) []config.FilterPolicy
	MetricsGeneratorProcessorSpanMetricsHistogramBuckets(userID string) []float64
	MetricsGeneratorProcessorSpanMetricsDimensions(userID string) []string
	MetricsGeneratorProcessorSpanMetricsIntrinsicDimensions(userID string) map[string]bool
	MetricsGeneratorProcessorSpanMetricsFilterPolicies(userID string) []config.FilterPolicy
	MetricsGeneratorProcessorLocalBlocksMaxLiveTraces(userID string) uint64
	MetricsGeneratorProcessorLocalBlocksMaxBlockDuration(userID string) time.Duration
	MetricsGeneratorProcessorLocalBlocksMaxBlockBytes(userID string) uint64
	MetricsGeneratorProcessorLocalBlocksTraceIdlePeriod(userID string) time.Duration
	MetricsGeneratorProcessorLocalBlocksFlushCheckPeriod(userID string) time.Duration
	MetricsGeneratorProcessorLocalBlocksCompleteBlockTimeout(userID string) time.Duration
	MetricsGeneratorProcessorSpanMetricsDimensionMappings(userID string) []sharedconfig.DimensionMappings
	MetricsGeneratorProcessorSpanMetricsEnableTargetInfo(userID string) (bool, bool) // returns (enabled, isSet)
	MetricsGeneratorProcessorServiceGraphsEnableClientServerPrefix(userID string) bool
	MetricsGeneratorProcessorServiceGraphsEnableMessagingSystemLatencyHistogram(userID string) (bool, bool) // returns (enabled, isSet)
	MetricsGeneratorProcessorServiceGraphsEnableVirtualNodeLabel(userID string) (bool, bool)                // returns (enabled, isSet)
	MetricsGeneratorProcessorSpanMetricsTargetInfoExcludedDimensions(userID string) []string
	MetricsGeneratorProcessorSpanMetricsEnableInstanceLabel(userID string) (bool, bool)
	MetricsGeneratorProcessorHostInfoHostIdentifiers(userID string) []string
	MetricsGeneratorProcessorHostInfoMetricName(userID string) string
	MetricsGeneratorProcessorServiceGraphsSpanMultiplierKey(userID string) string
	MetricsGeneratorProcessorSpanMetricsSpanMultiplierKey(userID string) string
	MetricsGeneratorNativeHistogramBucketFactor(userID string) float64
	MetricsGeneratorNativeHistogramMaxBucketNumber(userID string) uint32
	MetricsGeneratorNativeHistogramMinResetDuration(userID string) time.Duration
	MetricsGeneratorSpanNameSanitization(userID string) string
	MetricsGeneratorMaxCardinalityPerLabel(userID string) uint64
	BlockRetention(userID string) time.Duration
	CompactionDisabled(userID string) bool
	MaxSearchDuration(userID string) time.Duration
	MaxMetricsDuration(userID string) time.Duration
	DedicatedColumns(userID string) backend.DedicatedColumns
	UnsafeQueryHints(userID string) bool
	LeftPadTraceIDs(userID string) bool
	CostAttributionMaxCardinality(userID string) uint64
	CostAttributionDimensions(userID string) map[string]string

	// Management API
	WriteStatusRuntimeConfig(w io.Writer, r *http.Request) error
}