Skip to content

Add sample rate field to the spec #76

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

Closed
maplebed wants to merge 4 commits into from
Closed

Add sample rate field to the spec #76

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d02ccf
Add sample rate field to the spec
maplebed Feb 8, 2018
b1eebf4
avoid using reserved keywords in a way that aren't rfc-ish
maplebed Feb 8, 2018
a8cf97d
rewording based on PR feedback, adding example
maplebed Feb 21, 2018
fe5bb11
Feedback on the PR
maplebed Mar 26, 2018
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
16 changes: 14 additions & 2 deletions spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,13 +202,25 @@ that contains both context and data).

### content-type
* Type: String per [RFC 2046](https://tools.ietf.org/html/rfc2046)
* Description: Describe the data encoding format
* Description: Describe the data encoding format
* Constraints:
* OPTIONAL
* If present, MUST adhere to the format specified in
[RFC 2046](https://tools.ietf.org/html/rfc2046)
* For Media Type examples see [IANA Media Types](http://www.iana.org/assignments/media-types/media-types.xhtml)

### sampled-rate
* Type: Positive Integer
* Description: The rate at which this event has already been sampled. Represents
the number of similar events that happened but were not sent plus this event.
* Constraints:
* OPTIONAL
* If present, MUST be a positive integer
* When absent, a default value of 1 MAY be assumed, indicating no sampling
* Examples:
* If a system sees 30 occurrences and emits a single event as a sample,
`sampled-rate` would be 30 (29 not sent and 1 sent).

### extensions
* Type: Map <String, Object>
* Description: This is for additional metadata and this does not have a
Expand All @@ -225,7 +237,7 @@ that contains both context and data).
### data
* Type: Arbitrary payload
* Description: The event payload. The payload depends on the event-type,
schema-url and event-type-version, the pyload is encoded into a media format
schema-url and event-type-version, the payload is encoded into a media format
which is specified by the content-type attribute (e.g. application/json).
* Constraints:
* OPTIONAL
Expand Down