Introducing Deployment condition status metric in Kubernetes module #35999

gizas · 2023-07-05T10:05:02Z

Enhancement

What does this PR do?

Introduces the kube_deployment_status_condition metric inside kubernetes.state_deployment metrciset. In more details a new field will be indexed called kubernetes.deployment.status

Why is it important?

Relates to elastic/elastic-agent#2995

Introduces

Checklist

My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have made corresponding change to the default configuration files
I have added tests that prove my fix is effective or that my feature works
I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

How to test this PR locally

See information on elastic/elastic-agent#2995

Related issues

mergify · 2023-07-05T10:05:37Z

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @gizas? 🙏.
For such, you'll need to label your PR with:

The upcoming major version of the Elastic Stack
The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-v8./d.0 is the label to automatically backport to the 8./d branch. /d is the digit

ChrsMark

You will need to add the new field in the respective fields.yml file so as to define its mapping.

metricbeat/module/kubernetes/state_deployment/_meta/test/ksm.v2.4.2.plain.expected

ChrsMark · 2023-07-05T10:28:42Z

CHANGELOG.next.asciidoc

@@ -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]


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

elasticmachine · 2023-07-05T10:30:36Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2023-07-06T10:52:11.996+0000
Duration: 81 min 22 sec

Test stats 🧪

Test	Results
Failed	0
Passed	4985
Skipped	1039
Total	6024

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/package : Generate the packages and run the E2E tests.
/beats-tester : Run the installation tests with beats-tester.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

tetianakravchenko

I think that the original metric should as well
https://github.com/elastic/beats/blob/ac1d127d6868caff2f1bbbc670bbfff7f88930fc/metricbeat/module/kubernetes/_meta/test/ksm.v2.4.2.plain

tetianakravchenko · 2023-07-05T10:29:02Z

metricbeat/module/kubernetes/state_deployment/_meta/test/ksm.v2.6.0.plain.expected

@@ -59,6 +59,10 @@
 		"MetricSetFields": {
 			"name": "coredns",
 			"paused": false,
+			"status": {
+                "available": "true",


formatting seems to be not correct

tetianakravchenko · 2023-07-05T10:37:01Z

metricbeat/module/kubernetes/state_deployment/state_deployment.go

+		/*
+			This is how deployment_status_condition field will be exported:
+
+			kube_deployment_status_condition{namespace="default",deployment="test-deployment",condition="Available",status="true"} 0


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

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

gizas · 2023-07-05T10:54:41Z

You will need to add the new field in the respective fields.yml file so as to define its mapping.

Done thanks !

ChrsMark · 2023-07-05T11:46:44Z

metricbeat/module/kubernetes/state_deployment/_meta/test/ksm.v2.6.0.plain.expected

+			"status": {
+				"available": "true",
+				"progressing": "true"
+        	},


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.

Blew my brain :) Fixed thanks @ChrsMark

CHANGELOG.next.asciidoc

Co-authored-by: Chris Mark <chrismarkou92@gmail.com>

…tion

…lastic#35999) * adding deployment condition status * Update CHANGELOG.next.asciidoc * fixing unittests --------- Co-authored-by: Chris Mark <chrismarkou92@gmail.com>

gizas added 2 commits July 5, 2023 11:47

adding deployment condition status

dc09727

adding comments for the condition field

dc7df0a

gizas requested a review from a team as a code owner July 5, 2023 10:05

gizas self-assigned this Jul 5, 2023

gizas requested review from ChrsMark and tetianakravchenko July 5, 2023 10:05

botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jul 5, 2023

This was referenced Jul 5, 2023

Adding deployment condition status field in kube State Deployment metricset elastic/elastic-agent#2995

Closed

[Kubenretes Integration] Adding deployment condition status in kube state deployment dataset elastic/integrations#6821

Merged

gizas changed the title ~~Deployment condition~~ Introducing Deployment condition status metric in Kubernetes module Jul 5, 2023

updating changelog

ac1d127

gizas added the Team:Cloudnative-Monitoring Label for the Cloud Native Monitoring team label Jul 5, 2023

botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jul 5, 2023

ChrsMark requested changes Jul 5, 2023

View reviewed changes

gizas added 4 commits July 5, 2023 13:30

Update ksm.v2.7.0.plain.expected

6f59712

Update ksm.v2.6.0.plain.expected

02d101f

Update ksm.v2.5.0.plain.expected

91cdc3d

Update ksm.v2.4.2.plain.expected

4478e0c

tetianakravchenko reviewed Jul 5, 2023

View reviewed changes

updating tests spaces

39285a8

tetianakravchenko reviewed Jul 5, 2023

View reviewed changes

gizas added 2 commits July 5, 2023 13:40

updating fields for state deployment

7c59449

updating fields for state deployment

c241465

ChrsMark reviewed Jul 5, 2023

View reviewed changes

fixing identation

743eb56

tetianakravchenko approved these changes Jul 5, 2023

View reviewed changes

ChrsMark reviewed Jul 5, 2023

View reviewed changes

CHANGELOG.next.asciidoc Outdated Show resolved Hide resolved

Update CHANGELOG.next.asciidoc

c789e83

Co-authored-by: Chris Mark <chrismarkou92@gmail.com>

gizas requested a review from ChrsMark July 6, 2023 09:05

gizas added 2 commits July 6, 2023 12:07

Merge branch 'main' of github.com:elastic/beats into deployment_condi…

07005c5

…tion

fixing unittests

b3db4cd

ChrsMark approved these changes Jul 6, 2023

View reviewed changes

gizas merged commit c903cb0 into main Jul 6, 2023
27 checks passed

gizas deleted the deployment_condition branch July 6, 2023 12:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introducing Deployment condition status metric in Kubernetes module #35999

Introducing Deployment condition status metric in Kubernetes module #35999

gizas commented Jul 5, 2023 •

edited

mergify bot commented Jul 5, 2023

ChrsMark left a comment •

edited

ChrsMark Jul 5, 2023

gizas Jul 5, 2023

elasticmachine commented Jul 5, 2023 •

edited by jenkins-beats-ci bot

Build stats

Test stats 🧪

tetianakravchenko left a comment

tetianakravchenko Jul 5, 2023

gizas Jul 5, 2023

tetianakravchenko Jul 5, 2023

gizas Jul 5, 2023

gizas commented Jul 5, 2023

ChrsMark Jul 5, 2023

gizas Jul 5, 2023

		@@ -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]

	// 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

Introducing Deployment condition status metric in Kubernetes module #35999

Introducing Deployment condition status metric in Kubernetes module #35999

Conversation

gizas commented Jul 5, 2023 • edited

What does this PR do?

Why is it important?

Checklist

How to test this PR locally

Related issues

mergify bot commented Jul 5, 2023

ChrsMark left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Jul 5, 2023 • edited by jenkins-beats-ci bot

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

tetianakravchenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gizas commented Jul 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gizas commented Jul 5, 2023 •

edited

ChrsMark left a comment •

edited

elasticmachine commented Jul 5, 2023 •

edited by jenkins-beats-ci bot