Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,12 +200,25 @@ func main() {

## Usage

The easiest drop-in way to start using the metrics recorder it with `SetStatusCondition`, which
The easiest drop-in way to start using the metrics recorder is by creating a `SetStatusCondition` wrapper, which
comes instead of `meta.SetStatusCondition`.

To delete the metrics for a given custom resource, simply call `RemoveConditionsFor` and pass the object.

```go
const (
kind = "MyCr"
)

// SetStatusCondition utility function which replaces and wraps meta.SetStatusCondition calls
func (r *MyReconciler) SetStatusCondition(cr *v1.MyCR, condition metav1.Condition) bool {
changed = meta.SetStatusCondition(&cr.Status.Conditions, condition)
if changed {
r.RecordConditionFor(kind, cr, condition.Type, string(condition.Status), condition.Reason)
}
return changed
}

func (r *MyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
// Get the resource we're reconciling
cr := new(v1.MyCR)
Expand All @@ -215,21 +228,18 @@ func (r *MyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Re

// Remove the metrics when the CR is deleted
if cr.DeletionTimeStamp != nil {
r.Recorder.RemoveConditionsFor(cr)
r.Recorder.RemoveConditionsFor(kind, cr)
}

// ...

// Update the status conditions using the recorder (it records the metric if changed)
if r.Recorder.SetStatusCondition(cr, &cr.Status.Conditions, condition) {
if r.SetStatusCondition(cr, condition) {
if err = r.Status().Update(ctx, cr); err != nil {
return ctrl.Result{}, err
}
}

return ctrl.Result{}, nil
}
```

You can also use `RecordConditionFor` for more flexible metric recording without updating the custom resource's status
conditions, but generally, the `SetStatusCondition` is commonly used in controllers and should be preferred.
```
39 changes: 2 additions & 37 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -6,56 +6,21 @@ require (
github.com/prometheus/client_golang v1.23.2
github.com/prometheus/common v0.66.1
github.com/stretchr/testify v1.11.1
k8s.io/apimachinery v0.34.1
sigs.k8s.io/controller-runtime v0.22.1
)

require (
github.com/beorn7/perks v1.0.1 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/emicklei/go-restful/v3 v3.12.2 // indirect
github.com/evanphx/json-patch/v5 v5.9.11 // indirect
github.com/fxamacker/cbor/v2 v2.9.0 // indirect
github.com/go-logr/logr v1.4.2 // indirect
github.com/go-openapi/jsonpointer v0.21.0 // indirect
github.com/go-openapi/jsonreference v0.20.2 // indirect
github.com/go-openapi/swag v0.23.0 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/google/gnostic-models v0.7.0 // indirect
github.com/google/go-cmp v0.7.0 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/josharian/intern v1.0.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/kr/text v0.2.0 // indirect
github.com/kylelemons/godebug v1.1.0 // indirect
github.com/mailru/easyjson v0.7.7 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee // indirect
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/prometheus/client_model v0.6.2 // indirect
github.com/prometheus/procfs v0.16.1 // indirect
github.com/x448/float16 v0.8.4 // indirect
github.com/rogpeppe/go-internal v1.13.1 // indirect
go.yaml.in/yaml/v2 v2.4.2 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/net v0.43.0 // indirect
golang.org/x/oauth2 v0.30.0 // indirect
golang.org/x/sys v0.35.0 // indirect
golang.org/x/term v0.34.0 // indirect
golang.org/x/text v0.28.0 // indirect
golang.org/x/time v0.9.0 // indirect
google.golang.org/protobuf v1.36.8 // indirect
gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/api v0.34.0 // indirect
k8s.io/client-go v0.34.0 // indirect
k8s.io/klog/v2 v2.130.1 // indirect
k8s.io/kube-openapi v0.0.0-20250710124328-f3f2b991d03b // indirect
k8s.io/utils v0.0.0-20250604170112-4c0f3b243397 // indirect
sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 // indirect
sigs.k8s.io/randfill v1.0.0 // indirect
sigs.k8s.io/structured-merge-diff/v6 v6.3.0 // indirect
sigs.k8s.io/yaml v1.6.0 // indirect
)
Loading