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.

Sign up for GitHub

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

Jump to bottom

Debug vars: Expose build version in /debug/vars #14713

Merged
merged 6 commits into from
Dec 11, 2023
Merged

Debug vars: Expose build version in /debug/vars #14713

merged 6 commits into from
Dec 11, 2023

Conversation

tycol7
Copy link
Contributor

@tycol7 tycol7 commented Dec 7, 2023 •
edited by mattlord
Loading

Description

Expose BuildVersion (as defined in go/vt/servenv/version.go) via /debug/vars. Allows programmatic access to the build version. E.g.,

$ curl -s http://127.0.0.1:15100/debug/vars
...
"BuildVersion": "19.0.0-SNAPSHOT",
...

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 7, 2023 •
edited by mattlord
Loading

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

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

Backward compatibility

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

@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Dec 7, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 7, 2023
tycol7 added 2 commits December 7, 2023 16:49
@tycol7
Export buildValues; add unit test; fix typos
a85bb42 
* Export `buildValues` for use in the unit test
* Add a unit test to assert that the version name appears in
  `buildValues`
* Fix spelling and spacing in other files

Signed-off-by: Tyler Coleman <[email protected]>
@tycol7
Remove version from buildValues; update test
661967e 
Signed-off-by: Tyler Coleman <[email protected]>
@maxenglander maxenglander added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Observability Pull requests that touch tracing/metrics/monitoring and removed NeedsIssue A linked issue is missing for this Pull Request labels Dec 8, 2023
maxenglander
maxenglander reviewed Dec 8, 2023
View reviewed changes
Copy link
Collaborator

@maxenglander maxenglander left a comment

Choose a reason for hiding this comment

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

Looking good @tycol7!

This change is so minor that I'm not sure it merits documentation, but the Vitess eng. team will make the call on that.

Not sure it's worth website documentation, but you could add something to the 19.0.0 changelog. Here's an example: https://github.com/vitessio/vitess/blob/main/changelog/19.0/19.0.0/summary.md#new-stats.

go/vt/servenv/buildinfo.go Outdated
@@ -33,6 +33,7 @@ var (
buildTime = ""
buildGitRev = ""
buildGitBranch = ""
buildVersion *stats.String
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe call this statBuildVersion to distinguish from the other variables, which are not stats.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

cbceb85

go/vt/vtgate/vtgate.go
@@ -190,7 +190,7 @@ var (
vstreamSkewDelayCount = stats.NewCounter("VStreamEventsDelayedBySkewAlignment",
"Number of events that had to wait because the skew across shards was too high")

vindexUnknownParams = stats.NewGauge("VindexUnknownParameters", "Number of parameterss unrecognized by Vindexes")
vindexUnknownParams = stats.NewGauge("VindexUnknownParameters", "Number of parameters unrecognized by Vindexes")
Copy link
Collaborator

Choose a reason for hiding this comment

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

lol thank you

@tycol7
Copy link
Contributor Author

tycol7 commented Dec 8, 2023

Not sure it's worth website documentation, but you could add something to the 19.0.0 changelog. Here's an example: https://github.com/vitessio/vitess/blob/main/changelog/19.0/19.0.0/summary.md#new-stats.

db365fc

@tycol7
Fix spelling
d064586 
Signed-off-by: Tyler Coleman <[email protected]>
@tycol7 tycol7 requested a review from maxenglander December 9, 2023 00:25
@tycol7 tycol7 marked this pull request as ready for review December 9, 2023 03:38
@mattlord mattlord removed the NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work label Dec 9, 2023
mattlord
mattlord approved these changes Dec 9, 2023
View reviewed changes
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Nice work, @tycol7 ! ❤️ Thank you for this.

@mattlord mattlord removed the NeedsWebsiteDocsUpdate What it says label Dec 9, 2023
@rohit-nayak-ps rohit-nayak-ps merged commit 48a60d8 into vitessio:main Dec 11, 2023
119 of 121 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the tdc/expose-build-version-debug-vars branch December 11, 2023 17:52
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Dec 13, 2023
@tycol7 @ejortegau
Debug vars: Expose build version in /debug/vars (vitessio#14713)
ff40d03 
Signed-off-by: Tyler Coleman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rohit-nayak-ps rohit-nayak-ps rohit-nayak-ps approved these changes

@mattlord mattlord mattlord approved these changes

@maxenglander maxenglander Awaiting requested review from maxenglander

@ajm188 ajm188 Awaiting requested review from ajm188 ajm188 is a code owner

@notfelineit notfelineit Awaiting requested review from notfelineit notfelineit is a code owner

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100 GuptaManan100 is a code owner

@frouioui frouioui Awaiting requested review from frouioui frouioui is a code owner

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal harshit-gangal is a code owner

@systay systay Awaiting requested review from systay systay is a code owner

Assignees
No one assigned
Labels
Component: Observability Pull requests that touch tracing/metrics/monitoring Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.

Feature Request: Expose build version in /debug/vars
4 participants
@tycol7 @maxenglander @mattlord @rohit-nayak-ps