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 reason tag to kubernetes_state.job.failed #25103

Merged
merged 9 commits into from
May 9, 2024
Merged

Add reason tag to kubernetes_state.job.failed #25103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1be85ef
add reason tags to KSM and kubelet metrics
keisku Apr 25, 2024
13f3195
add releasenote
keisku Apr 27, 2024
b014cde
Revert "add releasenote"
keisku May 1, 2024
6a7ae4a
Revert "add reason tags to KSM and kubelet metrics"
keisku May 1, 2024
28f358d
Merge remote-tracking branch 'origin/main' into keisku/support1663984
keisku May 1, 2024
313399c
add reason tag to kubernetes_state.job.failed
keisku May 1, 2024
2805b99
make validJobReason case-insensive
keisku May 1, 2024
a56a5ed
remove empty reason tag as well
keisku May 1, 2024
1d21ebf
rename to validJobFailureReason
keisku May 1, 2024
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
22 changes: 17 additions & 5 deletions pkg/collector/corechecks/cluster/ksm/kubernetes_state_transformers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,10 +421,26 @@ func trimJobTag(tag string) (string, bool) {
return trimmed, tag != trimmed
}

var jobFailureReasons = map[string]struct{}{
"backofflimitexceeded": {},
"deadlineexceeded": {},
Copy link
Contributor Author

@keisku keisku May 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Unless we update kube-state-metrics/v2 to at least v2.9.0 that contains the bug fix, kubernetes/kube-state-metrics#2046, we cannot add reason:deadlineexceeded to kubernetes_state.job.failed.

kube-state-metrics/v2 update should be in a different PR as the context below.

Why do currently we use k8s.io/kube-state-metrics/v2 v2.8.2?
This is because we have to align with interface change before bumping up the kube-state-metrics/v2.

Current implementations in
https://github.com/DataDog/datadog-agent/tree/2feb83da045935df7986e56504bd297922a32ebb/pkg/collector/corechecks/cluster/ksm/customresources don't follow type RegistryFactory interface updated by kubernetes/kube-state-metrics#1851.

}

func validJobFailureReason(reason string) bool {
_, ok := jobFailureReasons[strings.ToLower(reason)]
return ok
}

