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

Make -grpc_prometheus work when not using a grpc server #15706

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

henryr
Copy link

@henryr henryr commented Apr 12, 2024

--grpc_prometheus enables server and client gRPC metrics. But if we don't have a gRPC server, but call servenv.Run() (which we are doing in some internal tools to have the servenv utilities available but without a gRPC server) the process will crash because of some uninitialized server state. Fix by moving the prom enable logic after the check to see if we actually have a server.

Signed-off-by: Henry Robinson <hrobinson@slack-corp.com>
Copy link
Contributor

vitess-bot bot commented Apr 12, 2024

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 Apr 12, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Apr 12, 2024
@mattlord mattlord added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Observability Pull requests that touch tracing/metrics/monitoring Component: General Changes throughout the code base and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Apr 12, 2024
Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution. I am requesting some changes as it does not compile.

Could you also open a issue describing the issue you are seeing? We will then be able to remove the NeedsIssue label.

Moreover, is it possible to add a test to validate this code?

// skip if not registered
if gRPCPort == 0 {
return
}

if grpccommon.EnableGRPCPrometheus {
Copy link
Member

Choose a reason for hiding this comment

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

This looks wrong as grpccommon.EnableGRPCPrometheus is a function and not a boolean. I would suggest calling the function directly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: General Changes throughout the code base Component: Observability Pull requests that touch tracing/metrics/monitoring NeedsIssue A linked issue is missing for this Pull Request Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants