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

Jump to bottom

Introducing Deployment condition status metric in Kubernetes module #35999

Merged
merged 14 commits into from
Jul 6, 2023
Merged

Introducing Deployment condition status metric in Kubernetes module #35999

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
dc09727
adding deployment condition status
gizas Jul 5, 2023
dc7df0a
adding comments for the condition field
gizas Jul 5, 2023
ac1d127
updating changelog
gizas Jul 5, 2023
6f59712
Update ksm.v2.7.0.plain.expected
gizas Jul 5, 2023
02d101f
Update ksm.v2.6.0.plain.expected
gizas Jul 5, 2023
91cdc3d
Update ksm.v2.5.0.plain.expected
gizas Jul 5, 2023
4478e0c
Update ksm.v2.4.2.plain.expected
gizas Jul 5, 2023
39285a8
updating tests spaces
gizas Jul 5, 2023
7c59449
updating fields for state deployment
gizas Jul 5, 2023
c241465
updating fields for state deployment
gizas Jul 5, 2023
743eb56
fixing identation
gizas Jul 5, 2023
c789e83
Update CHANGELOG.next.asciidoc
gizas Jul 6, 2023
07005c5
Merge branch 'main' of github.com:elastic/beats into deployment_condi…
gizas Jul 6, 2023
b3db4cd
fixing unittests
gizas Jul 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ https://github.com/elastic/beats/compare/v8.8.1\...main[Check the HEAD diff]


*Metricbeat*
- Introducing Deployment condition status metric in Kubernetes module {pull}35999[35999]
Copy link
Member

Choose a reason for hiding this comment

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

This is not a breaking change. Hence it should go in ==== Added section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed



*Osquerybeat*
Expand Down
6 changes: 5 additions & 1 deletion metricbeat/module/kubernetes/state_deployment/_meta/test/ksm.v2.4.2.plain.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@
"MetricSetFields": {
"name": "coredns",
"paused": false,
"status": {
ChrsMark marked this conversation as resolved.
Show resolved Hide resolved
"available": "true",
"progressing": "true"
},
"replicas": {
"available": 2,
"desired": 2,
Expand All @@ -77,4 +81,4 @@
"Period": 0,
"DisableTimeSeries": false
}
]
]
6 changes: 5 additions & 1 deletion metricbeat/module/kubernetes/state_deployment/_meta/test/ksm.v2.5.0.plain.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@
"MetricSetFields": {
"name": "coredns",
"paused": false,
"status": {
"available": "true",
"progressing": "true"
},
"replicas": {
"available": 2,
"desired": 2,
Expand All @@ -77,4 +81,4 @@
"Period": 0,
"DisableTimeSeries": false
}
]
]
6 changes: 5 additions & 1 deletion metricbeat/module/kubernetes/state_deployment/_meta/test/ksm.v2.6.0.plain.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@
"MetricSetFields": {
"name": "coredns",
"paused": false,
"status": {
"available": "true",
"progressing": "true"
},
Copy link
Member

Choose a reason for hiding this comment

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

This bracket should be one layer in, right? Like https://github.com/elastic/beats/pull/35999/files#diff-050ad6dbacd48af0a47953cade64df8f81c2104c232ddc15dfc1feff29d48badR40-R43.

Same for the rest of them.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Blew my brain :) Fixed thanks @ChrsMark