// validateJob detects active jobs and adds the `kube_cronjob` tag
func validateJob(val float64, tags []string) ([]string, bool) {
kubeCronjob := ""
for _, tag := range tags {
for i, tag := range tags {
if strings.HasPrefix(tag, "reason:") {
if v := strings.TrimPrefix(tag, "reason:"); !validJobFailureReason(v) {
tags = append(tags[:i], tags[i+1:]...)
continue
}
}
split := strings.Split(tag, ":")
if len(split) == 2 && split[0] == "kube_job" || split[0] == "job" || split[0] == "job_name" {
// Trim the timestamp suffix to avoid high cardinality
Expand Down Expand Up @@ -482,10 +498,6 @@ func jobStatusFailedTransformer(s sender.Sender, name string, metric ksmstore.DD
return
}

if reasonTagIndex != -1 {
tags = append(tags[:reasonTagIndex], tags[reasonTagIndex+1:]...)
}

Comment on lines -485 to -488
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This logic is now in validateJob().

jobMetric(s, metric, ksmMetricPrefix+"job.failed", hostname, tags)
}

Expand Down
142 changes: 141 additions & 1 deletion pkg/collector/corechecks/cluster/ksm/kubernetes_state_transformers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,99 @@ func Test_jobStatusFailedTransformer(t *testing.T) {
},
},
{
name: "irrelevant reason",
name: "BackoffLimitExceeded and value 0",
args: args{
name: "kube_job_status_failed",
metric: ksmstore.DDMetric{
Val: 0,
Labels: map[string]string{
"job": "foo-1509998340",
"namespace": "default",
"reason": "BackoffLimitExceeded",
},
},
tags: []string{"job:foo-1509998340", "namespace:default", "reason:backofflimitexceeded"},
},
expected: nil,
},
{
name: "BackoffLimitExceeded and value 1",
args: args{
name: "kube_job_status_failed",
metric: ksmstore.DDMetric{
Val: 1,
Labels: map[string]string{
"job": "foo-1509998340",
"namespace": "default",
"reason": "BackoffLimitExceeded",
},
},
tags: []string{"job:foo-1509998340", "namespace:default", "reason:backofflimitexceeded"},
},
expected: &metricsExpected{
name: "kubernetes_state.job.failed",
val: 1,
tags: []string{"kube_cronjob:foo", "namespace:default", "reason:backofflimitexceeded"},
},
},
{
name: "DeadlineExceeded and value 0",
args: args{
name: "kube_job_status_failed",
metric: ksmstore.DDMetric{
Val: 0,
Labels: map[string]string{
"job": "foo-1509998340",
"namespace": "default",
"reason": "DeadlineExceeded",
},
},
tags: []string{"job:foo-1509998340", "namespace:default", "reason:deadlineexceeded"},
},
expected: nil,
},
{
name: "DeadlineExceeded and value 1.0",
args: args{
name: "kube_job_status_failed",
metric: ksmstore.DDMetric{
Val: 1,
Labels: map[string]string{
"job": "foo-1509998340",
"namespace": "default",
"reason": "DeadlineExceeded",
},
},
tags: []string{"job:foo-1509998340", "namespace:default", "reason:deadlineexceeded"},
},
expected: &metricsExpected{
name: "kubernetes_state.job.failed",
val: 1,
tags: []string{"kube_cronjob:foo", "namespace:default", "reason:deadlineexceeded"},
},
},
{
name: "DeadlineExceeded and value 1.0",
args: args{
name: "kube_job_status_failed",
metric: ksmstore.DDMetric{
Val: 1,
Labels: map[string]string{
"job": "foo-1509998340",
"namespace": "default",
"reason": "DeadlineExceeded",
},
},
tags: []string{"job:foo-1509998340", "namespace:default", "reason:deadlineexceeded"},
},
expected: &metricsExpected{
name: "kubernetes_state.job.failed",
val: 1,
tags: []string{"kube_cronjob:foo", "namespace:default", "reason:deadlineexceeded"},
},
},
{
name: "Evicted and 0",
args: args{
name: "kube_job_status_failed",
metric: ksmstore.DDMetric{
Expand All @@ -559,6 +651,26 @@ func Test_jobStatusFailedTransformer(t *testing.T) {
},
expected: nil,
},
{
name: "Evicted and 1",
args: args{
name: "kube_job_status_failed",
metric: ksmstore.DDMetric{
Val: 1,
Labels: map[string]string{
"job": "foo-1509998340",
"namespace": "default",
"reason": "Evicted",
},
},
tags: []string{"job:foo-1509998340", "namespace:default", "reason:Evicted"},
},
expected: &metricsExpected{
name: "kubernetes_state.job.failed",
val: 1,
tags: []string{"kube_cronjob:foo", "namespace:default"},
},
},
{
name: "inactive",
args: args{
Expand Down Expand Up @@ -1562,6 +1674,34 @@ func Test_validateJob(t *testing.T) {
want: []string{"foo:bar", "job_name:foo"},
want1: true,
},
{
name: "reason:BackoffLimitExceeded",
val: 1.0,
tags: []string{"foo:bar", "job_name:foo-1600167000", "kube_job:foo-1600167000", "reason:BackoffLimitExceeded"},
want: []string{"foo:bar", "job_name:foo-1600167000", "kube_job:foo-1600167000", "kube_cronjob:foo", "reason:BackoffLimitExceeded"},
want1: true,
},
{
name: "reason:DeadLineExceeded",
val: 1.0,
tags: []string{"foo:bar", "job_name:foo-1600167000", "reason:DeadLineExceeded", "kube_job:foo-1600167000"},
want: []string{"foo:bar", "job_name:foo-1600167000", "kube_job:foo-1600167000", "kube_cronjob:foo", "reason:DeadLineExceeded"},
want1: true,
},
{
name: "empty reason tag",
val: 1.0,
tags: []string{"reason:", "foo:bar", "job_name:foo-1600167000", "kube_job:foo-1600167000"},
want: []string{"foo:bar", "job_name:foo-1600167000", "kube_job:foo-1600167000", "kube_cronjob:foo"},
want1: true,
},
{
name: "invalid reason",
val: 1.0,
tags: []string{"foo:bar", "reason:error", "job_name:foo-1600167000", "kube_job:foo-1600167000"},
want: []string{"foo:bar", "job_name:foo-1600167000", "kube_job:foo-1600167000", "kube_cronjob:foo"},
want1: true,
},
{
name: "invalid",
val: 0.0,
Expand Down
12 changes: 12 additions & 0 deletions releasenotes-dca/notes/add-reason-tags-to-kube_job_status_failed-755bbfbb67d7e4c6.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Each section from every release note are combined when the
# CHANGELOG.rst is rendered. So the text needs to be worded so that
# it does not depend on any information only available in another
# section. This may mean repeating some details, but each section
# must be readable independently of the other.
#
# Each section note must be formatted as reStructuredText.
---
enhancements:
- |
Add ``reason:backofflimitexceeded,deadlineexceeded`` to the
``kubernetes_state.job.failed`` metric to help users understand why a job failed.
Loading