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

✨Expose metrics http server for extra endpoints #824

Merged
merged 1 commit into from
Apr 22, 2020
Merged

✨Expose metrics http server for extra endpoints #824

merged 1 commit into from
Apr 22, 2020

Conversation

hypnoglow
Copy link
Contributor

Allows users to add extra http handlers served on custom path to the http server that serves metrics. Might be useful to register some diagnostic endpoints e.g. pprof or custom debug info.

Ref: #684

Some additional thoughts: since we expose this, naming the server "metrics server" is not 100% correct anymore. Probably we might call it "diagnostic server" or something, that describes the purpose more clearly. Of course renaming would be a breaking change. As far as I found, the only metrics-related name we expose in the API is MetricsBindAddress in manager options.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 25, 2020
@k8s-ci-robot
Copy link
Contributor

Welcome @hypnoglow!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-runtime has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 25, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @hypnoglow. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 25, 2020
hypnoglow
hypnoglow commented Feb 25, 2020
View reviewed changes
pkg/manager/internal.go Outdated Show resolved Hide resolved
vincepri
vincepri reviewed Feb 25, 2020
View reviewed changes
pkg/manager/internal.go Outdated Show resolved Hide resolved
pkg/manager/internal.go Outdated Show resolved Hide resolved
pkg/manager/internal.go Outdated Show resolved Hide resolved
pkg/manager/internal.go Outdated Show resolved Hide resolved
@vincepri
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 25, 2020
@alvaroaleman
Copy link
Member

I am not really sure if I like the idea of allowing to re-use the builtin server for arbitrary handlers rather than just adding a new listener as Runnable to the manager. The next persons usecase might need a more complex routing logic than just path->handler and that is IMHO a problem that doesn't really belong here (here as in: The manager package).

If this is about pprof/other diagnostics in particular we could probably add an option to enable those specifically. WDYT?

@vincepri
Copy link
Member

That's a fair statement, although seems there might be some potential useful use cases, and we can leave it up to the users. I don't have strong opinions here, I think either way can be fine

@hypnoglow
Copy link
Contributor Author

/assign @vincepri

@hypnoglow
Expose metrics http server for extra endpoints
3592cfb 
This allows users to register extra http endpoints on the http server
that serves metrics.
alvaroaleman
alvaroaleman reviewed Mar 10, 2020
View reviewed changes
pkg/manager/manager_test.go
defer close(s)
go func() {
defer GinkgoRecover()
Expect(m.Start(s)).NotTo(HaveOccurred())
Copy link
Member

Choose a reason for hiding this comment

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

Doesn't the start race with the the Get request we do later on?

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've done this in a similar way as in other tests where HTTP requests are involved. It seems to work, but I see no strong argument why this could not race potentially, maybe I'm missing something.

Copy link
Member

Choose a reason for hiding this comment

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

hm okay, interesting. Well, we can still look at it if we actually see it flake.

@alvaroaleman
Copy link
Member

/lgtm

Thanks for your work!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 11, 2020
@alvaroaleman
Copy link
Member

@vincepri is this currently still missing something from your POV?

@vincepri
Copy link
Member

I think we're good, I was hoping to get the TODOs in issues though

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hypnoglow, vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 22, 2020
@k8s-ci-robot k8s-ci-robot merged commit 6501aeb into kubernetes-sigs:master Apr 22, 2020
@zqzten zqzten mentioned this pull request Jun 25, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rajathagasthya rajathagasthya rajathagasthya left review comments

@vincepri vincepri vincepri left review comments

@alvaroaleman alvaroaleman alvaroaleman left review comments

@mengqiy mengqiy Awaiting requested review from mengqiy

Assignees

@vincepri vincepri

@alvaroaleman alvaroaleman

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@hypnoglow @k8s-ci-robot @vincepri @alvaroaleman @rajathagasthya