feat: option to disable writing k8s events(#18205) #18441

Jack-R-lantern · 2024-05-29T03:30:17Z

This PR is related to the argocd event logging optionization.
The implementation is on/off depending on the kind of event reason.

Below is a simple example
case all, none, specific

Result

argocd-server env all

argocd-server env none

argocd-server env specific

Close #18205

Checklist:

codecov · 2024-05-29T03:39:11Z

Codecov Report

Attention: Patch coverage is 81.81818% with 8 lines in your changes missing coverage. Please review.

Project coverage is 55.84%. Comparing base (ae028c2) to head (1a57c8b).
Report is 467 commits behind head on master.

Files with missing lines	Patch %	Lines
util/argo/audit_logger.go	82.75%	4 Missing and 1 partial ⚠️
cmd/argocd-server/commands/argocd_server.go	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #18441      +/-   ##
==========================================
+ Coverage   55.81%   55.84%   +0.02%     
==========================================
  Files         320      320              
  Lines       44396    44430      +34     
==========================================
+ Hits        24781    24810      +29     
- Misses      17050    17051       +1     
- Partials     2565     2569       +4

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

Jack-R-lantern · 2024-06-02T15:20:00Z

@tooptoop4 Can you check on that PR?

jannfis

Thanks for your PR.

However, I feel like this will pollute the command line arguments (and accompanying environment variables) unnecessarily.

Have you considered using a single flag taking a list of events to enable? (i.e. --enable-events=<comma separated list>), possibly with all and none aliases?

Jack-R-lantern · 2024-06-04T21:38:40Z

Thanks for your PR.

However, I feel like this will pollute the command line arguments (and accompanying environment variables) unnecessarily.

Have you considered using a single flag taking a list of events to enable? (i.e. --enable-events=<comma separated list>), possibly with all and none aliases?

@jannfis
Oh, That‘s very good idea.
I'll change it

util/argo/audit_logger.go

cmd/argocd-application-controller/commands/argocd_application_controller.go

ishitasequeira

Thanks @Jack-R-lantern !! LGTM!!

@jannfis do you any concerns on the PR?

dmatviichuk · 2024-06-26T10:02:50Z

@jannfis do you any concerns on the PR? Could we please merge as soon as possible? Thanks!

Jack-R-lantern · 2024-07-04T13:49:37Z

@jannfis
Resolved all conflicts.
Please review this PR

janburian-ext43623 · 2024-07-25T09:51:34Z

Hi @jannfis, could you please review this PR? We are waiting for this feature and we would like to be merged ASAP. Hope it will make it still to 2.12. Thanks a lot!

jenting · 2024-08-03T13:38:08Z

Would love to use this enhancement in the coming release version.

util/argo/audit_logger.go

gdsoumya

Minor comment rest LGTM

util/argo/audit_logger.go

optioned to write logs for k8s events. Each is passed as an environment variable and defaults to true, disabling it requires explicitly setting the option to false. Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>

fix unit test - application_test - applicationset_test - project_test - appcontroller_tes - audit_logger_test Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>

Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>

gdsoumya · 2024-09-19T07:46:13Z

@jannfis does the changes look good to you?

resolved

tooptoop4 · 2024-09-23T10:37:26Z

/cherry-pick release-2.13

…18441) * feat: option to disable writing k8s events optioned to write logs for k8s events. Each is passed as an environment variable and defaults to true, disabling it requires explicitly setting the option to false. Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> * feat: option to disable writing k8s events fix unit test - application_test - applicationset_test - project_test - appcontroller_tes - audit_logger_test Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> * rebase Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> --------- Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> Signed-off-by: ratulbasak <ratulbasak93@gmail.com>

shreyasurs27 · 2024-11-07T11:16:40Z

@Jack-R-lantern We are unable to find this commit in any release notes. Which version has this change?

Jack-R-lantern · 2024-11-07T11:25:24Z

@shreyasurs27

Would you like to check the 2.13.0 version?

shreyasurs27 · 2024-11-08T08:46:51Z

@Jack-R-lantern I checked the code , looks like it is only available in master but not on the tags.

shreyasurs27 · 2024-11-13T03:18:46Z

@Jack-R-lantern @tooptoop4 @gdsoumya Can this feature be included in next patch version? I could not find it in latest release. Looks like it was merged to master but not to individual tags. 2.13 does not have this feature. Please correct me if I am wrong.

