This repository was archived by the owner on Aug 23, 2023. It is now read-only.
better documentation for our input formats #1071
Merged
Conversation
This file contains 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
woodsaj
reviewed
Oct 1, 2018
docs/inputs.md
Outdated
| 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. |
There was a problem hiding this comment.
s/has been preceded/have been preceded/
There was a problem hiding this comment.
The true requirement is just that an entry exists in the index for the id of the metricPoint.
woodsaj
reviewed
Oct 1, 2018
docs/inputs.md
Outdated
| 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. |
There was a problem hiding this comment.
Otherwise metrictank will not recognize the ID and the point will be discarded.
woodsaj
approved these changes
Oct 1, 2018
replay
reviewed
Oct 3, 2018
docs/inputs.md
Outdated
| 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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.