Skip to content

Commit 41c8ee1

Browse files
DonnerbartDonnerbart
authored
docs: fix rendering of placeholders in metrics table and add anchor for operator SDK metrics (#2580)
Signed-off-by: David Sondermann <[email protected]>
1 parent 0df6c52 commit 41c8ee1

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

‎docsy/content/en/docs/features/_index.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -804,24 +804,26 @@ MicrometerMetrics.newPerResourceCollectingMicrometerMetricsBuilder(registry)
804804
.build()
805805
```
806806

807+
### Operator SDK metrics
808+
807809
The micrometer implementation records the following metrics:
808810

809-
| Meter name | Type | Tag names | Description |
810-
|-----------------------------------------------------------|----------------|-----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
811-
| operator.sdk.reconciliations.executions.<reconciler name> | gauge | group, version, kind | Number of executions of the named reconciler |
812-
| operator.sdk.reconciliations.queue.size.<reconciler name> | gauge | group, version, kind | How many resources are queued to get reconciled by named reconciler |
813-
| 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) |
814-
| operator.sdk.events.received | counter | <resource metadata>, event, action | Number of received Kubernetes events |
815-
| operator.sdk.events.delete | counter | <resource metadata> | Number of received Kubernetes delete events |
816-
| operator.sdk.reconciliations.started | counter | <resource metadata>, reconciliations.retries.last, reconciliations.retries.number | Number of started reconciliations per resource type |
817-
| operator.sdk.reconciliations.failed | counter | <resource metadata>, exception | Number of failed reconciliations per resource type |
818-
| operator.sdk.reconciliations.success | counter | <resource metadata> | Number of successful reconciliations per resource type |
819-
| operator.sdk.controllers.execution.reconcile | timer | <resource metadata>, controller | Time taken for reconciliations per controller |
820-
| operator.sdk.controllers.execution.cleanup | timer | <resource metadata>, controller | Time taken for cleanups per controller |
821-
| operator.sdk.controllers.execution.reconcile.success | counter | controller, type | Number of successful reconciliations per controller |
822-
| operator.sdk.controllers.execution.reconcile.failure | counter | controller, exception | Number of failed reconciliations per controller |
823-
| operator.sdk.controllers.execution.cleanup.success | counter | controller, type | Number of successful cleanups per controller |
824-
| operator.sdk.controllers.execution.cleanup.failure | counter | controller, exception | Number of failed cleanups per controller |
811+
| Meter name | Type | Tag names | Description |
812+
|-------------------------------------------------------------|----------------|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
813+
| operator.sdk.reconciliations.executions.`<reconciler name>` | gauge | group, version, kind | Number of executions of the named reconciler |
814+
| operator.sdk.reconciliations.queue.size.`<reconciler name>` | gauge | group, version, kind | How many resources are queued to get reconciled by named reconciler |
815+
| 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) |
816+
| operator.sdk.events.received | counter | `<resource metadata>`, event, action | Number of received Kubernetes events |
817+
| operator.sdk.events.delete | counter | `<resource metadata>` | Number of received Kubernetes delete events |
818+
| operator.sdk.reconciliations.started | counter | `<resource metadata>`, reconciliations.retries.last, reconciliations.retries.number | Number of started reconciliations per resource type |
819+
| operator.sdk.reconciliations.failed | counter | `<resource metadata>`, exception | Number of failed reconciliations per resource type |
820+
| operator.sdk.reconciliations.success | counter | `<resource metadata>` | Number of successful reconciliations per resource type |
821+
| operator.sdk.controllers.execution.reconcile | timer | `<resource metadata>`, controller | Time taken for reconciliations per controller |
822+
| operator.sdk.controllers.execution.cleanup | timer | `<resource metadata>`, controller | Time taken for cleanups per controller |
823+
| operator.sdk.controllers.execution.reconcile.success | counter | controller, type | Number of successful reconciliations per controller |
824+
| operator.sdk.controllers.execution.reconcile.failure | counter | controller, exception | Number of failed reconciliations per controller |
825+
| operator.sdk.controllers.execution.cleanup.success | counter | controller, type | Number of successful cleanups per controller |
826+
| operator.sdk.controllers.execution.cleanup.failure | counter | controller, exception | Number of failed cleanups per controller |
825827

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

0 commit comments

Comments
 (0)