Skip to content

Commit 39c7839

Browse files
committed
docs: update README with OperationMeta output examples
Document both CompositionMeta and OperationMeta context types in the output format examples. Fix text format example to show Step and Function on separate lines matching actual output.
1 parent 1c32854 commit 39c7839

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,21 +68,30 @@ sidecarsCrossplane:
6868
6969
### JSON Format (default)
7070
71+
The meta field contains either `compositionMeta` (for XR reconciliation) or `operationMeta` (for standalone operations):
72+
73+
```json
74+
{"meta":{"compositionMeta":{"compositeResourceApiVersion":"example.org/v1","compositeResourceKind":"XDatabase","compositeResourceName":"my-db","compositeResourceNamespace":"default","compositeResourceUid":"abc-123","compositionName":"my-composition"},"functionName":"function-patch-and-transform","iteration":0,"spanId":"span-456","stepIndex":0,"timestamp":"2026-01-15T10:30:00Z","traceId":"trace-789"},"payload":{...},"type":"REQUEST"}
75+
```
76+
7177
```json
72-
{"meta":{"compositeResourceApiVersion":"example.org/v1","compositeResourceKind":"XDatabase","compositeResourceName":"my-db","compositeResourceNamespace":"default","compositeResourceUid":"abc-123","compositionName":"my-composition","functionName":"function-patch-and-transform","iteration":0,"spanId":"span-456","stepIndex":0,"timestamp":"2026-01-15T10:30:00Z","traceId":"trace-789"},"payload":{...},"type":"REQUEST"}
78+
{"meta":{"operationMeta":{"operationName":"reconcile","operationUid":"op-uid-123"},"functionName":"function-patch-and-transform","iteration":0,"spanId":"span-456","stepIndex":0,"timestamp":"2026-01-15T10:30:00Z","traceId":"trace-789"},"payload":{...},"type":"REQUEST"}
7379
```
7480

7581
### Text Format
7682

77-
Use `--format=text` for human-readable output:
83+
Use `--format=text` for human-readable output. The output adapts based on the context type:
84+
85+
#### Composition Context (XR reconciliation)
7886

7987
```
8088
=== REQUEST ===
8189
XR: example.org/v1/XDatabase (my-db)
8290
XR UID: abc-123
8391
XR NS: default
8492
Composition: my-composition
85-
Function: function-patch-and-transform (step 0, iteration 0)
93+
Step: my-step (index 0, iteration 0)
94+
Function: function-patch-and-transform
8695
Trace ID: trace-789
8796
Span ID: span-456
8897
Timestamp: 2026-01-15T10:30:00.000Z
@@ -91,6 +100,21 @@ Use `--format=text` for human-readable output:
91100
...
92101
```
93102
103+
#### Operation Context (standalone operations)
104+
105+
```
106+
=== REQUEST ===
107+
Operation: reconcile
108+
Op UID: op-uid-123
109+
Step: my-step (index 0, iteration 0)
110+
Function: function-patch-and-transform
111+
Trace ID: trace-789
112+
Span ID: span-456
113+
Timestamp: 2026-01-15T10:30:00.000Z
114+
Payload:
115+
...
116+
```
117+
94118
## Building
95119
96120
```bash

0 commit comments

Comments
 (0)