-
Notifications
You must be signed in to change notification settings - Fork 183
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[chore] Move CloudEvents attributes to the registry (#837)
- Loading branch information
1 parent
0941ebb
commit f8f1e16
Showing
8 changed files
with
70 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| ---> | ||
|
|
||
| # CloudEvents | ||
|
|
||
| ## CloudEvents Attributes | ||
|
|
||
| <!-- semconv registry.cloudevents(omit_requirement_level) --> | ||
| | Attribute | Type | Description | Examples | | ||
| |---|---|---|---| | ||
| | `cloudevents.event_id` | string | The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event. | `123e4567-e89b-12d3-a456-426614174000`; `0001` | | ||
| | `cloudevents.event_source` | string | The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened. | `https://github.com/cloudevents`; `/cloudevents/spec/pull/123`; `my-service` | | ||
| | `cloudevents.event_spec_version` | string | The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses. | `1.0` | | ||
| | `cloudevents.event_subject` | string | The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source). | `mynewfile.jpg` | | ||
| | `cloudevents.event_type` | string | The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence. | `com.github.pull_request.opened`; `com.example.object.deleted.v2` | | ||
| <!-- endsemconv --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| groups: | ||
| - id: registry.cloudevents | ||
| prefix: cloudevents | ||
| type: attribute_group | ||
| brief: > | ||
| This document defines attributes for CloudEvents. | ||
| attributes: | ||
| - id: event_id | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event. | ||
| examples: ['123e4567-e89b-12d3-a456-426614174000', '0001'] | ||
| - id: event_source | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened. | ||
| examples: ['https://github.com/cloudevents', '/cloudevents/spec/pull/123', 'my-service' ] | ||
| - id: event_spec_version | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses. | ||
| examples: '1.0' | ||
| - id: event_type | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence. | ||
| examples: ['com.github.pull_request.opened', 'com.example.object.deleted.v2'] | ||
| - id: event_subject | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source). | ||
| examples: 'mynewfile.jpg' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,18 @@ | ||
| groups: | ||
| - id: cloudevents | ||
| prefix: cloudevents | ||
| type: span | ||
| brief: > | ||
| This document defines attributes for CloudEvents. | ||
| CloudEvents is a specification on how to define event data in a standard way. | ||
| These attributes can be attached to spans when performing operations with CloudEvents, regardless of the protocol being used. | ||
| attributes: | ||
| - id: event_id | ||
| type: string | ||
| stability: experimental | ||
| - ref: cloudevents.event_id | ||
| requirement_level: required | ||
| brief: > | ||
| The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event. | ||
| examples: ['123e4567-e89b-12d3-a456-426614174000', '0001'] | ||
| - id: event_source | ||
| type: string | ||
| stability: experimental | ||
| - ref: cloudevents.event_source | ||
| requirement_level: required | ||
| brief: > | ||
| The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened. | ||
| examples: ['https://github.com/cloudevents', '/cloudevents/spec/pull/123', 'my-service' ] | ||
| - id: event_spec_version | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses. | ||
| examples: '1.0' | ||
| - id: event_type | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence. | ||
| examples: ['com.github.pull_request.opened', 'com.example.object.deleted.v2'] | ||
| - id: event_subject | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source). | ||
| examples: 'mynewfile.jpg' | ||
| - ref: cloudevents.event_spec_version | ||
| requirement_level: recommended | ||
| - ref: cloudevents.event_type | ||
| requirement_level: recommended | ||
| - ref: cloudevents.event_subject | ||
| requirement_level: recommended |