-
Notifications
You must be signed in to change notification settings - Fork 255
Add time series histogram to the TSDB docs. #4548
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
Changes from 6 commits
50d23b3
e190e09
4f0b197
cf06445
4608f4b
c443d6f
86b1bbc
1db5801
89a0020
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -69,18 +69,16 @@ You can also simplify dimension definitions by using [pass-through](elasticsearc | |
|
|
||
| Metrics are numeric measurements that change over time. Documents in a TSDS typically contain one or more metric fields. | ||
|
|
||
| To mark a field as a metric, use the `time_series_metric` mapping parameter. This parameter ensures data is stored in an optimal way for time series analysis. The following field types support the `time_series_metric` parameter: | ||
|
|
||
| * All [numeric field types](elasticsearch://reference/elasticsearch/mapping-reference/number.md) | ||
| * [`aggregate_metric_double`](elasticsearch://reference/elasticsearch/mapping-reference/aggregate-metric-double.md), for internal use during downsampling (rarely user-populated) | ||
|
|
||
| The valid values for `time_series_metric` are `counter` and `gauge`: | ||
| To mark a field as a metric, use the `time_series_metric` mapping parameter. This parameter ensures data is stored in an optimal way for time series analysis. The valid values for `time_series_metric` are `counter`, `gauge` and `histogram`: | ||
|
|
||
| `counter` | ||
| : A cumulative metric that only monotonically increases or resets to `0` (zero). For example, a count of errors or completed tasks that resets when a serving process restarts. | ||
| : A cumulative metric that only monotonically increases or resets to `0` (zero). For example, a count of errors or completed tasks that resets when a serving process restarts. A counter is supported by all [numeric field types](elasticsearch://reference/elasticsearch/mapping-reference/number.md) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The mapping accepts all numeric fields, I have tried scaled_float, float, byte, short. I haven't tested it end to end though, I mean index data, downsample, run ESQL queries. Do you think this is something we need to explore further? |
||
|
|
||
| `gauge` | ||
| : A metric that represents a single numeric that can arbitrarily increase or decrease. For example, a temperature or available disk space. | ||
| : A metric that represents a single numeric that can arbitrarily increase or decrease. For example, a temperature or available disk space. A gauge is supported by all [numeric field types](elasticsearch://reference/elasticsearch/mapping-reference/number.md) and [`aggregate_metric_double`](elasticsearch://reference/elasticsearch/mapping-reference/aggregate-metric-double.md) (for internal use during downsampling, rarely user-populated). | ||
|
|
||
| `histogram` {applies_to}`stack: preview 9.3` | ||
|
gmarouli marked this conversation as resolved.
Outdated
|
||
| : A metric that tracks the distribution of numerical values (like request times or sizes) by grouping them into "buckets" allowing you to monitor the shape of the data alongside the total count. A histogram is supported by [`histogram`](elasticsearch://reference/elasticsearch/mapping-reference/histogram.md) and [`exponential_histogram`](elasticsearch://reference/elasticsearch/mapping-reference/exponential-histogram.md). | ||
|
gmarouli marked this conversation as resolved.
Outdated
|
||
|
|
||
| #### `_tsid` metadata field [tsid] | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.