RepoMirrors
/
prometheus
mirror of https://github.com/prometheus/prometheus
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

web/api: export defaultStatsRenderer (#14121) 

defaultStatsRenderer->DefaultStatsRenderer
Add short docstrings.

I'd like to use the stats renderer to peek at the statistics in
https://github.com/grafana/mimir/pull/7966

However I cannot call the original function without this export afterwards.

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
This commit is contained in:
George Krajcsovits 2024-05-18 16:12:33 +02:00 committed by GitHub
parent edf5ebd844
commit 52f68a96a4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
web/api/v1/api.go
View File

@ -116,9 +116,11 @@ type RulesRetriever interface {
AlertingRules() []*rules.AlertingRule AlertingRules() []*rules.AlertingRule
} }
// StatsRenderer converts engine statistics into a format suitable for the API.
type StatsRenderer func(context.Context, *stats.Statistics, string) stats.QueryStats type StatsRenderer func(context.Context, *stats.Statistics, string) stats.QueryStats
func defaultStatsRenderer(_ context.Context, s *stats.Statistics, param string) stats.QueryStats { // DefaultStatsRenderer is the default stats renderer for the API.
func DefaultStatsRenderer(_ context.Context, s *stats.Statistics, param string) stats.QueryStats {
if param != "" { if param != "" {
return stats.NewQueryStats(s) return stats.NewQueryStats(s)
} }
@ -272,7 +274,7 @@ func NewAPI(
buildInfo: buildInfo, buildInfo: buildInfo,
gatherer: gatherer, gatherer: gatherer,
isAgent: isAgent, isAgent: isAgent,
statsRenderer: defaultStatsRenderer, statsRenderer: DefaultStatsRenderer,
remoteReadHandler: remote.NewReadHandler(logger, registerer, q, configFunc, remoteReadSampleLimit, remoteReadConcurrencyLimit, remoteReadMaxBytesInFrame), remoteReadHandler: remote.NewReadHandler(logger, registerer, q, configFunc, remoteReadSampleLimit, remoteReadConcurrencyLimit, remoteReadMaxBytesInFrame),
} }
@ -461,7 +463,7 @@ func (api *API) query(r *http.Request) (result apiFuncResult) {
// Optional stats field in response if parameter "stats" is not empty. // Optional stats field in response if parameter "stats" is not empty.
sr := api.statsRenderer sr := api.statsRenderer
if sr == nil { if sr == nil {
sr = defaultStatsRenderer sr = DefaultStatsRenderer
} }
qs := sr(ctx, qry.Stats(), r.FormValue("stats")) qs := sr(ctx, qry.Stats(), r.FormValue("stats"))
@ -563,7 +565,7 @@ func (api *API) queryRange(r *http.Request) (result apiFuncResult) {
// Optional stats field in response if parameter "stats" is not empty. // Optional stats field in response if parameter "stats" is not empty.
sr := api.statsRenderer sr := api.statsRenderer
if sr == nil { if sr == nil {
sr = defaultStatsRenderer sr = DefaultStatsRenderer
} }
qs := sr(ctx, qry.Stats(), r.FormValue("stats")) qs := sr(ctx, qry.Stats(), r.FormValue("stats"))