Skip to content

change: relax kube_.+_created to allow namespaces #2684

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

change: relax kube_.+_created to allow namespaces #2684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 29 additions & 0 deletions docs/customizations/kube-state-metrics-custom-denylist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
### Supplying a custom deny-list to Kube State Metrics (KSM)

Users can supply their own custom deny-list that replaces the default one and filters out the specified metrics from being generated by KSM.

The following example shows how to supply a custom deny-list:

```yaml mdox-exec="cat examples/jsonnet-snippets/kube-state-metrics-custom-denylist.jsonnet"
(import 'kube-prometheus/main.libsonnet') +
(import 'kube-prometheus/addons/ksm-lite.libsonnet') +
{
ksmConfig: {
ksmDenyList: [
'^kube_(?=namespace).*_created$',
'^kube_.+_metadata_resource_version$',
'^kube_replicaset_metadata_generation$',
'^kube_replicaset_status_observed_generation$',
'^kube_pod_restart_policy$',
'^kube_pod_init_container_status_terminated$',
'^kube_pod_init_container_status_running$',
'^kube_pod_container_status_terminated$',
'^kube_pod_container_status_running$',
'^kube_pod_completion_time$',
'^kube_pod_status_scheduled$',
],
},
}
```

The example above makes use of a [feature](https://github.com/kubernetes/kube-state-metrics/pull/2616) introduced in the v2.16.0 release of KSM, which allows users to utilize lookarounds within regular expressions. As such, it keeps almost all of the default deny-list, but filters out only the `kube_namespace_created` metric allowing that to be generated.
19 changes: 19 additions & 0 deletions examples/jsonnet-snippets/kube-state-metrics-custom-denylist.jsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
(import 'kube-prometheus/main.libsonnet') +
(import 'kube-prometheus/addons/ksm-lite.libsonnet') +
{
ksmConfig: {
ksmDenyList: [
'^kube_(?=namespace).*_created$',
'^kube_.+_metadata_resource_version$',
'^kube_replicaset_metadata_generation$',
'^kube_replicaset_status_observed_generation$',
'^kube_pod_restart_policy$',
'^kube_pod_init_container_status_terminated$',
'^kube_pod_init_container_status_running$',
'^kube_pod_container_status_terminated$',
'^kube_pod_container_status_running$',
'^kube_pod_completion_time$',
'^kube_pod_status_scheduled$',
],
},
}
50 changes: 28 additions & 22 deletions jsonnet/kube-prometheus/addons/ksm-lite.libsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,39 @@
local addArgs(args, name, containers) = std.map(
function(c) if c.name == name then
c {
args+: args,
}
else c,
containers,
);
local addArgs(args, name, containers) =
std.map(
function(c)
if c.name == name then
c {
args+: args,
}
else
c,
containers,
);

{
ksmConfig+:: {
ksmDenyList: [
'^kube_.+_created$',
'^kube_.+_metadata_resource_version$',
'^kube_replicaset_metadata_generation$',
'^kube_replicaset_status_observed_generation$',
'^kube_pod_restart_policy$',
'^kube_pod_init_container_status_terminated$',
'^kube_pod_init_container_status_running$',
'^kube_pod_container_status_terminated$',
'^kube_pod_container_status_running$',
'^kube_pod_completion_time$',
'^kube_pod_status_scheduled$',
],
},

kubeStateMetrics+: {
deployment+: {
spec+: {
template+: {
spec+: {
containers: addArgs(
[|||
--metric-denylist=
^kube_.+_created$,
^kube_.+_metadata_resource_version$,
^kube_replicaset_metadata_generation$,
^kube_replicaset_status_observed_generation$,
^kube_pod_restart_policy$,
^kube_pod_init_container_status_terminated$,
^kube_pod_init_container_status_running$,
^kube_pod_container_status_terminated$,
^kube_pod_container_status_running$,
^kube_pod_completion_time$,
^kube_pod_status_scheduled$
|||],
['--metric-denylist=\n' + std.join(',\n', $.ksmConfig.ksmDenyList) + '\n'],
'kube-state-metrics',
super.containers
),
Expand Down
Loading