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

Add kube_namespace tag to object count metrics #11734

Merged
merged 1 commit into from
Apr 4, 2022
Merged

Add kube_namespace tag to object count metrics #11734

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
50 changes: 34 additions & 16 deletions kubernetes_state/datadog_checks/kubernetes_state/kubernetes_state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,18 @@ def __init__(self, name, init_config, instances):
'kube_persistentvolume_status_phase': {
'metric_name': 'persistentvolumes.by_phase',
'allowed_labels': ['storageclass', 'phase'],
'label_mapper_override': {
'phase': 'phase'
}, # prevent kube_labels_mapper from converting the persistentvolume phase into pod_phase
},
'kube_service_spec_type': {'metric_name': 'service.count', 'allowed_labels': ['namespace', 'type']},
'kube_namespace_status_phase': {'metric_name': 'namespace.count', 'allowed_labels': ['phase']},
'kube_namespace_status_phase': {
'metric_name': 'namespace.count',
'allowed_labels': ['phase'],
'label_mapper_override': {
'phase': 'phase'
}, # prevent kube_labels_mapper from converting the namespace phase tag into pod_phase
},
'kube_replicaset_owner': {
'metric_name': 'replicaset.count',
'allowed_labels': ['namespace', 'owner_name', 'owner_kind'],
Expand Down Expand Up @@ -900,13 +909,7 @@ def sum_values_by_tags(self, metric, scraper_config):
object_counter = Counter()

for sample in metric.samples:
tags = []
for l in config['allowed_labels']:
tag = self._label_to_tag(l, sample[self.SAMPLE_LABELS], scraper_config)
if tag is None:
tag = self._format_tag(l, "unknown", scraper_config)
tags.append(tag)
tags += scraper_config['custom_tags']
tags = self._tags_for_count(sample, config, scraper_config)
object_counter[tuple(sorted(tags))] += sample[self.SAMPLE_VALUE]

for tags, count in iteritems(object_counter):
Expand All @@ -919,19 +922,31 @@ def count_objects_by_tags(self, metric, scraper_config):
object_counter = Counter()

for sample in metric.samples:
tags = []
for l in config['allowed_labels']:
tag = self._label_to_tag(l, sample[self.SAMPLE_LABELS], scraper_config)
if tag is None:
tag = self._format_tag(l, "unknown", scraper_config)
tags.append(tag)
tags += scraper_config['custom_tags']
tags = self._tags_for_count(sample, config, scraper_config)
object_counter[tuple(sorted(tags))] += 1

for tags, count in iteritems(object_counter):
self.gauge(metric_name, count, tags=list(tags))

def _build_tags(self, label_name, label_value, scraper_config, hostname=None):
def _tags_for_count(self, sample, count_config, scraper_config):
"""
Extracts tags for object count elements.
"""
tags = []
for l in count_config['allowed_labels']:
value = sample[self.SAMPLE_LABELS].get(l, None)
if not value:
tag = self._format_tag(l, "unknown", scraper_config)
tags.append(tag)
continue
l_mapper_override = count_config.get('label_mapper_override', None)
allowed_tags = self._build_tags(l, value, scraper_config, l_mapper_override=l_mapper_override)
if allowed_tags:
tags += allowed_tags
tags += scraper_config['custom_tags']
return tags

def _build_tags(self, label_name, label_value, scraper_config, hostname=None, l_mapper_override=None):
"""
Build a list of formatted tags from `label_name` parameter. It also depend of the
check configuration ('keep_ksm_labels' parameter)
Expand All @@ -941,6 +956,9 @@ def _build_tags(self, label_name, label_value, scraper_config, hostname=None):
tag_name = scraper_config['labels_mapper'].get(label_name, label_name)
# then try to use the kube_labels_mapper
kube_tag_name = kube_labels_mapper.get(tag_name, tag_name)
# try label mapper override
if l_mapper_override:
kube_tag_name = l_mapper_override.get(tag_name, tag_name)
label_value = to_string(label_value).lower()
tags.append('{}:{}'.format(to_string(kube_tag_name), label_value))
if self.keep_ksm_labels and (kube_tag_name != tag_name):
Expand Down
50 changes: 37 additions & 13 deletions kubernetes_state/tests/test_kubernetes_state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,22 +372,22 @@ def test_update_kube_state_metrics(aggregator, instance, check):
# services count
aggregator.assert_metric(
NAMESPACE + '.service.count',
tags=['namespace:default', 'type:clusterip', 'optional:tag1'],
tags=['kube_namespace:default', 'namespace:default', 'type:clusterip', 'optional:tag1'],
value=3,
)
aggregator.assert_metric(
NAMESPACE + '.service.count',
tags=['namespace:default', 'type:loadbalancer', 'optional:tag1'],
tags=['kube_namespace:default', 'namespace:default', 'type:loadbalancer', 'optional:tag1'],
value=2,
)
aggregator.assert_metric(
NAMESPACE + '.service.count',
tags=['namespace:kube-system', 'type:clusterip', 'optional:tag1'],
tags=['kube_namespace:kube-system', 'namespace:kube-system', 'type:clusterip', 'optional:tag1'],
value=4,
)
aggregator.assert_metric(
NAMESPACE + '.service.count',
tags=['namespace:kube-system', 'type:nodeport', 'optional:tag1'],
tags=['kube_namespace:kube-system', 'namespace:kube-system', 'type:nodeport', 'optional:tag1'],
value=1,
)

Expand All @@ -406,53 +406,77 @@ def test_update_kube_state_metrics(aggregator, instance, check):
# replicasets count
aggregator.assert_metric(
NAMESPACE + '.replicaset.count',
tags=['namespace:kube-system', 'owner_kind:deployment', 'owner_name:l7-default-backend', 'optional:tag1'],
tags=[
'kube_namespace:kube-system',
'namespace:kube-system',
'owner_kind:deployment',
'owner_name:l7-default-backend',
'optional:tag1',
],
value=1,
)
aggregator.assert_metric(
NAMESPACE + '.replicaset.count',
tags=['namespace:kube-system', 'owner_kind:deployment', 'owner_name:metrics-server-v0.3.6', 'optional:tag1'],
tags=[
'kube_namespace:kube-system',
'namespace:kube-system',
'owner_kind:deployment',
'owner_name:metrics-server-v0.3.6',
'optional:tag1',
],
value=1,
)
aggregator.assert_metric(
NAMESPACE + '.replicaset.count',
tags=['namespace:kube-system', 'owner_kind:deployment', 'owner_name:kube-dns-autoscaler', 'optional:tag1'],
tags=[
'kube_namespace:kube-system',
'namespace:kube-system',
'owner_kind:deployment',
'owner_name:kube-dns-autoscaler',
'optional:tag1',
],
value=1,
)

# jobs count
aggregator.assert_metric(
NAMESPACE + '.job.count',
tags=['namespace:default', 'owner_kind:cronjob', 'owner_name:a-cronjob', 'optional:tag1'],
tags=[
'kube_namespace:default',
'namespace:default',
'owner_kind:cronjob',
'owner_name:a-cronjob',
'optional:tag1',
],
value=1,
)
aggregator.assert_metric(
NAMESPACE + '.job.count',
tags=['namespace:default', 'owner_kind:<none>', 'owner_name:<none>', 'optional:tag1'],
tags=['kube_namespace:default', 'namespace:default', 'owner_kind:<none>', 'owner_name:<none>', 'optional:tag1'],
value=1,
)

# deployments count
aggregator.assert_metric(
NAMESPACE + '.deployment.count',
tags=['namespace:default', 'optional:tag1'],
tags=['kube_namespace:default', 'namespace:default', 'optional:tag1'],
value=2,
)
aggregator.assert_metric(
NAMESPACE + '.deployment.count',
tags=['namespace:kube-system', 'optional:tag1'],
tags=['kube_namespace:kube-system', 'namespace:kube-system', 'optional:tag1'],
value=2,
)

# statefulset count
aggregator.assert_metric(
NAMESPACE + '.statefulset.count',
tags=['namespace:default', 'optional:tag1'],
tags=['kube_namespace:default', 'namespace:default', 'optional:tag1'],
value=2,
)
aggregator.assert_metric(
NAMESPACE + '.statefulset.count',
tags=['namespace:kube-system', 'optional:tag1'],
tags=['kube_namespace:kube-system', 'namespace:kube-system', 'optional:tag1'],
value=2,
)

Expand Down