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 gRPC prometheus metrics #371

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

Expose gRPC prometheus metrics #371

wants to merge 1 commit into from

Conversation

laozc
Copy link

@laozc laozc commented Feb 21, 2025

What type of PR is this?

/kind feature

What this PR does / why we need it:

Expose gRPC prometheus metrics to capture performance for volume operations

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Added flag metrics-bind-addr to specify the endpoint for gRPC server metrics

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 21, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: laozc
Once this PR has been reviewed and has the lgtm label, please assign xing-yang for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 21, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @laozc. Thanks for your PR.

I'm waiting for a kubernetes-csi 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Feb 21, 2025
mauriciopoppe
mauriciopoppe reviewed Feb 22, 2025
View reviewed changes
Copy link
Member

@mauriciopoppe mauriciopoppe left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, I left a few comments.

@mauriciopoppe mauriciopoppe mentioned this pull request Feb 22, 2025
Open
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 24, 2025
mauriciopoppe
mauriciopoppe reviewed Feb 24, 2025
View reviewed changes
Copy link
Member

@mauriciopoppe mauriciopoppe left a comment

Choose a reason for hiding this comment

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

I left some comments.

/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 24, 2025
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 25, 2025
@laozc laozc force-pushed the add-prom-metrics branch 2 times, most recently from 65686bb to 1d2293d Compare February 25, 2025 14:06
mauriciopoppe
mauriciopoppe reviewed Feb 25, 2025
View reviewed changes
@laozc laozc force-pushed the add-prom-metrics branch 2 times, most recently from fdca099 to 8dc99b9 Compare March 1, 2025 13:35
mauriciopoppe
mauriciopoppe reviewed Mar 1, 2025
View reviewed changes
Copy link
Member

@mauriciopoppe mauriciopoppe left a comment

Choose a reason for hiding this comment

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

I wrote a few comments in the setup of the server and on inlining the code. The approach looks good to me, thanks.

pkg/server/metrics/metrics.go Outdated
}
}

func ExportMetrics(metricsAddress string) {
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Exported function should be documented.

cmd/csi-proxy/main.go Outdated

enableMetrics := *metricsBindAddr != ""
if enableMetrics {
metrics.ExportMetrics(*metricsBindAddr)
Copy link
Member

@mauriciopoppe mauriciopoppe Mar 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

If I want to enable metrics and by some reason ExportMetrics fails then this line won't fail and continue silently.

What about metrics.ExportMetrics returning an error that's checked while setting up CSI Proxy? I think we should panic with the error returned.

pkg/server/metrics/metrics.go
}
l, err := net.Listen("tcp", metricsAddress)
if err != nil {
klog.Warningf("failed to get listener for metrics endpoint: %v", err)
Copy link
Member

Choose a reason for hiding this comment

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

Please return an error here.

pkg/server/metrics/metrics.go Outdated
}
}

func ExportMetrics(metricsAddress string) {
Copy link
Member

Choose a reason for hiding this comment

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

This method is setting up a metrics server, what about naming it as such? e.g. SetupMetricsServer

pkg/server/metrics/metrics.go Outdated
klog.Warningf("failed to get listener for metrics endpoint: %v", err)
return
}
serve(l, serveMetrics)
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to have an additional function? What about inlining the contents of serve here? Same for inlining serveMetrics

@laozc laozc force-pushed the add-prom-metrics branch from 8dc99b9 to 1dae255 Compare March 6, 2025 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mauriciopoppe mauriciopoppe mauriciopoppe left review comments

@ggriffiths ggriffiths Awaiting requested review from ggriffiths

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@laozc @k8s-ci-robot @mauriciopoppe