Skip to content
This repository was archived by the owner on Aug 23, 2023. It is now read-only.

better documentation for our input formats #1071

Merged
merged 4 commits into from
Oct 3, 2018
Merged

better documentation for our input formats #1071

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c4ba96
better documentation for our input formats
Dieterbe Sep 28, 2018
738bb13
typo. thanks scripts/qa/misspell.sh
Dieterbe Sep 29, 2018
fb07fa5
minor tweak
Dieterbe Oct 2, 2018
93518c0
typo
Dieterbe Oct 3, 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
5 changes: 3 additions & 2 deletions docs/inputs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ See the [MetricData](https://godoc.org/github.com/raintank/schema#MetricData) do
This format is a hand-written binary format that is much more compact and fast to encode/decode compared to MetricData.
See the [MetricPoint](https://godoc.org/github.com/raintank/schema#MetricPoint) documentation for format and implementation details.
It is a minimal format that only contains the series identifier, value and timestamp.
As such, it is paramount that MetricPoint messages for each series has been preceded by a MetricData message for that series.
Otherwise metrictank will not recognize the ID and will not be able handle it and discard the message.
As such, it is paramount that MetricPoint messages for each series have been preceded by a MetricData message for that series, so
that metrictank has had the change to add the metric information into its index.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change -> chance?

Otherwise metrictank will not recognize the ID and discard the point.

Note that the implementation has encode/decode function for the standard MetricPoint format, as well as a variant that does not encode the org-id
part of the series id. For single-tenant environments, you can configure your producers and metrictank to not encode an org-id in all messages
Expand Down