Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 3.9 KB

cloudevents-spans.md

File metadata and controls

72 lines (51 loc) · 3.9 KB

Semantic Conventions for CloudEvents Spans

Status: Experimental

Definitions

From the CloudEvents specification:

CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms and systems.

For more information on the concepts, terminology and background of CloudEvents consult the CloudEvents Primer document.

Conventions

CloudEvent-specific instrumentations SHOULD follow the span structure described in the Semantic Conventions for Messaging Spans.

If CloudEvents are instrumented independently of the above conventions, instrumentations can rely on the CloudEvents Distributed Tracing Extension as means to propagate the trace context.

Span attributes

Additionally, instrumentations may record the following CloudEvent-specific attributes on spans created from the conventions described above.

Attribute Type Description Examples Requirement Level Stability
cloudevents.event_id string The event_id uniquely identifies the event. 123e4567-e89b-12d3-a456-426614174000; 0001 Required Experimental
cloudevents.event_source string The source identifies the context in which an event happened. https://github.com/cloudevents; /cloudevents/spec/pull/123; my-service Required Experimental
cloudevents.event_spec_version string The version of the CloudEvents specification which the event uses. 1.0 Recommended Experimental
cloudevents.event_subject string The subject of the event in the context of the event producer (identified by source). mynewfile.jpg Recommended Experimental
cloudevents.event_type string The event_type contains a value describing the type of event related to the originating occurrence. com.github.pull_request.opened; com.example.object.deleted.v2 Recommended Experimental