Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Traceparent Param for CloudEvent Signature to FF Contract #48

Merged
merged 2 commits into from
Mar 16, 2021
Merged

Add Traceparent Param for CloudEvent Signature to FF Contract #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2b1041
docs: add traceparent section
grant Mar 12, 2021
2b8e85d
docs: add link to w3c docs
grant Mar 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,12 @@ Your function have must use the following signature:

The developer's function must either explicitly or implicitly signal that it has completed performing useful work. The function may explicitly signal this condition by explicitly returning. The function may implicitly signal this condition by simply evaluating until it reaches the end of the function's code block.

#### Traceparent Header

In addition to the standard CloudEvent properties, the framework **may** add a `traceparent` property to the `cloudevent` object, following the [Distributed Tracing extension](https://github.com/cloudevents/spec/blob/master/extensions/distributed-tracing.md). This value for this property is retrieved from the HTTP header name: `traceparent`.

More about the `traceparent` header can be read in [W3C Trace Content docs](https://w3c.github.io/trace-context/).

### Legacy Events (Signature Type: `event`)

The Functions Framework **may** support signature type `events`. This signature supports non-CloudEvent style events. Your function have must use the following signature:
Expand Down