Skip to content

Add structure logging (Zap) to Vitess#13061

Closed
EmadMokhtar wants to merge 4 commits intovitessio:mainfrom
EmadMokhtar:structure-logging-feature
Closed

Add structure logging (Zap) to Vitess#13061
EmadMokhtar wants to merge 4 commits intovitessio:mainfrom
EmadMokhtar:structure-logging-feature

Conversation

@EmadMokhtar
Copy link
Contributor

Description

The goal of this PR is to introduce the structure logging to Vitess. Vitess is using glog as logger. So I decided to use noglog and create drop-in replacement. I used Zap log to replace glog.

The PR is also introducing a flag structure_logging where the user can choose to use structure logging or the default logging. The default value is False so the default is to use the current logging glog.

Related Issue(s)

#11613

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Emad Habib <ehabib@slack-corp.com>
Signed-off-by: Emad Habib <ehabib@slack-corp.com>
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels May 10, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented May 10, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@github-actions github-actions bot added this to the v17.0.0 milestone May 10, 2023
@EmadMokhtar
Copy link
Contributor Author

This is a second trial for this. The pervious PR #11960 is reverted. Here is the revert PR #12219 and there you'll find more context.

Copy link
Collaborator

@deepthi deepthi left a comment

Choose a reason for hiding this comment

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

I don't see the need to prefix the new files with vts_, they can just be logger.go and logger_test.go.
We don't do that anywhere else.

@harshit-gangal harshit-gangal added the Benchmark me Add label to PR to run benchmarks label Jun 12, 2023
@frouioui frouioui modified the milestones: v17.0.0, v18.0.0 Jun 12, 2023
@github-actions
Copy link
Contributor

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Jul 14, 2023
@github-actions
Copy link
Contributor

This PR was closed because it has been stale for 7 days with no activity.

@github-actions github-actions bot closed this Jul 22, 2023
@EmadMokhtar
Copy link
Contributor Author

I don't see the need to prefix the new files with vts_, they can just be logger.go and logger_test.go.
We don't do that anywhere else.

There are files with the same name. I intend to keep the structure logging separated in a different file.

@mattlord mattlord reopened this Jul 28, 2023
@mattlord mattlord removed the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Jul 28, 2023
@github-actions
Copy link
Contributor

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added the Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. label Aug 28, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 4, 2023

This PR was closed because it has been stale for 7 days with no activity.

@github-actions github-actions bot closed this Sep 4, 2023
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Jul 9, 2024
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
timvaillancourt added a commit to slackhq/vitess that referenced this pull request Jul 10, 2024
* Install zap log and noglog

Signed-off-by: Emad Habib <ehabib@slack-corp.com>

* Implement the Vitess Structure Logger VTSLoger

Signed-off-by: Emad Habib <ehabib@slack-corp.com>

* Move the structure logging code to logger.go file

* make PR suggestions from vitessio#13061

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bad merge conflict

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bad merge conflict again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* fix test

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* add flags e2e test for vtgateclienttest

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* update error msg

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

---------

Signed-off-by: Emad Habib <ehabib@slack-corp.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Emad Habib <ehabib@slack-corp.com>
Co-authored-by: Emad Mokhtar <me@emadmokhtar.com>
tanjinx pushed a commit to slackhq/vitess that referenced this pull request Feb 3, 2026
* Install zap log and noglog

Signed-off-by: Emad Habib <ehabib@slack-corp.com>

* Implement the Vitess Structure Logger VTSLoger

Signed-off-by: Emad Habib <ehabib@slack-corp.com>

* Move the structure logging code to logger.go file

* make PR suggestions from vitessio#13061

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bad merge conflict

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bad merge conflict again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* fix test

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* add flags e2e test for vtgateclienttest

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* update error msg

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

---------

Signed-off-by: Emad Habib <ehabib@slack-corp.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Emad Habib <ehabib@slack-corp.com>
Co-authored-by: Emad Mokhtar <me@emadmokhtar.com>
tanjinx added a commit to slackhq/vitess that referenced this pull request Feb 4, 2026
* `slack-19.0`: add structured logging (#449)

* Install zap log and noglog

Signed-off-by: Emad Habib <ehabib@slack-corp.com>

* Implement the Vitess Structure Logger VTSLoger

Signed-off-by: Emad Habib <ehabib@slack-corp.com>

* Move the structure logging code to logger.go file

* make PR suggestions from vitessio#13061

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bad merge conflict

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bad merge conflict again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* fix test

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* add flags e2e test for vtgateclienttest

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* update error msg

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

---------

Signed-off-by: Emad Habib <ehabib@slack-corp.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Emad Habib <ehabib@slack-corp.com>
Co-authored-by: Emad Mokhtar <me@emadmokhtar.com>

* `slack-19.0`: fix structured logging (#532)

* `slack-19.0`: fix structured logging

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* remove debug println

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* test cleanup

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* update flags and e2e tests

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* fix e2e flag test

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* code cleanup

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* simplify

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* fix goimports

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* log_dir WIP

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

---------

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Add structured logging flags to RegisterFlagsWithTimeouts

The cherry-picked structured logging commits added the flags to
RegisterFlags() but not to RegisterFlagsWithTimeouts(). This caused
mysqlctld (which uses RegisterFlagsWithTimeouts) to not have the
structured logging flags available.

This commit adds the --structured-logging and --structured-log-level
flags to RegisterFlagsWithTimeouts() to match RegisterFlags().

Signed-off-by: Tanjin Xu <tanjin.xu@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

---------

Signed-off-by: Emad Habib <ehabib@slack-corp.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tanjin Xu <tanjin.xu@slack-corp.com>
Co-authored-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Emad Habib <ehabib@slack-corp.com>
Co-authored-by: Emad Mokhtar <me@emadmokhtar.com>
Co-authored-by: Claude <svc-devxp-claude@slack-corp.com>
sbaker617 pushed a commit to slackhq/vitess that referenced this pull request Feb 5, 2026
* `slack-19.0`: add structured logging (#449)

* Install zap log and noglog

Signed-off-by: Emad Habib <ehabib@slack-corp.com>

* Implement the Vitess Structure Logger VTSLoger

Signed-off-by: Emad Habib <ehabib@slack-corp.com>

* Move the structure logging code to logger.go file

* make PR suggestions from vitessio#13061

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bad merge conflict

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Fix bad merge conflict again

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* fix test

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* add flags e2e test for vtgateclienttest

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* update error msg

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

---------

Signed-off-by: Emad Habib <ehabib@slack-corp.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Emad Habib <ehabib@slack-corp.com>
Co-authored-by: Emad Mokhtar <me@emadmokhtar.com>

* `slack-19.0`: fix structured logging (#532)

* `slack-19.0`: fix structured logging

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* remove debug println

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* test cleanup

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* update flags and e2e tests

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* fix e2e flag test

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* code cleanup

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* simplify

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* fix goimports

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* log_dir WIP

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

---------

Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>

* Add structured logging flags to RegisterFlagsWithTimeouts

The cherry-picked structured logging commits added the flags to
RegisterFlags() but not to RegisterFlagsWithTimeouts(). This caused
mysqlctld (which uses RegisterFlagsWithTimeouts) to not have the
structured logging flags available.

This commit adds the --structured-logging and --structured-log-level
flags to RegisterFlagsWithTimeouts() to match RegisterFlags().

Signed-off-by: Tanjin Xu <tanjin.xu@slack-corp.com>
Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>

---------

Signed-off-by: Emad Habib <ehabib@slack-corp.com>
Signed-off-by: Tim Vaillancourt <tim@timvaillancourt.com>
Signed-off-by: Tanjin Xu <tanjin.xu@slack-corp.com>
Co-authored-by: Tim Vaillancourt <tim@timvaillancourt.com>
Co-authored-by: Emad Habib <ehabib@slack-corp.com>
Co-authored-by: Emad Mokhtar <me@emadmokhtar.com>
Co-authored-by: Claude <svc-devxp-claude@slack-corp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Benchmark me Add label to PR to run benchmarks NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants