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

rule: add --query.http-method #3378

Merged
merged 3 commits into from
Oct 30, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ We use *breaking :warning:* to mark changes that are not backward compatible (re
- [#3346](https://github.com/thanos-io/thanos/pull/3346) Ruler UI: Fix a bug preventing the /rules endpoint from loading.
- [#3115](https://github.com/thanos-io/thanos/pull/3115) compact: now deletes partially uploaded and blocks with deletion marks concurrently. It does that at the beginning and then every `--compact.cleanup-interval` time period. By default it is 5 minutes.
- [#3312](https://github.com/thanos-io/thanos/pull/3312) s3: add list_objects_version config option for compatibility.
- [#3378](https://github.com/thanos-io/thanos/pull/3378) Ruler: learned to send queries via POST. Helps when alerting/recording rules are extra long. It now uses POST unless `--query.http-method` is `GET`.
Copy link
Member

Choose a reason for hiding this comment

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

learned? ;p Can we use more technical language?

Copy link
Member Author

Choose a reason for hiding this comment

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

😄 reworked this line to make it more technical and even cleaner. Let me know if that works :P


### Fixed
- [#3257](https://github.com/thanos-io/thanos/pull/3257) Ruler: Prevent Ruler from crashing when using default DNS to lookup hosts that results in "No such hosts" errors.
Expand Down
9 changes: 8 additions & 1 deletion cmd/thanos/rule.go
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ func registerRule(app *extkingpin.App) {
dnsSDInterval := extkingpin.ModelDuration(cmd.Flag("query.sd-dns-interval", "Interval between DNS resolutions.").
Default("30s"))

httpMethod := cmd.Flag("query.http-method", "HTTP method to use when sending queries. Possible options: [GET, POST]").
Default("POST").Enum("GET", "POST")

dnsSDResolver := cmd.Flag("query.sd-dns-resolver", "Resolver to use. Possible options: [golang, miekgdns]").
Default("golang").Hidden().String()

Expand Down Expand Up @@ -210,6 +213,7 @@ func registerRule(app *extkingpin.App) {
*dnsSDResolver,
comp,
*allowOutOfOrderUpload,
*httpMethod,
getFlagsMap(cmd.Flags()),
)
})
Expand Down Expand Up @@ -299,6 +303,7 @@ func runRule(
dnsSDResolver string,
comp component.Component,
allowOutOfOrderUpload bool,
httpMethod string,
flagsMap map[string]string,
) error {
metrics := newRuleMetrics(reg)
Expand Down Expand Up @@ -463,7 +468,7 @@ func runRule(
Queryable: db,
ResendDelay: resendDelay,
},
queryFuncCreator(logger, queryClients, metrics.duplicatedQuery, metrics.ruleEvalWarnings),
queryFuncCreator(logger, queryClients, metrics.duplicatedQuery, metrics.ruleEvalWarnings, httpMethod),
lset,
)

Expand Down Expand Up @@ -729,6 +734,7 @@ func queryFuncCreator(
queriers []*http_util.Client,
duplicatedQuery prometheus.Counter,
ruleEvalWarnings *prometheus.CounterVec,
httpMethod string,
) func(partialResponseStrategy storepb.PartialResponseStrategy) rules.QueryFunc {

// queryFunc returns query function that hits the HTTP query API of query peers in randomized order until we get a result
Expand Down Expand Up @@ -760,6 +766,7 @@ func queryFuncCreator(
v, warns, err := promClient.PromqlQueryInstant(ctx, endpoints[i], q, t, promclient.QueryOptions{
Deduplicate: true,
PartialResponseStrategy: partialResponseStrategy,
Method: httpMethod,
})
span.Finish()

Expand Down
2 changes: 2 additions & 0 deletions docs/components/rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,8 @@ Flags:
(used as a fallback)
--query.sd-dns-interval=30s
Interval between DNS resolutions.
--query.http-method=POST HTTP method to use when sending queries.
Possible options: [GET, POST]

```

Expand Down
33 changes: 26 additions & 7 deletions pkg/promclient/promclient.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
Expand Down Expand Up @@ -97,14 +98,26 @@ func NewWithTracingClient(logger log.Logger, userAgent string) *Client {
)
}

func (c *Client) get2xx(ctx context.Context, u *url.URL) (_ []byte, _ int, err error) {
req, err := http.NewRequest(http.MethodGet, u.String(), nil)
// req2xx sends a request to the given url.URL. If method is http.MethodPost then
// the raw query is encoded in the body and the appropriate Content-Type is set.
func (c *Client) req2xx(ctx context.Context, u *url.URL, method string) (_ []byte, _ int, err error) {
var b io.Reader
if method == http.MethodPost {
rq := u.RawQuery
b = strings.NewReader(rq)
u.RawQuery = ""
}

req, err := http.NewRequest(method, u.String(), b)
if err != nil {
return nil, 0, errors.Wrap(err, "create GET request")
}
if c.userAgent != "" {
req.Header.Set("User-Agent", c.userAgent)
}
if method == http.MethodPost {
req.Header.Set("Content-Type", "application/x-www-form-urlencoded")
}

resp, err := c.Do(req.WithContext(ctx))
if err != nil {
Expand Down Expand Up @@ -148,7 +161,7 @@ func (c *Client) ExternalLabels(ctx context.Context, base *url.URL) (labels.Labe
span, ctx := tracing.StartSpan(ctx, "/prom_config HTTP[client]")
defer span.Finish()

body, _, err := c.get2xx(ctx, &u)
body, _, err := c.req2xx(ctx, &u, http.MethodGet)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -339,6 +352,7 @@ func (c *Client) Snapshot(ctx context.Context, base *url.URL, skipHead bool) (st
type QueryOptions struct {
Deduplicate bool
PartialResponseStrategy storepb.PartialResponseStrategy
Method string
}

func (p *QueryOptions) AddTo(values url.Values) error {
Expand Down Expand Up @@ -381,7 +395,12 @@ func (c *Client) QueryInstant(ctx context.Context, base *url.URL, query string,
span, ctx := tracing.StartSpan(ctx, "/prom_query_instant HTTP[client]")
defer span.Finish()

body, _, err := c.get2xx(ctx, &u)
method := opts.Method
if method == "" {
method = http.MethodGet
}

body, _, err := c.req2xx(ctx, &u, method)
if err != nil {
return nil, nil, errors.Wrap(err, "read query instant response")
}
Expand Down Expand Up @@ -483,7 +502,7 @@ func (c *Client) QueryRange(ctx context.Context, base *url.URL, query string, st
span, ctx := tracing.StartSpan(ctx, "/prom_query_range HTTP[client]")
defer span.Finish()

body, _, err := c.get2xx(ctx, &u)
body, _, err := c.req2xx(ctx, &u, http.MethodGet)
if err != nil {
return nil, nil, errors.Wrap(err, "read query range response")
}
Expand Down Expand Up @@ -565,7 +584,7 @@ func (c *Client) AlertmanagerAlerts(ctx context.Context, base *url.URL) ([]*mode
span, ctx := tracing.StartSpan(ctx, "/alertmanager_alerts HTTP[client]")
defer span.Finish()

body, _, err := c.get2xx(ctx, &u)
body, _, err := c.req2xx(ctx, &u, http.MethodGet)
if err != nil {
return nil, err
}
Expand All @@ -592,7 +611,7 @@ func (c *Client) get2xxResultWithGRPCErrors(ctx context.Context, spanName string
span, ctx := tracing.StartSpan(ctx, spanName)
defer span.Finish()

body, code, err := c.get2xx(ctx, u)
body, code, err := c.req2xx(ctx, u, http.MethodGet)
if err != nil {
if code, exists := statusToCode[code]; exists && code != 0 {
return status.Error(code, err.Error())
Expand Down