Adding CloudEvents samples for ASB and SQS #7933
Draft
Conversation
This file contains hidden or 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
afprtclr
force-pushed
the
feature/cloudevents-samples
branch
2 times, most recently
from
67fff30 to
0ebe56a
Compare
afprtclr
changed the title
afprtclr
force-pushed
the
feature/cloudevents-samples
branch
2 times, most recently
from
63be0a2 to
68f2071
Compare
hazel-bohon
approved these changes
Dec 17, 2025
afprtclr
force-pushed
the
feature/cloudevents-samples
branch
from
68f2071 to
e48e8db
Compare
hazel-bohon
approved these changes
Jan 8, 2026
|
|
||
| ### Envelope handling metrics | ||
|
|
||
| Various metrics track performance of the envelope handling when interoperating with external systems. The generic metrics include: |
Member
There was a problem hiding this comment.
Suggested change
| Various metrics track performance of the envelope handling when interoperating with external systems. The generic metrics include: | |
| Various metrics track envelope-handling performance when receiving messages that require envelope unwrapping, such as CloudEvents. The generic metrics include: |
|
|
||
| Various metrics track performance of the envelope handling when interoperating with external systems. The generic metrics include: | ||
|
|
||
| - Envelope unwrapping errors - how many times a single envelope handler failed to unwrap the incoming message |
Member
There was a problem hiding this comment.
Suggested change
| - Envelope unwrapping errors - how many times a single envelope handler failed to unwrap the incoming message | |
| - Envelope unwrapping attempts - how many times a single envelope handler attempted to unwrap an incoming message. The metric also reports whether the operation was successful or not, the envelope handler type, and the exception in case of failure |
Member
There was a problem hiding this comment.
Shall we specify here the metric name: nservicebus.envelope.unwrapped?
Member
There was a problem hiding this comment.
TODO: We're not sure, yet, if this goes into 10 or 10.1
Member
There was a problem hiding this comment.
TODO: We're not sure, yet, if this goes into 10 or 10.1
Member
There was a problem hiding this comment.
Food for thought: Do we need a top-level Envelopes concept instead of having this in the transports folder?
|
|
||
| ### Binary Content Mode for HTTP and AMQP | ||
|
|
||
| NServiceBus supports [HTTP Binary Content Mode](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md#31-binary-content-mode) and [AMQP Binary Content Mode](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/amqp-protocol-binding.md#31-binary-content-mode). |
Member
There was a problem hiding this comment.
Suggested change
| NServiceBus supports [HTTP Binary Content Mode](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md#31-binary-content-mode) and [AMQP Binary Content Mode](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/amqp-protocol-binding.md#31-binary-content-mode). | |
| NServiceBus supports the [HTTP Binary](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md#31-binary-content-mode) and [AMQP Binary](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/amqp-protocol-binding.md#31-binary-content-mode) content modes. |
|
|
||
| NServiceBus supports [HTTP Binary Content Mode](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md#31-binary-content-mode) and [AMQP Binary Content Mode](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/amqp-protocol-binding.md#31-binary-content-mode). | ||
|
|
||
| To recognize the CloudEvents message, fields [`id`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id), [`source`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1), and [`type`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) must be present. The [`specversion`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) is not required to be present or to equal to `1.0`. The field names must be encoded according to the binding specification (e.g., `ce-id` for the `id` field when using HTTP). The implementation will not attempt to deserialize the payload is the headers do not meet the requirements. |
Member
There was a problem hiding this comment.
Suggested change
| To recognize the CloudEvents message, fields [`id`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id), [`source`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1), and [`type`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) must be present. The [`specversion`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) is not required to be present or to equal to `1.0`. The field names must be encoded according to the binding specification (e.g., `ce-id` for the `id` field when using HTTP). The implementation will not attempt to deserialize the payload is the headers do not meet the requirements. | |
| To recognize the CloudEvents message, the fields [`id`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id), [`source`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1), and [`type`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) must be present. The [`specversion`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) field is not required to be present or to equal to `1.0`. | |
| Field names must be encoded according to the binding specification (e.g., `ce-id` for the `id` field when using HTTP). | |
| The implementation will not attempt to deserialize the payload if the headers do not meet the requirements. |
|
|
||
| This section describes the configuration options. | ||
|
|
||
| ### Enabling the configuration |
Member
There was a problem hiding this comment.
Suggested change
| ### Enabling the configuration | |
| ### Enabling CloudEvents |
|
|
||
| ### Type mapping | ||
|
|
||
| `TypeMappings` configure how to match the incoming messages with the class definitions: |
Member
There was a problem hiding this comment.
Suggested change
| `TypeMappings` configure how to match the incoming messages with the class definitions: | |
| `TypeMappings` configure how to match the incoming message content-type value with the class definition used in the NServiceBus message handler: |
|
|
||
| ### Enabled unwrappers | ||
|
|
||
| The `EnvelopeUnwrappers` property contains the list of enabled modes. By default, both Binary Content Mode and Structured Content Mode in Strict Mode are enabled. |
Member
There was a problem hiding this comment.
Something is off with the word "mode," I cannot pinpoint it, but the first sentence doesn't read well. Should we move away from mode to something like envelope format? In which case, that first sentence would be:
The
EnvelopeUnwrappersproperty lists the enabled envelope formats.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.