docs: clarify native histograms visualization and mark as experimental #9776
Conversation
Improve the documentation. Clarify the status of the feature. Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
to be squashed Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
docs/sources/mimir/configure/configure-native-histograms-ingestion.md
Outdated
Show resolved
Hide resolved
docs/sources/mimir/configure/configure-native-histograms-ingestion.md
Outdated
Show resolved
Hide resolved
| Prometheus native histograms is a data type in the Prometheus ecosystem that makes it possible to produce, store, and query a high-resolution [histogram](https://prometheus.io/docs/concepts/metric_types/#histogram) of observations. | ||
| Native histograms are experimental and subject to change. | ||
|
|
||
| Prometheus native histograms is a new data type beside the existing floating point time series in the Prometheus ecosystem that makes it possible to produce, store, and query a high-resolution [histogram](https://prometheus.io/docs/concepts/metric_types/#histogram) of observations. |
There was a problem hiding this comment.
| Prometheus native histograms is a new data type beside the existing floating point time series in the Prometheus ecosystem that makes it possible to produce, store, and query a high-resolution [histogram](https://prometheus.io/docs/concepts/metric_types/#histogram) of observations. | |
| Prometheus native histograms are a data type in the Prometheus ecosystem that allow you to produce, store, and query a high-resolution [histogram](https://prometheus.io/docs/concepts/metric_types/#histogram) of observations. |
There was a problem hiding this comment.
This bit, beside the existing floating point time series, is confusing and makes this sentence difficult to parse. If this information is necessary, can we have it in a separate sentence that follows, i.e.
Prometheus native histograms are a data type in the Prometheus ecosystem that allow you to produce, store, and query a high-resolution histogram of observations. This data type extends the functionality of existing floating point time series.
Or something that like to preserve the intended meaning.
`
There was a problem hiding this comment.
Also, we should remove the new to keep the docs current over time.
There was a problem hiding this comment.
This data type extends the functionality of existing floating point time series.
this reads weird to me, since the data structs are fundmentally different. one is not a subset of the other. the same way that a graph is not an extension of a tree.
There was a problem hiding this comment.
Okay, thank you for clarifying this. In this case, can we just remove the beside the existing floating point time series clause?
That would leave the following:
Prometheus native histograms are a data type in the Prometheus ecosystem that allow you to produce, store, and query a high-resolution histogram of observations.
Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
docs/sources/mimir/configure/configure-native-histograms-ingestion.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Taylor C <41653732+tacole02@users.noreply.github.com>
What this PR does
Improve the documentation.
Clarify the status of the feature.
Which issue(s) this PR fixes or relates to
N/A
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.