options

type ConcurrencyOptions struct {
	// QueryConcurrencyLimit defines the concurrency limit while querying backends for the given mechanism.
	// If set to 0, no limit is applied, if set to a positive integer, that number of queries can be performed concurrently.
	// If the value is not set, it defaults to the number of logical CPUs available to the process (GOMAXPROCS).
	// Default value is GOMAXPROCS.
	QueryConcurrencyLimit *int `yaml:"query_concurrency_limit,omitempty"`

	// QueryConcurrencyMultiplier is a multiplier that can be applied to the default concurrency limit.
	// This multiplier is applied to the query_concurrency_limit value to result in the overall concurrency limit for the given mechanism.
	// Default and minimum value is 1.
	QueryConcurrencyMultiplier *int `yaml:"query_concurrency_multiplier,omitempty"`
}

type FirstGoodResponseOptions struct {
	// StatusCodes provides an explicit list of status codes considered "good" when using
	// the First Good Response (fgr) methodology. By default, any code < 400 is good.
	StatusCodes        []int              `yaml:"status_codes,omitempty"`
	ConcurrencyOptions ConcurrencyOptions `yaml:",inline"`
}

type InvalidALBOptionsError struct {
	// contains filtered or unexported fields
}

type NewestLastModifiedOptions struct {
	ConcurrencyOptions ConcurrencyOptions `yaml:",inline"`
}

type Options struct {
	// MechanismName indicates the name of the load balancing mechanism
	MechanismName string `yaml:"mechanism,omitempty"`
	// Pool provides the list of backend names to be used by the load balancer
	Pool []string `yaml:"pool,omitempty"`
	// HealthyFloor is the minimum health check status value admitted to the pool.
	// Values below 0 admit members the probe has confirmed Failing; only set
	// this below 0 if you intend to route to known-broken upstreams.
	// -1 : all pool members admitted, including Failing
	//  0 (default) : Unknown (0) and Healthy (1) admitted, Failing rejected
	//  1 : only Healthy (1) admitted
	// Unknown means the first health check hasn't returned yet, or the target
	// backend has no health check interval configured.
	HealthyFloor int `yaml:"healthy_floor,omitempty"`
	// MaxCaptureBytes overrides the backend-level max_capture_bytes for this
	// ALB's fanout members. Set this when the ALB's expected response shape
	// differs from the backend default (e.g. a TSM fan-out of 50 small-payload
	// shards may safely use a lower cap than the global default to surface
	// runaway upstreams faster). When 0, falls back to the parent Backend's
	// max_capture_bytes, then to the package-level default (256 MiB).
	MaxCaptureBytes int `yaml:"max_capture_bytes,omitempty"`
	// MaxFanoutCaptureBytes, if > 0, caps the aggregate in-flight
	// capture-buffer reservations across all slots in one ALB fanout call.
	// When 0, falls back to the parent Backend's max_fanout_capture_bytes,
	// which itself defaults to 0 (no aggregate cap).
	MaxFanoutCaptureBytes int `yaml:"max_fanout_capture_bytes,omitempty"`
	// OutputFormat accompanies the tsmerge Mechanism to indicate the provider output format
	// options include any valid time seres backend like prometheus, influxdb or clickhouse
	OutputFormat string `yaml:"output_format,omitempty"`
	// Deprecated: use fgr.status_codes instead of this top-level option
	// FGRStatusCodes provides an explicit list of status codes considered "good" when using
	// the First Good Response (fgr) methodology. By default, any code < 400 is good.
	FGRStatusCodes []int `yaml:"fgr_status_codes,omitempty"`
	// UserRouter provides options for the User Router mechanism
	UserRouter *ur.Options `yaml:"user_router,omitempty"`
	//
	// synthetic values
	FgrCodesLookup sets.Set[int] `yaml:"-"`

	// mechanism-specific options
	TSMOptions TimeSeriesMergeOptions    `yaml:"tsm,omitempty"`
	NLMOptions NewestLastModifiedOptions `yaml:"nlm,omitempty"`
	FGROptions FirstGoodResponseOptions  `yaml:"fgr,omitempty"`
}

type TimeSeriesMergeOptions struct {
	ConcurrencyOptions ConcurrencyOptions `yaml:",inline"`
	// DedupToleranceMs is an opt-in tolerance window (milliseconds) for
	// clustering near-duplicate samples produced by independent fan-out
	// shards. When two shards sample the same metric at timestamps that
	// differ by <= this many milliseconds, the cluster collapses to a single
	// survivor (first-seen-after-sort wins). Nil or 0 preserves the legacy
	// exact-epoch dedup behavior.
	DedupToleranceMs *int `yaml:"dedup_tolerance_ms,omitempty"`
}