Skip to content

Commit

Permalink
docs: fix rendering of placeholders in metrics table and add anchor f…
Browse files Browse the repository at this point in the history 
…or operator SDK metrics (#2580)

Signed-off-by: David Sondermann <david.sondermann@hivemq.com>
  • Loading branch information
@Donnerbart
Donnerbart authored Nov 15, 2024
1 parent 0df6c52 commit 41c8ee1
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions docsy/content/en/docs/features/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -804,24 +804,26 @@ MicrometerMetrics.newPerResourceCollectingMicrometerMetricsBuilder(registry)
.build()
```

### Operator SDK metrics

The micrometer implementation records the following metrics:

| Meter name | Type | Tag names | Description |
|-----------------------------------------------------------|----------------|-----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| operator.sdk.reconciliations.executions.<reconciler name> | gauge | group, version, kind | Number of executions of the named reconciler |
| operator.sdk.reconciliations.queue.size.<reconciler name> | gauge | group, version, kind | How many resources are queued to get reconciled by named reconciler |
| operator.sdk.<map name>.size | gauge map size | | Gauge tracking the size of a specified map (currently unused but could be used to monitor caches size) |
| operator.sdk.events.received | counter | <resource metadata>, event, action | Number of received Kubernetes events |
| operator.sdk.events.delete | counter | <resource metadata> | Number of received Kubernetes delete events |
| operator.sdk.reconciliations.started | counter | <resource metadata>, reconciliations.retries.last, reconciliations.retries.number | Number of started reconciliations per resource type |
| operator.sdk.reconciliations.failed | counter | <resource metadata>, exception | Number of failed reconciliations per resource type |
| operator.sdk.reconciliations.success | counter | <resource metadata> | Number of successful reconciliations per resource type |
| operator.sdk.controllers.execution.reconcile | timer | <resource metadata>, controller | Time taken for reconciliations per controller |
| operator.sdk.controllers.execution.cleanup | timer | <resource metadata>, controller | Time taken for cleanups per controller |
| operator.sdk.controllers.execution.reconcile.success | counter | controller, type | Number of successful reconciliations per controller |
| operator.sdk.controllers.execution.reconcile.failure | counter | controller, exception | Number of failed reconciliations per controller |
| operator.sdk.controllers.execution.cleanup.success | counter | controller, type | Number of successful cleanups per controller |
| operator.sdk.controllers.execution.cleanup.failure | counter | controller, exception | Number of failed cleanups per controller |
| Meter name | Type | Tag names | Description |
|-------------------------------------------------------------|----------------|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| operator.sdk.reconciliations.executions.`<reconciler name>` | gauge | group, version, kind | Number of executions of the named reconciler |
| operator.sdk.reconciliations.queue.size.`<reconciler name>` | gauge | group, version, kind | How many resources are queued to get reconciled by named reconciler |
| operator.sdk.`<map name>`.size | gauge map size | | Gauge tracking the size of a specified map (currently unused but could be used to monitor caches size) |
| operator.sdk.events.received | counter | `<resource metadata>`, event, action | Number of received Kubernetes events |
| operator.sdk.events.delete | counter | `<resource metadata>` | Number of received Kubernetes delete events |
| operator.sdk.reconciliations.started | counter | `<resource metadata>`, reconciliations.retries.last, reconciliations.retries.number | Number of started reconciliations per resource type |
| operator.sdk.reconciliations.failed | counter | `<resource metadata>`, exception | Number of failed reconciliations per resource type |
| operator.sdk.reconciliations.success | counter | `<resource metadata>` | Number of successful reconciliations per resource type |
| operator.sdk.controllers.execution.reconcile | timer | `<resource metadata>`, controller | Time taken for reconciliations per controller |
| operator.sdk.controllers.execution.cleanup | timer | `<resource metadata>`, controller | Time taken for cleanups per controller |
| operator.sdk.controllers.execution.reconcile.success | counter | controller, type | Number of successful reconciliations per controller |
| operator.sdk.controllers.execution.reconcile.failure | counter | controller, exception | Number of failed reconciliations per controller |
| operator.sdk.controllers.execution.cleanup.success | counter | controller, type | Number of successful cleanups per controller |
| operator.sdk.controllers.execution.cleanup.failure | counter | controller, exception | Number of failed cleanups per controller |

As you can see all the recorded metrics start with the `operator.sdk` prefix. `<resource metadata>`, in the table above,
refers to resource-specific metadata and depends on the considered metric and how the implementation is configured and
Expand Down

0 comments on commit 41c8ee1

Please sign in to comment.