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.

Sign up for GitHub

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

[promtail] Mark promtail single client config flags and config file block as deprecated #5842

Merged
merged 4 commits into from
Apr 12, 2022
Merged

[promtail] Mark promtail single client config flags and config file block as deprecated #5842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
400a552
Mark promtail single client config flags and config file block as
cstyan Apr 8, 2022
2662bed
Update some promtail docs examples that still use `client` instead of
cstyan Apr 8, 2022
f797bd2
Fix imports.
cstyan Apr 11, 2022
909b242
properly format url as an array item since we changed to clients from
cstyan Apr 11, 2022
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
18 changes: 9 additions & 9 deletions clients/pkg/promtail/client/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,17 @@ type Config struct {
// RegisterFlags with prefix registers flags where every name is prefixed by
// prefix. If prefix is a non-empty string, prefix should end with a period.
func (c *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
f.Var(&c.URL, prefix+"client.url", "URL of log server")
f.DurationVar(&c.BatchWait, prefix+"client.batch-wait", BatchWait, "Maximum wait period before sending batch.")
f.IntVar(&c.BatchSize, prefix+"client.batch-size-bytes", BatchSize, "Maximum batch size to accrue before sending. ")
f.Var(&c.URL, prefix+"client.url", "URL of log server (deprecated).")
f.DurationVar(&c.BatchWait, prefix+"client.batch-wait", BatchWait, "Maximum wait period before sending batch (deprecated).")
f.IntVar(&c.BatchSize, prefix+"client.batch-size-bytes", BatchSize, "Maximum batch size to accrue before sending (deprecated).")
// Default backoff schedule: 0.5s, 1s, 2s, 4s, 8s, 16s, 32s, 64s, 128s, 256s(4.267m) For a total time of 511.5s(8.5m) before logs are lost
f.IntVar(&c.BackoffConfig.MaxRetries, prefix+"client.max-retries", MaxRetries, "Maximum number of retires when sending batches.")
f.DurationVar(&c.BackoffConfig.MinBackoff, prefix+"client.min-backoff", MinBackoff, "Initial backoff time between retries.")
f.DurationVar(&c.BackoffConfig.MaxBackoff, prefix+"client.max-backoff", MaxBackoff, "Maximum backoff time between retries.")
f.DurationVar(&c.Timeout, prefix+"client.timeout", Timeout, "Maximum time to wait for server to respond to a request")
f.Var(&c.ExternalLabels, prefix+"client.external-labels", "list of external labels to add to each log (e.g: --client.external-labels=lb1=v1,lb2=v2)")
f.IntVar(&c.BackoffConfig.MaxRetries, prefix+"client.max-retries", MaxRetries, "Maximum number of retires when sending batches (deprecated).")
f.DurationVar(&c.BackoffConfig.MinBackoff, prefix+"client.min-backoff", MinBackoff, "Initial backoff time between retries (deprecated).")
f.DurationVar(&c.BackoffConfig.MaxBackoff, prefix+"client.max-backoff", MaxBackoff, "Maximum backoff time between retries (deprecated).")
f.DurationVar(&c.Timeout, prefix+"client.timeout", Timeout, "Maximum time to wait for server to respond to a request (deprecated).")
f.Var(&c.ExternalLabels, prefix+"client.external-labels", "list of external labels to add to each log (e.g: --client.external-labels=lb1=v1,lb2=v2) (deprecated).")

f.StringVar(&c.TenantID, prefix+"client.tenant-id", "", "Tenant ID to use when pushing logs to Loki.")
f.StringVar(&c.TenantID, prefix+"client.tenant-id", "", "Tenant ID to use when pushing logs to Loki (deprecated).")
}

// RegisterFlags registers flags.
Expand Down
5 changes: 4 additions & 1 deletion clients/pkg/promtail/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import (
"flag"
"fmt"

"github.com/go-kit/log"
"github.com/go-kit/log/level"
dskit_flagext "github.com/grafana/dskit/flagext"

yaml "gopkg.in/yaml.v2"
Expand Down Expand Up @@ -59,8 +61,9 @@ func (c Config) String() string {
return string(b)
}

func (c *Config) Setup() {
func (c *Config) Setup(l log.Logger) {
if c.ClientConfig.URL.URL != nil {
level.Warn(l).Log("msg", "use of CLI client.* and config file Client block are both deprecated in favour of the config file Clients block and will be removed in a future release")
// if a single client config is used we add it to the multiple client config for backward compatibility
c.ClientConfigs = append(c.ClientConfigs, c.ClientConfig)
}
Expand Down
3 changes: 2 additions & 1 deletion clients/pkg/promtail/config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"net/url"
"testing"

"github.com/go-kit/log"
dskitflagext "github.com/grafana/dskit/flagext"
"github.com/prometheus/common/model"
"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -137,7 +138,7 @@ func TestConfig_Setup(t *testing.T) {
} {
tt := tt
t.Run(fmt.Sprintf("%d", i), func(t *testing.T) {
tt.in.Setup()
tt.in.Setup(log.NewNopLogger())
require.Equal(t, tt.expected, tt.in)
})
}
Expand Down
2 changes: 1 addition & 1 deletion clients/pkg/promtail/promtail.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ func New(cfg config.Config, metrics *client.Metrics, dryRun bool, opts ...Option
o(promtail)
}

cfg.Setup()
cfg.Setup(promtail.logger)

if cfg.LimitsConfig.ReadlineRateEnabled {
stages.SetReadLineRateLimiter(cfg.LimitsConfig.ReadlineRate, cfg.LimitsConfig.ReadlineBurst, cfg.LimitsConfig.ReadlineRateDrop)
Expand Down
8 changes: 4 additions & 4 deletions docs/sources/clients/promtail/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1797,8 +1797,8 @@ server:
positions:
filename: /var/log/positions.yaml # This location needs to be writeable by Promtail.

client:
url: http://ip_or_hostname_where_Loki_run:3100/loki/api/v1/push
clients:
Copy link
Contributor

Choose a reason for hiding this comment

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

Q: if we are chaning client -> clients then below url should also be changed to array?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, thanks for catching this

- url: http://ip_or_hostname_where_Loki_run:3100/loki/api/v1/push

scrape_configs:
- job_name: system
Expand Down Expand Up @@ -1826,8 +1826,8 @@ server:
positions:
filename: /var/log/positions.yaml # This location needs to be writeable by Promtail.

client:
url: http://ip_or_hostname_where_Loki_run:3100/loki/api/v1/push
clients:
- url: http://ip_or_hostname_where_Loki_run:3100/loki/api/v1/push

scrape_configs:
- job_name: system
Expand Down