apitech
/
loki
mirror of https://github.com/grafana/loki
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Retry pr (#7579)

Browse Source 
This is the same PR as https://github.com/grafana/loki/pull/7152 but I
botched the merge when updating the code. This one works

Co-authored-by: Arseniy Antonov <arseny.antonov@gmail.com>
Co-authored-by: Karsten Jeschkies <k@jeschkies.xyz>
pull/7582/head
Travis Patterson 4 years ago committed by GitHub
parent db47e38157
commit af899dcc00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 115 additions and 68 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 2
      cmd/logcli/main.go
  2. 144
      docs/sources/tools/logcli.md
  3. 37
      pkg/logcli/client/client.go

2
cmd/logcli/main.go
Unescape View File

@ -251,6 +251,8 @@ func newQueryClient(app *kingpin.Application) client.Client {
app.Flag("bearer-token", "adds the Authorization header to API requests for authentication purposes. Can also be set using LOKI_BEARER_TOKEN env var.").Default("").Envar("LOKI_BEARER_TOKEN").StringVar(&client.BearerToken)
app.Flag("bearer-token-file", "adds the Authorization header to API requests for authentication purposes. Can also be set using LOKI_BEARER_TOKEN_FILE env var.").Default("").Envar("LOKI_BEARER_TOKEN_FILE").StringVar(&client.BearerTokenFile)
app.Flag("retries", "How many times to retry each query when getting an error response from Loki. Can also be set using LOKI_CLIENT_RETRIES env var.").Default("0").Envar("LOKI_CLIENT_RETRIES").IntVar(&client.Retries)
app.Flag("min-backoff", "Minimum backoff time between retries. Can also be set using LOKI_CLIENT_MIN_BACKOFF env var.").Default("0").Envar("LOKI_CLIENT_MIN_BACKOFF").IntVar(&client.BackoffConfig.MinBackoff)
app.Flag("max-backoff", "Maximum backoff time between retries. Can also be set using LOKI_CLIENT_MAX_BACKOFF env var.").Default("0").Envar("LOKI_CLIENT_MAX_BACKOFF").IntVar(&client.BackoffConfig.MaxBackoff)
app.Flag("auth-header", "The authorization header used. Can also be set using LOKI_AUTH_HEADER env var.").Default("Authorization").Envar("LOKI_AUTH_HEADER").StringVar(&client.AuthHeader)
app.Flag("proxy-url", "The http or https proxy to use when making requests. Can also be set using LOKI_HTTP_PROXY_URL env var.").Default("").Envar("LOKI_HTTP_PROXY_URL").StringVar(&client.ProxyURL)

144
docs/sources/tools/logcli.md
Unescape View File

@ -289,66 +289,96 @@ the Grafana Explore table view), then you should use the "instant-query" command
instead.
Flags:
--help Show context-sensitive help (also try --help-long and
--help-man).
--version Show application version.
-q, --quiet Suppress query metadata
--stats Show query statistics
-o, --output=default Specify output mode [default, raw, jsonl]. raw
suppresses log labels and timestamp.
-z, --timezone=Local Specify the timezone to use when formatting output
timestamps [Local, UTC]
--cpuprofile="" Specify the location for writing a CPU profile.
--memprofile="" Specify the location for writing a memory profile.
--stdin Take input logs from stdin
--addr="http://localhost:3100"
Server address. Can also be set using LOKI_ADDR env
var.
--username="" Username for HTTP basic auth. Can also be set using
LOKI_USERNAME env var.
--password="" Password for HTTP basic auth. Can also be set using
LOKI_PASSWORD env var.
--ca-cert="" Path to the server Certificate Authority. Can also be
set using LOKI_CA_CERT_PATH env var.
--tls-skip-verify Server certificate TLS skip verify.
--cert="" Path to the client certificate. Can also be set using
LOKI_CLIENT_CERT_PATH env var.
--key="" Path to the client certificate key. Can also be set
using LOKI_CLIENT_KEY_PATH env var.
--org-id="" adds X-Scope-OrgID to API requests for representing
tenant ID. Useful for requesting tenant data when
bypassing an auth gateway.
--limit=30 Limit on number of entries to print.
--since=1h Lookback window.
--from=FROM Start looking for logs at this absolute time
(inclusive)
--to=TO Stop looking for logs at this absolute time
(exclusive)
--step=STEP Query resolution step width, for metric queries.
Evaluate the query at the specified step over the
time range.
--interval=INTERVAL Query interval, for log queries. Return entries at
the specified interval, ignoring those between.
**This parameter is experimental, please see Issue
1779**
--batch=1000 Query batch size to use until 'limit' is reached
--forward Scan forwards through logs.
--no-labels Do not print any labels
--exclude-label=EXCLUDE-LABEL ...
Exclude labels given the provided key during output.
--include-label=INCLUDE-LABEL ...
Include labels given the provided key during output.
--labels-length=0 Set a fixed padding to labels
--store-config="" Execute the current query using a configured storage
from a given Loki configuration file.
--help Show context-sensitive help (also try --help-long
and --help-man).
--version Show application version.
-q, --quiet Suppress query metadata
--stats Show query statistics
-o, --output=default Specify output mode [default, raw, jsonl]. raw
suppresses log labels and timestamp.
-z, --timezone=Local Specify the timezone to use when formatting output
timestamps [Local, UTC]
--cpuprofile="" Specify the location for writing a CPU profile.
--memprofile="" Specify the location for writing a memory profile.
--stdin Take input logs from stdin
--addr="http://localhost:3100"
Server address. Can also be set using LOKI_ADDR
env var.
--username="" Username for HTTP basic auth. Can also be set
using LOKI_USERNAME env var.
--password="" Password for HTTP basic auth. Can also be set
using LOKI_PASSWORD env var.
--ca-cert="" Path to the server Certificate Authority. Can also
be set using LOKI_CA_CERT_PATH env var.
--tls-skip-verify Server certificate TLS skip verify. Can also be
set using LOKI_TLS_SKIP_VERIFY env var.
--cert="" Path to the client certificate. Can also be set
using LOKI_CLIENT_CERT_PATH env var.
--key="" Path to the client certificate key. Can also be
set using LOKI_CLIENT_KEY_PATH env var.
--org-id="" adds X-Scope-OrgID to API requests for
representing tenant ID. Useful for requesting
tenant data when bypassing an auth gateway. Can
also be set using LOKI_ORG_ID env var.
--query-tags="" adds X-Query-Tags http header to API requests.
This header value will be part of `metrics.go`
statistics. Useful for tracking the query. Can
also be set using LOKI_QUERY_TAGS env var.
--bearer-token="" adds the Authorization header to API requests for
authentication purposes. Can also be set using
LOKI_BEARER_TOKEN env var.
--bearer-token-file="" adds the Authorization header to API requests for
authentication purposes. Can also be set using
LOKI_BEARER_TOKEN_FILE env var.
--retries=0 How many times to retry each query when getting an
error response from Loki. Can also be set using
LOKI_CLIENT_RETRIES env var.
--min-backoff=0 Minimum backoff time between retries. Can also be
set using LOKI_CLIENT_MIN_BACKOFF env var.
--max-backoff=0 Maximum backoff time between retries. Can also be
set using LOKI_CLIENT_MAX_BACKOFF env var.
--auth-header="Authorization"
The authorization header used. Can also be set
using LOKI_AUTH_HEADER env var.
--proxy-url="" The http or https proxy to use when making
requests. Can also be set using
LOKI_HTTP_PROXY_URL env var.
--limit=30 Limit on number of entries to print.
--since=1h Lookback window.
--from=FROM Start looking for logs at this absolute time
(inclusive)
--to=TO Stop looking for logs at this absolute time
(exclusive)
--step=STEP Query resolution step width, for metric queries.
Evaluate the query at the specified step over the
time range.
--interval=INTERVAL Query interval, for log queries. Return entries at
the specified interval, ignoring those between.
**This parameter is experimental, please see Issue
1779**
--batch=1000 Query batch size to use until 'limit' is reached
--forward Scan forwards through logs.
--no-labels Do not print any labels
--exclude-label=EXCLUDE-LABEL ...
Exclude labels given the provided key during
output.
--include-label=INCLUDE-LABEL ...
Include labels given the provided key during
output.
--labels-length=0 Set a fixed padding to labels
--store-config="" Execute the current query using a configured
storage from a given Loki configuration file.
--remote-schema Execute the current query using a remote schema
retrieved using the configured storage in the
given Loki configuration file.
--remote-schema Execute the current query using a remote schema
retrieved using the configured storage in the given
Loki configuration file.
--colored-output Show output with colored labels
-t, --tail Tail the logs
-f, --follow Alias for --tail
--delay-for=0 Delay in tailing by number of seconds to accumulate
logs for re-ordering
--colored-output Show output with colored labels
-t, --tail Tail the logs
-f, --follow Alias for --tail
--delay-for=0 Delay in tailing by number of seconds to
accumulate logs for re-ordering
Args:
<query> eg '{foo="bar",baz=~".*blip"} |~ ".*error.*"'

37
pkg/logcli/client/client.go
Unescape View File

@ -1,6 +1,7 @@
package client
import (
"context"
"encoding/base64"
"fmt"
"io"
@ -16,6 +17,8 @@ import (
json "github.com/json-iterator/go"
"github.com/prometheus/common/config"
"github.com/grafana/dskit/backoff"
"github.com/grafana/loki/pkg/loghttp"
"github.com/grafana/loki/pkg/logproto"
"github.com/grafana/loki/pkg/util"
@ -47,6 +50,10 @@ type Client interface {
// Tripperware can wrap a roundtripper.
type Tripperware func(http.RoundTripper) http.RoundTripper
type BackoffConfig struct {
MaxBackoff int
MinBackoff int
}
// Client contains fields necessary to query a Loki instance
type DefaultClient struct {
@ -62,6 +69,7 @@ type DefaultClient struct {
QueryTags string
AuthHeader string
ProxyURL string
BackoffConfig BackoffConfig
}
// Query uses the /api/v1/query endpoint to execute an instant query
@ -210,36 +218,43 @@ func (c *DefaultClient) doRequest(path, query string, quiet bool, out interface{
}
var resp *http.Response
attempts := c.Retries + 1
success := false
respErrorMsg := ""
for attempts > 0 {
attempts--
bkcfg := backoff.Config{
MinBackoff: time.Duration(c.BackoffConfig.MinBackoff) * time.Second,
MaxBackoff: time.Duration(c.BackoffConfig.MaxBackoff) * time.Second,
// 0 max-retries for backoff means infinite number of retries.
MaxRetries: c.Retries + 1,
}
backoff := backoff.New(context.Background(), bkcfg)
for {
if !backoff.Ongoing() {
break
}
resp, err = client.Do(req)
if err != nil {
log.Println("error sending request", err)
backoff.Wait()
continue
}
if resp.StatusCode/100 != 2 {
buf, _ := io.ReadAll(resp.Body) // nolint
log.Printf("Error response from server: %s (%v) attempts remaining: %d", string(buf), err, attempts)
log.Printf("Error response from server: %s (%v) attempts remaining: %d", string(buf), err, c.Retries-backoff.NumRetries())
if err := resp.Body.Close(); err != nil {
log.Println("error closing body", err)
}
respErrorMsg = string(buf)
backoff.Wait()
continue
}
success = true
break
}
if !success {
msg := "Run out of attempts while querying the server"
if respErrorMsg != "" {
msg = fmt.Sprintf("%s; response: %s", msg, respErrorMsg)
}
return fmt.Errorf(msg)
return fmt.Errorf("run out of attempts while querying the server")
}
defer func() {

Write Preview
Loading…
Cancel
Save