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

fix: Switch default logging to JSON (issue: 20897) #21656

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

teddy-wahle
Copy link

@teddy-wahle teddy-wahle commented Jan 24, 2025

Closes #20897

This change updates the default log format in util/log from text to json. It will be used for ArgoCD v3.0.

JSON logging is preferred because it produces structured logs, which are easier to parse and analyze with tools like Datadog and OpenTelemetry (Otel). These integrations rely on structured log formats to extract meaningful data and streamline observability workflows. Switching from json to json ensures better compatibility with modern logging and monitoring solutions.

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

bunnyshell bot commented Jan 24, 2025

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

@teddy-wahle teddy-wahle changed the title fix: Switch default logging to JSON fix: Switch default logging to JSON (issue: 20897) Jan 24, 2025
@teddy-wahle teddy-wahle force-pushed the 20897-switch-default-logging-to-json branch from 662dcf7 to 6c4f417 Compare January 24, 2025 02:37
@teddy-wahle teddy-wahle marked this pull request as ready for review January 24, 2025 02:43
@teddy-wahle teddy-wahle requested review from a team as code owners January 24, 2025 02:43
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

Attention: Patch coverage is 41.66667% with 7 lines in your changes missing coverage. Please review.

Project coverage is 55.59%. Comparing base (bcf2143) to head (c63d1e9).
Report is 31 commits behind head on master.

Files with missing lines Patch % Lines
cmd/argocd-dex/commands/argocd_dex.go 0.00% 2 Missing ⚠️
...md/argocd-cmp-server/commands/argocd_cmp_server.go 0.00% 1 Missing ⚠️
cmd/argocd-notification/commands/controller.go 0.00% 1 Missing ⚠️
cmd/argocd-server/commands/argocd_server.go 0.00% 1 Missing ⚠️
cmd/argocd/commands/admin/admin.go 0.00% 1 Missing ⚠️
cmd/argocd/commands/root.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master   #21656      +/-   ##
==========================================
+ Coverage   55.45%   55.59%   +0.13%     
==========================================
  Files         339      340       +1     
  Lines       57196    57447     +251     
==========================================
+ Hits        31718    31936     +218     
- Misses      22812    22818       +6     
- Partials     2666     2693      +27     

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

@andrii-korotkov-verkada
Copy link
Contributor

Looks like you have to update the sources of the generated code and regenerate it with make.

Copy link
Member

@rumstead rumstead left a comment

Choose a reason for hiding this comment

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

LGTM just need to run the codegen.

@teddy-wahle teddy-wahle force-pushed the 20897-switch-default-logging-to-json branch from 6c4f417 to 2ac0f23 Compare January 28, 2025 02:09
Copy link
Member

@rumstead rumstead left a comment

Choose a reason for hiding this comment

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

The e2e tests capture log output for validation of some commands, it looks like they will need to be updated to parse the json output.

@teddy-wahle teddy-wahle force-pushed the 20897-switch-default-logging-to-json branch from ea57d38 to c63d1e9 Compare February 3, 2025 17:55
Copy link
Member

@rumstead rumstead left a comment

Choose a reason for hiding this comment

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

LGTM thanks for the PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Ready for final review
Development

Successfully merging this pull request may close these issues.

Switch default logging to JSON in v3.0
3 participants