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.

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

log + document distributions being "do not use" #124

Merged
merged 4 commits into from
Apr 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,18 @@ The default histogram implementation uses a random sampling algorithm with expon
This was authored by Johan Buratti.


## Distribution [Experimental]
## Distribution [DO NOT USE]

**Distributions are no longer supported. The code to create them and the Heroic code to query them still exists, however they are being retired and no further adoption should occur.**

**Heroic is being retired in favor of OpenSource alternatives, and this distribution implementation will not be portable to the future TSDB/query interface. Since only a few services with a few metrics had experimented with distributions, the choice was made to halt adoption now, to reduce the pain of conversion to a proper histrogram later.**



*For historical refrence only*

**DO NOT USE**

Distribution is a simple interface that allows users to record measurements to compute rank statistics on data distribution, not just a local source.

Every implementation should produce a serialized data sketch in a byteBuffer as this metric point value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,7 @@ private void reportDistribution(final com.spotify.ffwd.v1.Metric metric,
ByteString byteString = distribution.getValueAndFlush();
Value value = Value.distributionValue(byteString);
send(metric.value(value));
log.warn("Using DEPRICATED 'distribution' metric_type, this is no longer supported");
}

private String getUnit(final Metric m) {
Expand Down