Add description label to ArgoCDSyncAlert #704

Rizwana777 · 2024-05-15T14:21:07Z

What type of PR is this?
Added "description" label to ArgoCDSyncAlert

JIRA - https://issues.redhat.com/browse/GITOPS-2639

Signed-off-by: Rizwana777 <[email protected]>

openshift-ci · 2024-05-15T14:21:16Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign rnapoles-rh for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci · 2024-05-15T14:21:21Z

Hi @Rizwana777. Thanks for your PR.

I'm waiting for a redhat-developer member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

svghadi · 2024-05-15T16:55:08Z

/ok-to-test

svghadi · 2024-05-16T13:19:01Z

/lgtm

simonpasquier

The description should go into the annotations field and you want a summary entry too.

https://github.com/openshift/enhancements/blob/master/enhancements/monitoring/alerting-consistency.md#style-guide

simonpasquier · 2024-05-16T13:52:57Z

controllers/argocd_metrics_controller.go

 						Labels: map[string]string{
-							"severity": "warning",
+							"severity":    "warning",
+							"description": "ArgoCDSyncAlert is listed if Argo CD app is out of sync",


it could be interesting to include alert labels in the rendered string to help troubleshooting. For instance "Argo CD application XXX is out of sync. Check blah..."

@simonpasquier addressed the changes, PTAL

openshift-ci · 2024-05-20T07:07:27Z

New changes are detected. LGTM label has been removed.

simonpasquier · 2024-05-21T08:08:33Z

controllers/argocd_metrics_controller.go

 						Annotations: map[string]string{
-							"message": "ArgoCD application {{ $labels.name }} is out of sync",
+							"message":     "ArgoCD application {{ $labels.name }} is out of sync",
+							"summary":     "ArgoCDSyncAlert triggers when an Argo CD application is out of sync",


(suggestion) shortened version

Suggested change

"summary": "ArgoCDSyncAlert triggers when an Argo CD application is out of sync",

"summary": "Argo CD application is out of sync",

simonpasquier · 2024-05-21T08:08:51Z

controllers/argocd_metrics_controller.go

-							"message": "ArgoCD application {{ $labels.name }} is out of sync",
+							"message":     "ArgoCD application {{ $labels.name }} is out of sync",
+							"summary":     "ArgoCDSyncAlert triggers when an Argo CD application is out of sync",
+							"description": "Argo CD application {{ $labels.name }} is out of sync. Check ArgoCDSyncAlert status, this alert is designed to notify that an application managed by Argo CD is out of sync",


Suggested change

"description": "Argo CD application {{ $labels.name }} is out of sync. Check ArgoCDSyncAlert status, this alert is designed to notify that an application managed by Argo CD is out of sync",

"description": "Argo CD application {{ $labels.name }} is out of sync. Check ArgoCDSyncAlert status, this alert is designed to notify that an application managed by Argo CD is out of sync.",

simonpasquier · 2024-05-21T08:09:00Z

controllers/argocd_metrics_controller.go

 						Alert: "ArgoCDSyncAlert",
 						Annotations: map[string]string{
-							"message": "ArgoCD application {{ $labels.name }} is out of sync",
+							"message":     "ArgoCD application {{ $labels.name }} is out of sync",


The conventions prescribe "summary" and "description".

Suggested change

"message": "ArgoCD application {{ $labels.name }} is out of sync",

Rizwana777 · 2024-05-22T07:41:11Z

/test unit

Rizwana777 · 2024-05-22T07:41:26Z

/test v4.12-kuttl-parallel

simonpasquier

/lgtm

openshift-ci · 2024-05-22T08:18:24Z

@simonpasquier: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Rizwana777 · 2024-05-22T11:38:16Z

/test unit

jgwest · 2024-05-23T11:09:37Z

@Rizwana777 it appears the unit tests need to be updated, primarily due to switching from message to summary/description

Signed-off-by: Rizwana777 <[email protected]>

Rizwana777 · 2024-05-23T13:03:00Z

/test v4.14-kuttl-parallel

Rizwana777 · 2024-05-23T13:12:26Z

/retest

jgwest · 2024-05-23T15:46:03Z

/retest

jgwest · 2024-05-24T11:32:35Z

/retest

jgwest

LGTM too, thanks @Rizwana777!

* Add description label to ArgoCDSyncAlert Signed-off-by: Rizwana777 <[email protected]> * Move description to annotations and add summary Signed-off-by: Rizwana777 <[email protected]> --------- Signed-off-by: Rizwana777 <[email protected]>

Add description label to ArgoCDSyncAlert

721ddab

Signed-off-by: Rizwana777 <[email protected]>

openshift-ci bot requested review from iam-veeramalla and jaideepr97 May 15, 2024 14:21

openshift-ci bot added the needs-ok-to-test label May 15, 2024

openshift-ci bot added ok-to-test and removed needs-ok-to-test labels May 15, 2024

openshift-ci bot assigned svghadi May 16, 2024

openshift-ci bot added the lgtm label May 16, 2024

simonpasquier reviewed May 16, 2024

View reviewed changes

openshift-ci bot removed the lgtm label May 20, 2024

Rizwana777 force-pushed the issue-2639 branch 2 times, most recently from d96d017 to 0412149 Compare May 20, 2024 07:13

simonpasquier reviewed May 21, 2024

View reviewed changes

Rizwana777 force-pushed the issue-2639 branch 2 times, most recently from d460a53 to 7e78a7c Compare May 22, 2024 06:08

simonpasquier reviewed May 22, 2024

View reviewed changes

Move description to annotations and add summary

39a3040

Signed-off-by: Rizwana777 <[email protected]>

Rizwana777 force-pushed the issue-2639 branch from 7e78a7c to 39a3040 Compare May 23, 2024 11:54

Merge branch 'master' into issue-2639

4a3cf2f

jgwest approved these changes May 24, 2024

View reviewed changes

jgwest merged commit 9399549 into redhat-developer:master May 24, 2024

	"summary": "ArgoCDSyncAlert triggers when an Argo CD application is out of sync",
	"summary": "Argo CD application is out of sync",

	"description": "Argo CD application {{ $labels.name }} is out of sync. Check ArgoCDSyncAlert status, this alert is designed to notify that an application managed by Argo CD is out of sync",
	"description": "Argo CD application {{ $labels.name }} is out of sync. Check ArgoCDSyncAlert status, this alert is designed to notify that an application managed by Argo CD is out of sync.",

Add description label to ArgoCDSyncAlert #704

Add description label to ArgoCDSyncAlert #704

Uh oh!

Conversation

Rizwana777 commented May 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci bot commented May 15, 2024

Uh oh!

openshift-ci bot commented May 15, 2024

Uh oh!

svghadi commented May 15, 2024

Uh oh!

svghadi commented May 16, 2024

Uh oh!

simonpasquier left a comment

Choose a reason for hiding this comment

Uh oh!

simonpasquier May 16, 2024

Choose a reason for hiding this comment

Uh oh!

Rizwana777 May 20, 2024

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented May 20, 2024

Uh oh!

simonpasquier May 21, 2024

Choose a reason for hiding this comment

Uh oh!

simonpasquier May 21, 2024

Choose a reason for hiding this comment

Uh oh!

simonpasquier May 21, 2024

Choose a reason for hiding this comment

Uh oh!

Rizwana777 commented May 22, 2024

Uh oh!

Rizwana777 commented May 22, 2024

Uh oh!

simonpasquier left a comment

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented May 22, 2024

Uh oh!

Rizwana777 commented May 22, 2024

Uh oh!

jgwest commented May 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Rizwana777 commented May 23, 2024

Uh oh!

Rizwana777 commented May 23, 2024

Uh oh!

jgwest commented May 23, 2024

Uh oh!

jgwest commented May 24, 2024

Uh oh!

jgwest left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Rizwana777 commented May 15, 2024 •

edited

Loading

jgwest commented May 23, 2024 •

edited

Loading