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.

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

feat: Add labels on Application's k8s events (#11381) #18160

Merged
merged 6 commits into from
Jun 17, 2024

Conversation

svghadi
Copy link
Contributor

@svghadi svghadi commented May 10, 2024

Closes #11381

This PR implements #11381 enhancement to expose application labels on k8s events generated by Argo CD.

Change:
This PR introduces two new key resource.includeEventLabelKeys & resource.excludeEventLabelKeys in argocd-cm configmap which takes in a comma separated string of label keys.
For any events generated for Applications containing the label keys specified in resource.includeEventLabelKeys, the controller adds the matched label onto the event thus establishing an easy link between the event and the application to filter-out/process later using labels. The specified label keys are matched against the Application and it's AppProject labels. In case of conflict between labels on Application and it's AppProject, the Application label values are prioritised and added to the event.
Furthermore, labels specified in resource.excludeEventLabelKeys are removed from the event labels, if they were included.

Sample output:

$ kubectl get events -l env=dev --show-labels
LAST SEEN   TYPE     REASON               OBJECT                                      MESSAGE                                                                LABELS
25s         Normal   ResourceCreated      application/test-labels-on-app-k8s-events   admin created application                                              app=test,env=dev
25s         Normal   OperationStarted     application/test-labels-on-app-k8s-events   admin initiated sync to  (7e2013dcfdd0c801eececd38aa5f3db898e29f4b)    app=test,env=dev
24s         Normal   OperationCompleted   application/test-labels-on-app-k8s-events   Sync operation to 7e2013dcfdd0c801eececd38aa5f3db898e29f4b succeeded   app=test,env=dev
24s         Normal   ResourceUpdated      application/test-labels-on-app-k8s-events   Updated sync status:  -> Synced                                        app=test,env=dev
24s         Normal   ResourceUpdated      application/test-labels-on-app-k8s-events   Updated health status:  -> Progressing                                 app=test,env=dev
17s         Normal   ResourceUpdated      application/test-labels-on-app-k8s-events   Updated health status: Progressing -> Healthy                          app=test,env=dev

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

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

I think this is a great start, to make it feature complete can we handle the include/exclude use cases?

Copy link

codecov bot commented May 29, 2024

Codecov Report

Attention: Patch coverage is 84.12698% with 10 lines in your changes missing coverage. Please review.

Project coverage is 45.13%. Comparing base (311c059) to head (4e2a531).
Report is 531 commits behind head on master.

Files with missing lines Patch % Lines
util/settings/settings.go 72.72% 4 Missing and 2 partials ⚠️
util/argo/argo.go 91.66% 2 Missing ⚠️
controller/appcontroller.go 87.50% 1 Missing ⚠️
util/argo/audit_logger.go 85.71% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master   #18160      +/-   ##
==========================================
+ Coverage   45.09%   45.13%   +0.04%     
==========================================
  Files         354      354              
  Lines       48006    48057      +51     
==========================================
+ Hits        21648    21691      +43     
- Misses      23544    23550       +6     
- Partials     2814     2816       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@svghadi
Copy link
Contributor Author

svghadi commented May 29, 2024

Thanks for @todaywasawesome & @leoluz for your inputs. I have incorporated your suggestions by introducing two new keys resource.includeEventLabelKeys & resource.excludeEventLabelKeys in argocd-cm configmap and adding wildcard support to make it feature complete. The PR is ready for review.

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
@@ -939,7 +939,7 @@ func (ctrl *ApplicationController) processAppOperationQueueItem() (processNext b
Message: err.Error(),
})
message := fmt.Sprintf("Unable to delete application resources: %v", err.Error())
ctrl.auditLogger.LogAppEvent(app, argo.EventInfo{Reason: argo.EventReasonStatusRefreshed, Type: v1.EventTypeWarning}, message, "")
ctrl.logAppEvent(app, argo.EventInfo{Reason: argo.EventReasonStatusRefreshed, Type: v1.EventTypeWarning}, message, context.TODO())
Copy link
Member

Choose a reason for hiding this comment

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

Was wondering if we had a better context than the TODO() one here and elsewhere.

Copy link
Member

@jannfis jannfis left a comment

Choose a reason for hiding this comment

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

LGTM. @todaywasawesome are your concerns addressed?

Copy link
Member

@ishitasequeira ishitasequeira left a comment

Choose a reason for hiding this comment

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

LGTM!!

Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

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

Great! Thanks for getting this over the line.

@ishitasequeira ishitasequeira merged commit 4c6ad9d into argoproj:master Jun 17, 2024
28 checks passed
@svghadi svghadi deleted the app-event-labels branch June 18, 2024 02:42
ggjulio pushed a commit to ggjulio/argo-cd that referenced this pull request Jul 21, 2024
…oj#18160)

* Add labels on Application's k8s events

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* Fix typo

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* Add new cm keys & doc

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* Fix typo

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* correct rebase changes

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* Fix linting

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

---------

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
jsolana pushed a commit to jsolana/argo-cd that referenced this pull request Jul 24, 2024
…oj#18160)

* Add labels on Application's k8s events

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* Fix typo

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* Add new cm keys & doc

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* Fix typo

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* correct rebase changes

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

* Fix linting

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>

---------

Signed-off-by: Siddhesh Ghadi <sghadi1203@gmail.com>
Signed-off-by: Javier Solana <javier.solana@cabify.com>
Signed-off-by: Javier Solana <javier.solana@cabify.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Exposing Application labels in events
4 participants