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

[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

merged 4 commits into from
Apr 12, 2022

Conversation

cstyan
Copy link
Contributor

@cstyan cstyan commented Apr 8, 2022

It can be confusing to end users to try and understand the interaction between setting client, clients (in the config file), and cli flags client.* (such as client.url) as to which has priority and what will happen if multiple are set. See this community slack thread.

Here I am proposing that we mark the config file client block and CLI client.* flags as deprecated, including a warning log line when they are used, in preparation for removing them in a future release.

Signed-off-by: Callum Styan callumstyan@gmail.com

Checklist

  • Documentation added
  • Add an entry in the CHANGELOG.md about the changes.

cstyan added 2 commits April 8, 2022 13:20
deprecated.

Signed-off-by: Callum Styan <callumstyan@gmail.com>
`clients`.

Signed-off-by: Callum Styan <callumstyan@gmail.com>
@cstyan cstyan requested review from KMiller-Grafana and a team as code owners April 8, 2022 20:33
Signed-off-by: Callum Styan <callumstyan@gmail.com>
Copy link
Contributor

@kavirajk kavirajk left a comment

Choose a reason for hiding this comment

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

LGTM. left one small comment.

@@ -1797,7 +1797,7 @@ server:
positions:
filename: /var/log/positions.yaml # This location needs to be writeable by Promtail.

client:
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

client

Signed-off-by: Callum Styan <callumstyan@gmail.com>
@kavirajk kavirajk merged commit 800b7c6 into grafana:main Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants