Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

query/receive: Unify HTTP server instrumentation #1458

Merged
merged 5 commits into from
Aug 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ We use *breaking* word for marking changes that are not backward compatible (rel

### Added

- [#1378](https://github.com/thanos-io/thanos/pull/1378) Thanos Receive now exposes `thanos_receive_config_hash`, `thanos_receive_config_last_reload_successful` and `thanos_receive_config_last_reload_success_timestamp_seconds` metrics to track latest configuration change
- [#1358](https://github.com/thanos-io/thanos/pull/1358) Added `part_size` configuration option for HTTP multipart requests minimum part size for S3 storage type
- [#1363](https://github.com/thanos-io/thanos/pull/1363) Thanos Receive now exposes `thanos_receive_hashring_nodes` and `thanos_receive_hashring_tenants` metrics to monitor status of hash-rings

Expand All @@ -32,6 +33,10 @@ We use *breaking* word for marking changes that are not backward compatible (rel
- [#1327](https://github.com/thanos-io/thanos/pull/1327) `/series` API end-point now properly returns an empty array just like Prometheus if there are no results
- [#1302](https://github.com/thanos-io/thanos/pull/1302) Thanos now efficiently reuses HTTP keep-alive connections

### Deprecated

- [#1458](https://github.com/thanos-io/thanos/pull/1458) Thanos Query and Receive now use common instrumentation middleware. As as result, for sake of `http_requests_total` and `http_request_duration_seconds_bucket`; Thanos Query no longer exposes `thanos_query_api_instant_query_duration_seconds`, `thanos_query_api_range_query_duration_second` metrics and Thanos Receive no longer exposes `thanos_http_request_duration_seconds`, `thanos_http_requests_total`, `thanos_http_response_size_bytes`.

## [v0.6.0](https://github.com/thanos-io/thanos/releases/tag/v0.6.0) - 2019.07.18

### Added
Expand Down
6 changes: 3 additions & 3 deletions examples/grafana/thanos-query.json
Original file line number Diff line number Diff line change
Expand Up @@ -306,14 +306,14 @@
"steppedLine": false,
"targets": [
{
"expr": "histogram_quantile(0.9999, sum(rate(thanos_query_api_instant_query_duration_seconds_bucket{$labelselector=\"$labelvalue\",kubernetes_pod_name=~\"$pod\"}[$interval])) by (kubernetes_pod_name, le))",
"expr": "histogram_quantile(0.9999, sum(rate(http_request_duration_seconds_bucket{$labelselector=\"$labelvalue\",kubernetes_pod_name=~\"$pod\",handler=\"query\"}[$interval])) by (kubernetes_pod_name, le))",
"format": "time_series",
"intervalFactor": 1,
"legendFormat": "instant_query {{kubernetes_pod_name}}",
"refId": "A"
},
{
"expr": "histogram_quantile(0.9999, sum(rate(thanos_query_api_range_query_duration_seconds_bucket{$labelselector=\"$labelvalue\",kubernetes_pod_name=~\"$pod\"}[$interval])) by (kubernetes_pod_name, le))",
"expr": "histogram_quantile(0.9999, sum(rate(http_request_duration_seconds_bucket{$labelselector=\"$labelvalue\",kubernetes_pod_name=~\"$pod\",handler=\"query_range\"}[$interval])) by (kubernetes_pod_name, le))",
"format": "time_series",
"intervalFactor": 1,
"legendFormat": "range_query {{kubernetes_pod_name}}",
Expand Down Expand Up @@ -1035,4 +1035,4 @@
"title": "Thanos Query",
"uid": "opwl5gSiz",
"version": 2
}
}
2 changes: 1 addition & 1 deletion pkg/extprom/http/instrument_server.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ type defaultInstrumentationMiddleware struct {
}

// NewInstrumentationMiddleware provides default InstrumentationMiddleware.
func NewInstrumentationMiddleware(reg *prometheus.Registry) InstrumentationMiddleware {
func NewInstrumentationMiddleware(reg prometheus.Registerer) InstrumentationMiddleware {
ins := defaultInstrumentationMiddleware{
requestDuration: prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Expand Down
27 changes: 0 additions & 27 deletions pkg/query/api/v1.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,6 @@ type API struct {
queryableCreate query.QueryableCreator
queryEngine *promql.Engine

instantQueryDuration prometheus.Histogram
rangeQueryDuration prometheus.Histogram
enableAutodownsampling bool
enablePartialResponse bool
now func() time.Time
Expand All @@ -116,31 +114,10 @@ func NewAPI(
enableAutodownsampling bool,
enablePartialResponse bool,
) *API {
instantQueryDuration := prometheus.NewHistogram(prometheus.HistogramOpts{
Name: "thanos_query_api_instant_query_duration_seconds",
Help: "Time it takes to perform instant query on promEngine backed up with thanos querier.",
Buckets: []float64{
0.05, 0.1, 0.25, 0.6, 1, 2, 3.5, 5, 7.5, 10, 15, 20,
},
})
rangeQueryDuration := prometheus.NewHistogram(prometheus.HistogramOpts{
Name: "thanos_query_api_range_query_duration_seconds",
Help: "Time it takes to perform range query on promEngine backed up with thanos querier.",
Buckets: []float64{
0.05, 0.1, 0.25, 0.6, 1, 2, 3.5, 5, 7.5, 10, 15, 20,
},
})

reg.MustRegister(
instantQueryDuration,
rangeQueryDuration,
)
return &API{
logger: logger,
queryEngine: qe,
queryableCreate: c,
instantQueryDuration: instantQueryDuration,
rangeQueryDuration: rangeQueryDuration,
enableAutodownsampling: enableAutodownsampling,
enablePartialResponse: enablePartialResponse,

Expand Down Expand Up @@ -281,7 +258,6 @@ func (api *API) query(r *http.Request) (interface{}, []error, *ApiError) {
span, ctx := tracing.StartSpan(ctx, "promql_instant_query")
defer span.Finish()

begin := api.now()
qry, err := api.queryEngine.NewInstantQuery(api.queryableCreate(enableDedup, 0, enablePartialResponse), r.FormValue("query"), ts)
if err != nil {
return nil, nil, &ApiError{errorBadData, err}
Expand All @@ -299,7 +275,6 @@ func (api *API) query(r *http.Request) (interface{}, []error, *ApiError) {
}
return nil, nil, &ApiError{errorExec, res.Err}
}
api.instantQueryDuration.Observe(time.Since(begin).Seconds())

return &queryData{
ResultType: res.Value.Type(),
Expand Down Expand Up @@ -369,7 +344,6 @@ func (api *API) queryRange(r *http.Request) (interface{}, []error, *ApiError) {
span, ctx := tracing.StartSpan(ctx, "promql_range_query")
defer span.Finish()

begin := api.now()
qry, err := api.queryEngine.NewRangeQuery(
api.queryableCreate(enableDedup, maxSourceResolution, enablePartialResponse),
r.FormValue("query"),
Expand All @@ -391,7 +365,6 @@ func (api *API) queryRange(r *http.Request) (interface{}, []error, *ApiError) {
}
return nil, nil, &ApiError{errorExec, res.Err}
}
api.rangeQueryDuration.Observe(time.Since(begin).Seconds())

return &queryData{
ResultType: res.Value.Type(),
Expand Down
4 changes: 0 additions & 4 deletions pkg/query/api/v1_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ import (

"github.com/go-kit/kit/log"
opentracing "github.com/opentracing/opentracing-go"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/common/route"
"github.com/prometheus/prometheus/pkg/labels"
"github.com/prometheus/prometheus/pkg/timestamp"
Expand Down Expand Up @@ -71,9 +70,6 @@ func TestEndpoints(t *testing.T) {
queryableCreate: testQueryableCreator(suite.Storage()),
queryEngine: suite.QueryEngine(),

instantQueryDuration: prometheus.NewHistogram(prometheus.HistogramOpts{}),
rangeQueryDuration: prometheus.NewHistogram(prometheus.HistogramOpts{}),

now: func() time.Time { return now },
}

Expand Down
61 changes: 11 additions & 50 deletions pkg/receive/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ import (
opentracing "github.com/opentracing/opentracing-go"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/common/route"
promtsdb "github.com/prometheus/prometheus/storage/tsdb"
terrors "github.com/prometheus/prometheus/tsdb/errors"
extpromhttp "github.com/thanos-io/thanos/pkg/extprom/http"
"github.com/thanos-io/thanos/pkg/runutil"
"github.com/thanos-io/thanos/pkg/store/prompb"
)
Expand Down Expand Up @@ -54,9 +54,6 @@ type Handler struct {
hashring Hashring

// Metrics
requestDuration *prometheus.HistogramVec
requestsTotal *prometheus.CounterVec
responseSize *prometheus.HistogramVec
forwardRequestsTotal *prometheus.CounterVec

// These fields are uint32 rather than boolean to be able to use atomic functions.
Expand All @@ -72,29 +69,8 @@ func NewHandler(logger log.Logger, o *Options) *Handler {
logger: logger,
readyStorage: o.ReadyStorage,
receiver: o.Receiver,
router: route.New(),
options: o,
requestDuration: prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Name: "thanos_http_request_duration_seconds",
Help: "Histogram of latencies for HTTP requests.",
Buckets: []float64{.1, .2, .4, 1, 3, 8, 20, 60, 120},
},
[]string{"handler"},
),
requestsTotal: prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "thanos_http_requests_total",
Help: "Tracks the number of HTTP requests.",
}, []string{"code", "handler", "method"},
),
responseSize: prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Name: "thanos_http_response_size_bytes",
Help: "Histogram of response size for HTTP requests.",
Buckets: prometheus.ExponentialBuckets(100, 10, 8),
},
[]string{"handler"},
),
forwardRequestsTotal: prometheus.NewCounterVec(
prometheus.CounterOpts{
Name: "thanos_receive_forward_requests_total",
Expand All @@ -103,35 +79,20 @@ func NewHandler(logger log.Logger, o *Options) *Handler {
),
}

router := route.New().WithInstrumentation(h.instrumentHandler)
h.router = router
ins := extpromhttp.NewNopInstrumentationMiddleware()
if o.Registry != nil {
ins = extpromhttp.NewInstrumentationMiddleware(o.Registry)
o.Registry.MustRegister(h.forwardRequestsTotal)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did we always forget to register this or am I missing why this line is here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understood you correctly, It was registered before. I just removed the ones which come from InstrumentationMiddleware.

if o.Registry != nil {
o.Registry.MustRegister(
h.requestDuration,
h.requestsTotal,
h.responseSize,
h.forwardRequestsTotal,
)
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Makes sense now.

}

readyf := h.testReady
router.Post("/api/v1/receive", readyf(h.receive))

if o.Registry != nil {
o.Registry.MustRegister(
h.requestDuration,
h.requestsTotal,
h.responseSize,
h.forwardRequestsTotal,
)
instrf := func(name string, next func(w http.ResponseWriter, r *http.Request)) http.HandlerFunc {
return ins.NewHandler(name, http.HandlerFunc(next))
}

return h
}
h.router.Post("/api/v1/receive", instrf("receive", readyf(h.receive)))

func (h *Handler) instrumentHandler(handlerName string, handler http.HandlerFunc) http.HandlerFunc {
return promhttp.InstrumentHandlerDuration(
h.requestDuration.MustCurryWith(prometheus.Labels{"handler": handlerName}),
promhttp.InstrumentHandlerResponseSize(
h.responseSize.MustCurryWith(prometheus.Labels{"handler": handlerName}),
promhttp.InstrumentHandlerCounter(
h.requestsTotal.MustCurryWith(prometheus.Labels{"handler": handlerName}),
handler,
),
),
)
return h
}

// StorageReady marks the storage as ready.
Expand Down