stats

type BackpressureStats struct {
	// Throttling - throttling subsystem statistics.
	Throttling *ThrottlingStats
	// ControlParameters - control signal received from controller.
	ControlParameters *ControlParameters
}

type ConsumptionReport struct {
	// Go - memory consumption contributed by structures managed by Go allocator.
	// [key - arbitrary string, value - bytes]
	Go map[string]uint64
	// Cgo - memory consumption contributed by structures managed by Cgo allocator.
	// [key - arbitrary string, value - bytes]
	Cgo map[string]uint64
}

type ControlParameters struct {
	// ControllerStats - internal telemetry that may be useful for
	// implementation of application-specific backpressure actors.
	ControllerStats *ControllerStats
	// GOGC - value that will be used as a parameter for debug.SetGCPercent
	GOGC int
	// ThrottlingPercentage - percentage of requests that must be throttled on the middleware level (in range [0; 100])
	ThrottlingPercentage uint32
}

type ControllerNextGCStats struct {
	// P - proportional component's output
	P float64
	// Output - final output
	Output float64
}

type ControllerStats struct {
	// MemoryBudget - common memory budget information
	MemoryBudget *MemoryBudgetStats
	// NextGC - NextGC-aware controller statistics
	NextGC *ControllerNextGCStats
}

type MemLimiterStats struct {
	// ControllerStats - memory budget controller statistics
	Controller *ControllerStats
	// Backpressure - backpressure subsystem statistics
	Backpressure *BackpressureStats
}

type MemoryBudgetStats struct {
	// SpecialConsumers - specialized memory consumers (like CGO) statistics.
	SpecialConsumers *SpecialConsumersStats
	// RSSActual - physical memory (RSS) current consumption [bytes].
	RSSActual uint64
	// RSSLimit - physical memory (RSS) consumption limit [bytes].
	RSSLimit uint64
	// GoAllocLimit - allocation limit for Go Runtime (with the except of CGO) [bytes].
	GoAllocLimit uint64
	// Utilization - memory budget utilization [percents]
	// (definition depends on a particular controller implementation).
	Utilization float64
}

type ServiceStats interface {
	// RSS returns current RSS value [bytes]
	RSS() uint64
	// NextGC returns current NextGC value [bytes]
	NextGC() uint64
	// ConsumptionReport provides statistical information about the predefined memory consumers that contribute
	// significant part in process' overall memory consumption (caches, memory pools and other large structures).
	// It's mandatory to fill this report if you have large caches on Go side or if you allocate a lot beyond Cgo borders.
	// But if your service is simple, feel free to return nil.
	ConsumptionReport() *ConsumptionReport
}

type ServiceStatsMock struct {
	mock.Mock
}

type ServiceStatsSubscription interface {
	// Updates returns outgoing stream of service tracker.
	Updates() <-chan ServiceStats
	// Quit terminates program.
	Quit()
}

type ServiceStatsSubscriptionMock struct {
	ServiceStatsSubscription
	Chan chan ServiceStats
	mock.Mock
}

type SpecialConsumersStats struct {
	// Go - Go runtime managed consumers.
	Go map[string]uint64
	// Cgo - consumers residing beyond the Cgo border.
	Cgo map[string]uint64
}

type ThrottlingStats struct {
	// Passed - number of allowed requests.
	Passed uint64
	// Throttled - number of throttled requests.
	Throttled uint64
	// Total - total number of received requests (Passed + Throttled)
	Total uint64
}