"replicas": {
"available": 2,
"desired": 2,
Expand All @@ -77,4 +81,4 @@
"Period": 0,
"DisableTimeSeries": false
}
]
]
6 changes: 5 additions & 1 deletion metricbeat/module/kubernetes/state_deployment/_meta/test/ksm.v2.7.0.plain.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@
"MetricSetFields": {
"name": "coredns",
"paused": false,
"status": {
"available": "true",
"progressing": "true"
},
"replicas": {
"available": 2,
"desired": 2,
Expand All @@ -77,4 +81,4 @@
"Period": 0,
"DisableTimeSeries": false
}
]
]
4 changes: 4 additions & 0 deletions metricbeat/module/kubernetes/state_deployment/_meta/testdata/docs.plain-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@
"deployment": {
"name": "local-path-provisioner",
"paused": false,
"status": {
"available": "true",
"progressing": "true"
},
"replicas": {
"available": 1,
"desired": 1,
Expand Down
4 changes: 4 additions & 0 deletions metricbeat/module/kubernetes/state_deployment/_meta/testdata/ksm.v2.4.2.plain-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@
"deployment": {
"name": "coredns",
"paused": false,
"status": {
"available": "true",
"progressing": "true"
},
"replicas": {
"available": 2,
"desired": 2,
Expand Down
4 changes: 4 additions & 0 deletions metricbeat/module/kubernetes/state_deployment/_meta/testdata/ksm.v2.5.0.plain-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@
"deployment": {
"name": "coredns",
"paused": false,
"status": {
"available": "true",
"progressing": "true"
},
"replicas": {
"available": 2,
"desired": 2,
Expand Down
4 changes: 4 additions & 0 deletions metricbeat/module/kubernetes/state_deployment/_meta/testdata/ksm.v2.6.0.plain-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@
"deployment": {
"name": "local-path-provisioner",
"paused": false,
"status": {
"available": "true",
"progressing": "true"
},
"replicas": {
"available": 1,
"desired": 1,
Expand Down
4 changes: 4 additions & 0 deletions metricbeat/module/kubernetes/state_deployment/_meta/testdata/ksm.v2.7.0.plain-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@
"deployment": {
"name": "coredns",
"paused": false,
"status": {
"available": "true",
"progressing": "true"
},
"replicas": {
"available": 2,
"desired": 2,
Expand Down
18 changes: 17 additions & 1 deletion metricbeat/module/kubernetes/state_deployment/state_deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,23 @@ var mapping = &p.MetricsMapping{
"kube_deployment_status_replicas_unavailable": p.Metric("replicas.unavailable"),
"kube_deployment_status_replicas_available": p.Metric("replicas.available"),
"kube_deployment_spec_replicas": p.Metric("replicas.desired"),
"kube_deployment_spec_paused": p.BooleanMetric("paused"),
/*
This is how deployment_status_condition field will be exported:

kube_deployment_status_condition{namespace="default",deployment="test-deployment",condition="Available",status="true"} 0
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it should be enough to add it in corresponding plain file - https://github.com/elastic/beats/blob/ac1d127d6868caff2f1bbbc670bbfff7f88930fc/metricbeat/module/kubernetes/_meta/test/ksm.v2.4.2.plain, instead of this comment

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is already there see line 222

It is more alligned to this comment:

beats/metricbeat/module/kubernetes/state_job/state_job.go

Lines 41 to 46 in ac1d127

// These fields will be set to "true", "false", or "unknown" based on input that looks
// like this:
//
// kube_job_complete{namespace="default",job_name="timer-27074308",condition="true"} 1
// kube_job_complete{namespace="default",job_name="timer-27074308",condition="false"} 0
// kube_job_complete{namespace="default",job_name="timer-27074308",condition="unknown"} 0

I found it helpful when first looked the code, because you can not understand how the p.LabelMatric works from first glance.

Let me know if you think is obsolete and I can remove it

kube_deployment_status_condition{namespace="default",deployment="test-deployment",condition="Available",status="false"} 1
kube_deployment_status_condition{namespace="default",deployment="test-deployment",condition="Available",status="unknown"} 0
kube_deployment_status_condition{namespace="default",deployment="test-deployment",condition="Progressing",status="true"} 1
kube_deployment_status_condition{namespace="default",deployment="test-deployment",condition="Progressing",status="false"} 0
kube_deployment_status_condition{namespace="default",deployment="test-deployment",condition="Progressing",status="unknown"} 0
*/
"kube_deployment_status_condition": p.LabelMetric("status", "status", p.OpFilterMap(
"condition", map[string]string{
"Progressing": "progressing",
"Available": "available",
},
)), //The current status conditions of a deployment
"kube_deployment_spec_paused": p.BooleanMetric("paused"),
},

Labels: map[string]p.LabelMap{
Expand Down