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

[Discussion] Rename --labels-metric-allow-list #1421

Closed
mrueg opened this issue Mar 22, 2021 · 1 comment
Closed

[Discussion] Rename --labels-metric-allow-list #1421

mrueg opened this issue Mar 22, 2021 · 1 comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@mrueg
Copy link
Member

mrueg commented Mar 22, 2021

What would you like to be added:

Why is this needed:
--labels-metric-allow-list is inconsistent with --metric-allowlist and there might be a better name for it, that is more descriptive on what it's doing.
Describe the solution you'd like

  • Use one way to write allowlist/allow-list in flags
  • Reorder --labels-metric to --metric-labels
  • Consider using passthrough or filter as with allowlist folks might wonder if there's a denylist as well.

This is how it could read:

      --metric-labels-passthrough string  Comma-separated list of additional Kubernetes label keys that will be used in the resource' labels metric. By default the metric contains only name and namespace labels. To include additional labels provide a list of resource names in their plural form and Kubernetes label keys you would like to allow for them (Example: '=namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...)'
@mrueg mrueg added the kind/feature Categorizes issue or PR as related to a new feature. label Mar 22, 2021
mrueg added a commit to mrueg/kube-state-metrics that referenced this issue Mar 22, 2021
…rough

This might be more clear on what the flag is doing. There were two ways
to spell allow-list / allowlist which it removes as well

Fixes: kubernetes#1421
mrueg added a commit to mrueg/kube-state-metrics that referenced this issue Mar 26, 2021
This might be more clear on what the flag is doing. There were two ways
to spell allow-list / allowlist which it removes as well

Fixes: kubernetes#1421
mrueg added a commit to mrueg/kube-state-metrics that referenced this issue Mar 26, 2021
This might be more clear on what the flag is doing. There were two ways
to spell allow-list / allowlist which it removes as well

Fixes: kubernetes#1421
@mrueg
Copy link
Member Author

mrueg commented Mar 26, 2021

Resolved in mrueg@2a7a96b

@mrueg mrueg closed this as completed Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

1 participant