Skip to content

Commit

Permalink
chore(docs): update cloudevents comparison (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
JanKlasser3000 authored Sep 6, 2023
1 parent e99c788 commit aa987d1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion dev-context/async/comparison-cef-cloudevents.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Currently, most events are encoded using CEF. Therefore, this article focuses on
| type and version | [type](https://api.otto.de/portal/guidelines/r200009) | yes | Type must follow name schema defined in our guideline [MUST follow naming scheme for type context attribute](https://api.otto.de/portal/guidelines/r200009). Version must be part of the type within OTTO. |
| context and sequenceKey | part of [source](https://api.otto.de/portal/guidelines/r200010) | yes | source may contain more context information such as the event source. If a sequenceKey exists in CEF, it should be included in the `source` context attribute. See "sequenceNumber" for more information on how to convert the sequence attributes to CloudEvents. |
| eventTime | [time](https://api.otto.de/portal/guidelines/r200011) | yes | |
| traceId and spanId | [traceparent](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/extensions/distributed-tracing.md#traceparent) | yes | trace_parent is defined in the [distributed tracing](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/extensions/distributed-tracing.md) extension. Follows the W3C trace context specification. The trace_parent context attribute contains the traceId as [trace-id segment](https://www.w3.org/TR/trace-context/#trace-id) and the spanId as [parent-id segment](https://www.w3.org/TR/trace-context/#parent-id). TL;DR `traceparent`= `00-<traceId (without the "-")>-<spanId>-00` |
| traceId and spanId | [traceparent](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/extensions/distributed-tracing.md#traceparent) | yes | trace_parent is defined in the [distributed tracing](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/extensions/distributed-tracing.md) extension. Follows the W3C trace context specification. The trace_parent context attribute contains the traceId as [trace-id segment](https://www.w3.org/TR/trace-context/#trace-id) and the spanId as [parent-id segment](https://www.w3.org/TR/trace-context/#parent-id). TL;DR `traceparent`= `00-<traceId (without the "-")>-<spanId>-00`. spanId must be set(value different than only 0). In cloud events trace_parent for now is optional. |
| sequenceNumber | [sequence](https://api.otto.de/portal/guidelines/r200003) | yes | sequence just contains a string. The semantics of this string is either defined by an out-of-band communication or by an additional [sequencetype](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/extensions/sequence.md#sequencetype) context attribute. The predefined [Integer](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/extensions/sequence.md#integer) sequencetype defines the same semantics as `sequenceNumber` in CEF if the `source` context attribute contains the `sequenceKey`. |
| test | n/a | yes | not defined within the CloudEvents spec, may be added by Otto with a custom extension. |
| `{"data": {...} }` | `{ ... }` | yes | The "`data`" node is obsolete with CloudEvents. The payload starts at the beginning. |
Expand Down

0 comments on commit aa987d1

Please sign in to comment.