metrics

type Metrics interface {
	// Enabled returns whether metrics is enabled
	Enabled() bool

	// Observe records a metric using the provided Reporter
	Observe(reporter Reporter)

	// Recorder returns the Recorder for this Metrics instance
	Recorder() Recorder
}

type Recorder interface {
	// Log records the general metrics like API, method, code, sendBytes, recvBytes, and latency.
	Log(api, method, code string, sendBytes, recvBytes, latency float64)

	// RequestLog records the request details like module, API, method, and code.
	RequestLog(module, api, method, code string)

	// SendBytesLog records the bytes sent for a specific module, API, method, and code.
	SendBytesLog(module, api, method, code string, byte float64)

	// RecvBytesLog records the bytes received for a specific module, API, method, and code.
	RecvBytesLog(module, api, method, code string, byte float64)

	// HistogramLatencyLog records the latency in a histogram format for a specific module, API, and method.
	HistogramLatencyLog(module, api, method string, latency float64)

	// SummaryLatencyLog records the latency in a summary format for a specific module, API, and method.
	SummaryLatencyLog(module, api, method string, latency float64)

	// ExceptionLog records an exception event for a specific module and exception.
	ExceptionLog(module, exception string)

	// EventLog records a general event for a specific module and event.
	EventLog(module, event string)

	// SiteEventLog records a site-specific event for a specific module, event, and site.
	SiteEventLog(module, event, site string)

	// StateLog records the state value for a specific module and state.
	StateLog(module, state string, value float64)

	// ResetCounter resets any internal counters maintained by the recorder.
	ResetCounter()

	// RegisterCustomCollector allows registering a custom prometheus.Collector.
	RegisterCustomCollector(c prometheus.Collector)
}

type Reporter interface {
	// Context returns the context of the reporter.
	Context() context.Context
	// API returns the API endpoint associated with the metric.
	API() string
	// Method returns the HTTP method used for the API call.
	Method() string
	// Code returns the status code of the API response.
	Code() string
	// BytesWritten returns the number of bytes written in the response.
	BytesWritten() int64
	// BytesReceived returns the number of bytes received in the request.
	BytesReceived() int64
	// Succeed returns a boolean indicating if the request was successful.
	Succeed() bool
	// TraceID returns the unique trace ID associated with the request.
	TraceID() string
	// Latency returns the latency of the request in milliseconds.
	Latency() int64
}