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

[servenv] optional pprof endpoints #14796

Merged
merged 5 commits into from
Dec 18, 2023

Conversation

ajm188
Copy link
Contributor

@ajm188 ajm188 commented Dec 16, 2023

Description

this PR adds a flag to allow users to deploy vitess components without including the /debug/pprof endpoints. we will begin by defaulting to opted-in to avoid changing behavior when upgrading to v19, but in v20 we will switch to disabled by default.

Demos!

➜  local git:(andrew/optional-pprof-endpoints) ✗ grep "false" vtdataroot/tmp/vttablet.WARNING 
W1216 12:57:36.270569   46724 http.go:56] Beginning in vitess version 20, pprof-http will default to `false`; to continue enabling pprof endpoints, please manually set this flag before upgrading.
  local git:(andrew/optional-pprof-endpoints) ✗ curl http://localhost:15000/debug/pprof/
404 page not found

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Andrew Mason added 3 commits December 16, 2023 12:30
@ajm188 ajm188 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Observability Pull requests that touch tracing/metrics/monitoring labels Dec 16, 2023
@ajm188 ajm188 requested a review from dbussink December 16, 2023 18:04
@ajm188 ajm188 requested a review from deepthi as a code owner December 16, 2023 18:04
Copy link
Contributor

vitess-bot bot commented Dec 16, 2023

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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required 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 16, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 16, 2023
Signed-off-by: Andrew Mason <[email protected]>
}

if !pflag.Lookup("pprof-http").Changed {
log.Warning("Beginning in vitess version 20, pprof-http will default to `false`; to continue enabling pprof endpoints, please manually set this flag before upgrading.")
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have a standard casing for vitess? Or Vitess? And should we use Vitess 20, Vitess v20 as a shorter version instead of writing version out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I .... am not sure!

Looks like we definitely prefer v20 to version 20:

go/vt/vtctl/reparentutil/emergency_reparenter.go:       // TODO(timvaillancourt): remove legacyERS* gauges in v19+.
go/vt/vttablet/onlineddl/executor.go:   // v18 fix. Remove in v19
go/vt/vttablet/onlineddl/executor.go:                   // This fix is created in v18 and can be removed in v19
go/vt/vttablet/tabletmanager/vreplication/flags.go:     // Deprecated and ignored in v19.
go/vt/vttablet/tabletmanager/vreplication/flags.go:     fs.MarkDeprecated("vreplication_tablet_type", "As of v19 this is ignored and will be removed in a future release.")
go/vt/vttablet/tabletserver/health_streamer.go: // tables and views in v19.

and it seems like we mostly prefer capitalized Vitess but i'm not completely sure. let me make those changes!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

actually .. looking at the flag deprecation above, let's just drop "vitess" from the language entirely and avoid the issue :P

Signed-off-by: Andrew Mason <[email protected]>
return
}

if !pflag.Lookup("pprof-http").Changed {
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm assuming this is the case, this is true if the value is explicitly provided (but still the same as the default)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@frouioui frouioui added Backport to: release-16.0 and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required Backport to: release-16.0 labels Dec 18, 2023
@frouioui frouioui merged commit 4e88db2 into vitessio:main Dec 18, 2023
118 of 119 checks passed
@frouioui frouioui deleted the andrew/optional-pprof-endpoints branch December 18, 2023 08:49
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Jan 24, 2024
@ajm188 ajm188 mentioned this pull request Feb 15, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Observability Pull requests that touch tracing/metrics/monitoring Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants