Skip to content

Commit bc6a044

Browse files
thompson-tomosmith
andcommitted
Implementation of review feedback
Co-authored-by: Nathan L Smith <[email protected]>
1 parent bd2c3e6 commit bc6a044

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

docs/proposals/bundles.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ bundle:
1818
- name: server
1919
brief: Defines a server
2020
note:
21-
attributes
22-
- ref: sever.address
23-
- ref: sever.port
21+
attributes:
22+
- ref: server.address
23+
- ref: server.port
2424
```
2525

2626
Once it is defined, it can then be used on other signals to extend the definition.
2727

2828
```
2929
span:
3030
- name: messaging.produced
31-
brief: Defines a span for sending a message via a message brooker such as rabbitmq
31+
brief: Defines a span for sending a message via a message broker such as RabbitMQ
3232
note:
33-
attributes
33+
attributes:
3434
- ref: message.system.name
3535
bundles:
3636
- ref: server
@@ -41,25 +41,26 @@ In terms of the resolved schema, these bundles are blended seamlessly in to the
4141
```
4242
span:
4343
- name: messaging.produced
44-
brief: Defines a span for sending a message via a message brooker such as rabbitmq
44+
brief: Defines a span for sending a message via a message broker such as RabbitMQ
4545
note:
46-
attributes
46+
attributes:
4747
- id: message.system.name
4848
....
49-
- id: sever.address
49+
- id: server.address
5050
....
51-
- id: sever.port
51+
- id: server.port
5252
....
5353
```
5454

5555
By adopting this approach we are improving the mantainability of the definitions,
56-
by reusing the definition rather than copy and pasting strucutures.
56+
by reusing the definition rather than copying and pasting structures.
5757

5858
### Extending signals
5959

6060
This use case is similiar to the previous except it is focussed on offering optional contextual extensions.
61-
An example of this extension would be Cloud Events which are only applicable if the application is using Cloud Events,
62-
hence the usage is contextual based upon cloud events being used.
61+
An example of this extension would be CloudEvents which are only applicable if the application is using CloudEvents,
62+
hence the usage is contextual based upon CloudEvents being used.
63+
The concept of CloudEvents is described in [CloudEvents Primer](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md).
6364

6465
To indicate that a bundle is contextual, this can be done by defining this on the bundle, just like below for `cloud_events`:
6566

@@ -69,7 +70,7 @@ bundle:
6970
brief: For more information on the concepts, terminology and background of CloudEvents consult the CloudEvents Primer document.
7071
context: Can be used when a cloud event payload is being handled (sent/recieved).
7172
note:
72-
attributes
73+
attributes:
7374
- ref: cloudevents.event_id
7475
- ref: cloudevents.event_source
7576
......
@@ -98,9 +99,9 @@ span:
9899
attributes
99100
- id: message.system.name
100101
....
101-
- id: sever.address
102+
- id: server.address
102103
....
103-
- id: sever.port
104+
- id: server.port
104105
....
105106
- id: cloudevents.event_id
106107
bundle: cloud_events
@@ -112,7 +113,7 @@ span:
112113
....
113114
```
114115

115-
By adopting this approach the definition of cloud events can easily be added/extended without needing to touch the usage.
116+
By adopting this approach the definition of CloudEvents can easily be added/extended without needing to touch the usage.
116117

117118
## Comparison to v1 solution
118119
Attribute bundles are similiar to attribute groups however,

0 commit comments

Comments
 (0)