Skip to content

Commit 067758f

Browse files
committed
update docs
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
1 parent 7ab9557 commit 067758f

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/content/en/docs/documentation/observability.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,23 @@ parts of reconciliation logic and during the execution of the controller:
3333

3434
For more information about MDC see this [link](https://www.baeldung.com/mdc-in-log4j-2-logback).
3535

36+
### MDC entries during event handling
37+
38+
Although, usually users might not require it in their day-to-day workflow, it is worth to mention that
39+
there are additional MDC entries managed for event handling. Typically, you might be interested in it
40+
in your `SecondaryToPrimaryMapper` related logs.
41+
For `InformerEventSource` and `ControllerEventSource` the following information is present:
42+
43+
| MDC Key | Value from Resource from the Event |
44+
|:-----------------------------------------------|:-------------------------------------------------|
45+
| `eventsource.event.resource.name` | `.metadata.name` |
46+
| `eventsource.event.resource.uid` | `.metadata.uid` |
47+
| `eventsource.event.resource.namespace` | `.metadata.namespace` |
48+
| `eventsource.event.resource.kind` | resource kind |
49+
| `eventsource.event.resource.resourceVersion` | `.metadata.resourceVersion` |
50+
| `eventsource.event.action` | action name (e.g. `ADDED`, `UPDATED`, `DELETED`) |
51+
| `eventsource.name` | name of the event source |
52+
3653
## Metrics
3754

3855
JOSDK provides built-in support for metrics reporting on what is happening with your reconcilers in the form of

0 commit comments

Comments
 (0)