I am using 2.12.4 version. This is a very useful feature for us. Whenever there is a shared resource warning, the applications will be in out-of-sync and sync loop forever which creates thousands of events for few mins. I even tried the "failonsharedresourcewarning" option , it works perfectly for app with manual sync but for auto-sync enabled apps the loop continues. It brought down the etcd . So disabling the events would really help in this case.

gdsoumya · 2024-11-13T04:08:57Z

/cherry-pick release-2.13

gdsoumya · 2024-11-13T04:14:16Z

Seems like the automated cherry pick isn't working, @Jack-R-lantern can you raise a cherry pick PR to the release branch release-2.13

…18441) * feat: option to disable writing k8s events optioned to write logs for k8s events. Each is passed as an environment variable and defaults to true, disabling it requires explicitly setting the option to false. Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> * feat: option to disable writing k8s events fix unit test - application_test - applicationset_test - project_test - appcontroller_tes - audit_logger_test Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> * rebase Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> --------- Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>

Jack-R-lantern · 2024-11-13T14:30:25Z

@gdsoumya
sure, I submitted the PR.

* feat: option to disable writing k8s events optioned to write logs for k8s events. Each is passed as an environment variable and defaults to true, disabling it requires explicitly setting the option to false. --------- Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>

…18441) * feat: option to disable writing k8s events optioned to write logs for k8s events. Each is passed as an environment variable and defaults to true, disabling it requires explicitly setting the option to false. Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> * feat: option to disable writing k8s events fix unit test - application_test - applicationset_test - project_test - appcontroller_tes - audit_logger_test Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> * rebase Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> --------- Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com> Signed-off-by: Adrian Aneci <aneci@adobe.com>

andrey-parkhomets · 2025-02-05T12:35:10Z

I wonder why that nice feature not available via configmap argocd-cmd-params-cm as

data:
   server.enable.k8s.event: none

Jack-R-lantern · 2025-02-06T00:56:39Z

I wonder why that nice feature not available via configmap argocd-cmd-params-cm as
data:

   server.enable.k8s.event: none

Does it work when using environment variable?

