-
Notifications
You must be signed in to change notification settings - Fork 547
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
Expose csi sidecar metrics for cephfs, rbd and nfs #4887
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider providing a way to disable the http-endpoint exposing.
af3aa26
to
2d3010e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Could you get a sample of the metrics that are provided, or point to the documentation of the different sidecars in the PR description?
charts/ceph-csi-cephfs/values.yaml
Outdated
@@ -214,6 +214,11 @@ provisioner: | |||
## https://github.com/kubernetes-csi/external-provisioner#command-line-options | |||
extraArgs: [] | |||
|
|||
args: | |||
# httpEndpoint enables the http server for diagnostics, | |||
# health checks and metrics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe also mention that not providing the option disables it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO we should not have it enabled but disable by default (commenting the port) and let the user enable it when required
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disabled the option by default, and added a comment mentioning how to enable it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh, it seems you've missed the documentation in the README at https://github.com/ceph/ceph-csi/tree/devel/charts/ceph-csi-rbd, and for cephfs too.
charts/ceph-csi-cephfs/values.yaml
Outdated
@@ -214,6 +214,11 @@ provisioner: | |||
## https://github.com/kubernetes-csi/external-provisioner#command-line-options | |||
extraArgs: [] | |||
|
|||
args: | |||
# httpEndpoint enables the http server for diagnostics, | |||
# health checks and metrics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO we should not have it enabled but disable by default (commenting the port) and let the user enable it when required
ecbf689
to
12a8986
Compare
Sample truncated output for
Sample output for
Sample truncated output for
Sample truncated output for
|
Also, updated the PR descrition to include the documentation links for each sidecar to add the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small improvement for the documentation/helm option would be good to have.
12a8986
to
f749333
Compare
Can you please also check why we are getting unknown-driver here |
From what I can see from the sidecar code is that intitially when the metrics is initialized the driver name is not provided to the it, later on the driver name is updated in the metrics manager. That's the reason we are initially seeing Same applies for attacher, resizer and snapshotter |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
small nit for naming, LGTM
@Mergifyio queue |
✅ The pull request has been merged automaticallyThe pull request has been merged automatically at 81764de |
Expose csi metrics of sidecars deployed by cephfs driver Signed-off-by: Nikhil-Ladha <[email protected]>
Expose csi metrics of sidecars deployed by rbd driver Signed-off-by: Nikhil-Ladha <[email protected]>
Expose csi metrics of sidecars deployed by nfs driver Signed-off-by: Nikhil-Ladha <[email protected]>
Added a release note for csi sidecar metrics Signed-off-by: Nikhil-Ladha <[email protected]>
f749333
to
8ee161b
Compare
/test ci/centos/k8s-e2e-external-storage/1.30 |
/test ci/centos/mini-e2e-helm/k8s-1.30 |
/test ci/centos/k8s-e2e-external-storage/1.29 |
/test ci/centos/upgrade-tests-cephfs |
/test ci/centos/k8s-e2e-external-storage/1.31 |
/test ci/centos/mini-e2e/k8s-1.30 |
/test ci/centos/mini-e2e-helm/k8s-1.29 |
/test ci/centos/upgrade-tests-rbd |
/test ci/centos/mini-e2e-helm/k8s-1.31 |
/test ci/centos/mini-e2e/k8s-1.29 |
/test ci/centos/mini-e2e/k8s-1.31 |
Describe what this PR does
Expose CSI sidecar metrics for cephfs, rbd and nfs drivers.
Also, added port definitions in the deployment spec for each container for information/best practice purposes.
Is the change backward compatible?
Maybe, or may not be. Depends on the user, if they have their ports blocked due to security reasons.
Are there concerns around backward compatibility?
None.
But, if the user wants to access the sidecar metrics they need to make sure that the ports are not blocked by firewall in their cluster.
Documentation of each sidecar for enabling the httpEndpoint:
Related issues
Fixes: #881
Checklist:
guidelines in the developer
guide.
Request
notes
updated with breaking and/or notable changes for the next major release.
Show available bot commands
These commands are normally not required, but in case of issues, leave any of
the following bot commands in an otherwise empty comment in this PR:
/retest ci/centos/<job-name>
: retest the<job-name>
after unrelatedfailure (please report the failure too!)