chore: add labels to metrics #1433

Suraiya-Hameed · 2024-01-30T16:55:27Z

What type of PR is this?
/kind feature
/kind documentation

What this PR does / why we need it:

Adds additional labels pod_name, pod_namespace and secret_provider_class to the existing metrics.
Fixes documentation about current metrics

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #1344

Special notes for your reviewer:

TODOs:

squashed commits
includes documentation
adds unit tests

k8s-ci-robot · 2024-01-30T16:55:36Z

Hi @Suraiya-Hameed. 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 · 2024-01-30T16:55:42Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Suraiya-Hameed
Once this PR has been reviewed and has the lgtm label, please assign aramase for approval. For more information see the Kubernetes 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:

OWNERS

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

aramase

/ok-to-test

Suraiya-Hameed · 2024-02-01T20:09:27Z

@aramase is there anything I should do about the pull-secrets-store-csi-driver-e2e-windows tests failing, looks like intermittent failure from the history!

aramase · 2024-02-05T19:08:47Z

@aramase is there anything I should do about the pull-secrets-store-csi-driver-e2e-windows tests failing, looks like intermittent failure from the history!

Nothing you need to do. It seems to be a flake with cluster creation.

aramase · 2024-02-05T19:09:04Z

/retest-required

Suraiya-Hameed · 2024-02-08T19:30:37Z

@aramase gentle nudge to review this PR.

aramase · 2024-02-22T18:48:51Z

/assign nilekhc

pkg/secrets-store/mocks/stats_reporter_mock.go

docs/book/src/topics/metrics.md

pkg/secrets-store/nodeserver_test.go

codecov-commenter · 2024-02-23T22:18:05Z

Codecov Report

Attention: Patch coverage is 53.48837% with 40 lines in your changes missing coverage. Please review.

Project coverage is 36.00%. Comparing base (d308d13) to head (525f176).
Report is 98 commits behind head on main.

Files with missing lines	Patch %	Lines
controllers/stats_reporter.go	0.00%	22 Missing ⚠️
pkg/secrets-store/stats_reporter.go	0.00%	8 Missing ⚠️
...rollers/secretproviderclasspodstatus_controller.go	0.00%	7 Missing ⚠️
pkg/rotation/reconciler.go	83.33%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1433      +/-   ##
==========================================
- Coverage   36.51%   36.00%   -0.52%     
==========================================
  Files          63       64       +1     
  Lines        4532     3791     -741     
==========================================
- Hits         1655     1365     -290     
+ Misses       2732     2282     -450     
+ Partials      145      144       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

controllers/secretproviderclasspodstatus_controller.go

pkg/rotation/reconciler.go

pkg/secrets-store/nodeserver_test.go

k8s-triage-robot · 2024-06-20T20:08:55Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2024-07-20T21:05:46Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle rotten
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2024-08-19T22:03:21Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2024-08-19T22:03:27Z

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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.

hakman · 2024-08-30T14:53:04Z

/reopen

k8s-ci-robot · 2024-08-30T14:53:09Z

@hakman: Reopened this PR.

In response to this:

/reopen

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.

hakman · 2024-08-30T14:53:35Z

/remove-lifecycle rotten

aramase

Just 1 comment about not partitioning sync metrics on the os runtime attribute.

aramase · 2024-09-30T21:14:53Z

controllers/stats_reporter.go

+func (r reporter) ReportSyncSecretCtMetric(ctx context.Context, provider, namespace, spc string) {
+	opt := metric.WithAttributes(
+		attribute.Key(providerKey).String(provider),
+		attribute.Key(osTypeKey).String(runtimeOS),


Suggested change

attribute.Key(osTypeKey).String(runtimeOS),

The os key attribute is not relevant for the sync controller because it's a Kubernetes API object. The only reason it's used in driver metrics is to show the os runtime for the mount operation.

aramase · 2024-09-30T21:15:29Z

controllers/stats_reporter.go

+	opt := metric.WithAttributes(
+		attribute.Key(osTypeKey).String(runtimeOS),


same comment as above

aramase · 2024-09-30T21:16:19Z

pkg/rotation/reconciler.go

@@ -251,13 +251,16 @@ func (r *Reconciler) reconcile(ctx context.Context, spcps *secretsstorev1.Secret
 	// after the provider mount request is complete
 	var requiresUpdate bool
 	var providerName string
+	podName := spcps.Status.PodName
+	podNamespace := spcps.Namespace
+	secretProviderClass := spcps.Status.SecretProviderClassName


Suggested change

secretProviderClass := spcps.Status.SecretProviderClassName

secretProviderClassName := spcps.Status.SecretProviderClassName

@Suraiya-Hameed

Original work by @Suraiya-Hameed in kubernetes-sigs#1433 Changes: - Minor refinements suggested by project maintainers Co-authored-by: Suraiya Hameed <Suraiya-Hameed@users.noreply.github.com>

@Suraiya-Hameed

Original work by @Suraiya-Hameed in kubernetes-sigs#1433 Changes: - Minor refinements suggested by project maintainers Co-authored-by: Suraiya Hameed <Suraiya-Hameed@users.noreply.github.com>

@Suraiya-Hameed

Original work by @Suraiya-Hameed in kubernetes-sigs#1433

k8s-triage-robot · 2024-12-29T21:40:58Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 30, 2024

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 Jan 30, 2024

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 30, 2024

k8s-ci-robot requested review from aramase and ritazh January 30, 2024 16:55

aramase reviewed Jan 31, 2024

View reviewed changes

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 Jan 31, 2024

k8s-ci-robot assigned nilekhc Feb 22, 2024

nilekhc reviewed Feb 22, 2024

View reviewed changes

pkg/secrets-store/mocks/stats_reporter_mock.go Show resolved Hide resolved

docs/book/src/topics/metrics.md Outdated Show resolved Hide resolved

pkg/secrets-store/nodeserver_test.go Show resolved Hide resolved

Suraiya-Hameed force-pushed the csi-metric-label branch 2 times, most recently from 05df2a7 to 7eb8f38 Compare February 22, 2024 20:11

Suraiya-Hameed force-pushed the csi-metric-label branch 2 times, most recently from 38a5332 to 4fb19fa Compare March 19, 2024 17:49

aramase requested changes Mar 22, 2024

View reviewed changes

controllers/secretproviderclasspodstatus_controller.go Outdated Show resolved Hide resolved

pkg/rotation/reconciler.go Show resolved Hide resolved

pkg/secrets-store/nodeserver_test.go Outdated Show resolved Hide resolved

chore: add labels to metrics

525f176

Suraiya-Hameed force-pushed the csi-metric-label branch from 08dd07f to 525f176 Compare March 22, 2024 19:17

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 20, 2024

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 20, 2024

k8s-ci-robot closed this Aug 19, 2024

k8s-ci-robot reopened this Aug 30, 2024

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Aug 30, 2024

aramase requested changes Sep 30, 2024

View reviewed changes

marcelocyreno mentioned this pull request Oct 23, 2024

chore: add labels to metrics (updated) #1672

Closed

3 tasks

marcelocyreno mentioned this pull request Oct 23, 2024

chore: add labels to metrics #1673

Open

3 tasks

marcelocyreno added a commit to marcelocyreno/secrets-store-csi-driver that referenced this pull request Oct 23, 2024

chore: enhance metric labels implementation

4ef8d23

Original work by @Suraiya-Hameed in kubernetes-sigs#1433

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add labels to metrics #1433

chore: add labels to metrics #1433

Suraiya-Hameed commented Jan 30, 2024 •

edited

Loading

k8s-ci-robot commented Jan 30, 2024

k8s-ci-robot commented Jan 30, 2024

aramase left a comment

Suraiya-Hameed commented Feb 1, 2024

aramase commented Feb 5, 2024

aramase commented Feb 5, 2024

Suraiya-Hameed commented Feb 8, 2024

aramase commented Feb 22, 2024

codecov-commenter commented Feb 23, 2024 •

edited

Loading

k8s-triage-robot commented Jun 20, 2024

k8s-triage-robot commented Jul 20, 2024

k8s-triage-robot commented Aug 19, 2024

k8s-ci-robot commented Aug 19, 2024

hakman commented Aug 30, 2024

k8s-ci-robot commented Aug 30, 2024

hakman commented Aug 30, 2024

aramase left a comment

aramase Sep 30, 2024

aramase Sep 30, 2024

aramase Sep 30, 2024

k8s-triage-robot commented Dec 29, 2024

		opt := metric.WithAttributes(
		attribute.Key(osTypeKey).String(runtimeOS),

	secretProviderClass := spcps.Status.SecretProviderClassName
	secretProviderClassName := spcps.Status.SecretProviderClassName

chore: add labels to metrics #1433

Are you sure you want to change the base?

chore: add labels to metrics #1433

Conversation

Suraiya-Hameed commented Jan 30, 2024 • edited Loading

k8s-ci-robot commented Jan 30, 2024

k8s-ci-robot commented Jan 30, 2024

aramase left a comment

Choose a reason for hiding this comment

Suraiya-Hameed commented Feb 1, 2024

aramase commented Feb 5, 2024

aramase commented Feb 5, 2024

Suraiya-Hameed commented Feb 8, 2024

aramase commented Feb 22, 2024

codecov-commenter commented Feb 23, 2024 • edited Loading

Codecov Report

k8s-triage-robot commented Jun 20, 2024

k8s-triage-robot commented Jul 20, 2024

k8s-triage-robot commented Aug 19, 2024

k8s-ci-robot commented Aug 19, 2024

hakman commented Aug 30, 2024

k8s-ci-robot commented Aug 30, 2024

hakman commented Aug 30, 2024

aramase left a comment

Choose a reason for hiding this comment

aramase Sep 30, 2024

Choose a reason for hiding this comment

aramase Sep 30, 2024

Choose a reason for hiding this comment

aramase Sep 30, 2024

Choose a reason for hiding this comment

k8s-triage-robot commented Dec 29, 2024

Suraiya-Hameed commented Jan 30, 2024 •

edited

Loading

codecov-commenter commented Feb 23, 2024 •

edited

Loading