Jack-R-lantern changed the title ~~feat: option to disable writing k8s events~~ feat: option to disable writing k8s events(#18205) May 29, 2024

Jack-R-lantern force-pushed the ISSUE-18205/option_to_disable_writing_k8s_events branch 4 times, most recently from bf515c8 to 1af1404 Compare June 2, 2024 14:28

Jack-R-lantern marked this pull request as ready for review June 2, 2024 15:16

Jack-R-lantern requested review from a team as code owners June 2, 2024 15:16

tooptoop4 approved these changes Jun 2, 2024

View reviewed changes

jannfis previously requested changes Jun 4, 2024

View reviewed changes

Jack-R-lantern force-pushed the ISSUE-18205/option_to_disable_writing_k8s_events branch from 1af1404 to 04e885c Compare June 5, 2024 00:21

Jack-R-lantern requested a review from jannfis June 5, 2024 00:38

ishitasequeira reviewed Jun 5, 2024

View reviewed changes

util/argo/audit_logger.go Outdated Show resolved Hide resolved

cmd/argocd-application-controller/commands/argocd_application_controller.go Outdated Show resolved Hide resolved

Jack-R-lantern force-pushed the ISSUE-18205/option_to_disable_writing_k8s_events branch 2 times, most recently from 39e230b to 3d52314 Compare June 5, 2024 05:35

Jack-R-lantern requested a review from ishitasequeira June 5, 2024 05:46

ishitasequeira approved these changes Jun 5, 2024

View reviewed changes

Jack-R-lantern mentioned this pull request Jun 27, 2024

[ArgoCD]PR-18441 Jack-R-lantern/argoproj_story#2

Merged

Jack-R-lantern force-pushed the ISSUE-18205/option_to_disable_writing_k8s_events branch 5 times, most recently from 9f2d5f0 to bb41454 Compare July 4, 2024 13:35

gdsoumya requested changes Aug 3, 2024

View reviewed changes

util/argo/audit_logger.go Outdated Show resolved Hide resolved

Jack-R-lantern force-pushed the ISSUE-18205/option_to_disable_writing_k8s_events branch 2 times, most recently from f12fbe9 to b95c9f1 Compare September 9, 2024 13:21

Jack-R-lantern requested a review from gdsoumya September 9, 2024 13:49

Jack-R-lantern force-pushed the ISSUE-18205/option_to_disable_writing_k8s_events branch from b95c9f1 to b4f538c Compare September 15, 2024 05:10

gdsoumya approved these changes Sep 17, 2024

View reviewed changes

util/argo/audit_logger.go Outdated Show resolved Hide resolved

Jack-R-lantern added 3 commits September 18, 2024 13:38

feat: option to disable writing k8s events

398d55b

optioned to write logs for k8s events. Each is passed as an environment variable and defaults to true, disabling it requires explicitly setting the option to false. Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>

feat: option to disable writing k8s events

695b08d

fix unit test - application_test - applicationset_test - project_test - appcontroller_tes - audit_logger_test Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>

rebase

1a57c8b

Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>

Jack-R-lantern force-pushed the ISSUE-18205/option_to_disable_writing_k8s_events branch from b4f538c to 1a57c8b Compare September 18, 2024 13:39

gdsoumya merged commit eba559a into argoproj:master Sep 23, 2024
27 of 28 checks passed

Jack-R-lantern mentioned this pull request Nov 13, 2024

feat: option to disable writing k8s events - (cherry-pick 2.13 #18441) #20788

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: option to disable writing k8s events(#18205) #18441

feat: option to disable writing k8s events(#18205) #18441

Jack-R-lantern commented May 29, 2024 •

edited

Loading

codecov bot commented May 29, 2024 •

edited

Loading

Jack-R-lantern commented Jun 2, 2024

jannfis left a comment

Jack-R-lantern commented Jun 4, 2024

ishitasequeira left a comment

dmatviichuk commented Jun 26, 2024

Jack-R-lantern commented Jul 4, 2024

janburian-ext43623 commented Jul 25, 2024 •

edited

Loading

jenting commented Aug 3, 2024 •

edited

Loading

gdsoumya left a comment

gdsoumya commented Sep 19, 2024

tooptoop4 commented Sep 23, 2024

shreyasurs27 commented Nov 7, 2024

Jack-R-lantern commented Nov 7, 2024

shreyasurs27 commented Nov 8, 2024

shreyasurs27 commented Nov 13, 2024 •

edited

Loading

gdsoumya commented Nov 13, 2024

gdsoumya commented Nov 13, 2024

Jack-R-lantern commented Nov 13, 2024

andrey-parkhomets commented Feb 5, 2025

Jack-R-lantern commented Feb 6, 2025

feat: option to disable writing k8s events(#18205) #18441

feat: option to disable writing k8s events(#18205) #18441

Conversation

Jack-R-lantern commented May 29, 2024 • edited Loading

Result

argocd-server env all

argocd-server env none

argocd-server env specific

codecov bot commented May 29, 2024 • edited Loading

Codecov Report

Jack-R-lantern commented Jun 2, 2024

jannfis left a comment

Choose a reason for hiding this comment

Jack-R-lantern commented Jun 4, 2024

ishitasequeira left a comment

Choose a reason for hiding this comment

dmatviichuk commented Jun 26, 2024

Jack-R-lantern commented Jul 4, 2024

janburian-ext43623 commented Jul 25, 2024 • edited Loading

jenting commented Aug 3, 2024 • edited Loading

gdsoumya left a comment

Choose a reason for hiding this comment

gdsoumya commented Sep 19, 2024

tooptoop4 commented Sep 23, 2024

shreyasurs27 commented Nov 7, 2024

Jack-R-lantern commented Nov 7, 2024

shreyasurs27 commented Nov 8, 2024

shreyasurs27 commented Nov 13, 2024 • edited Loading

gdsoumya commented Nov 13, 2024

gdsoumya commented Nov 13, 2024

Jack-R-lantern commented Nov 13, 2024

andrey-parkhomets commented Feb 5, 2025

Jack-R-lantern commented Feb 6, 2025

Jack-R-lantern commented May 29, 2024 •

edited

Loading

codecov bot commented May 29, 2024 •

edited

Loading

janburian-ext43623 commented Jul 25, 2024 •

edited

Loading

jenting commented Aug 3, 2024 •

edited

Loading

shreyasurs27 commented Nov 13, 2024 •

edited

Loading