Document standard metadata entries. #61941
Conversation
We standardize on some metadata entries that we plan to later leverage in Kibana in order to provide a better out-of-the-box experience, e.g. different visualizations make sense on gauges and counters.
jpountz
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-search (:Search/Mapping) |
elasticmachine
added
Team:Docs
|
|
||
| The type of metric. Recognizes `"gauge"` and `"counter"`. By default, fields | ||
| are assumed to not be a metric. This information should only be specified on | ||
| numeric fields. |
There was a problem hiding this comment.
I'd like to explain what gauges and counters are in here. Something like:
The type of metric for time series data. Options are none, "gauge" and "counter".
A gauge is a number representing a point in time that can go up and down.
A counter is a number representing a cumulative amount and is always increasing. Counters can reset to 0 occasionally.
|
|
||
| ratio:: | ||
|
|
||
| Whether the field is a ratio. Recognizes `true` and `false` (default). The |
There was a problem hiding this comment.
| Whether the field is a ratio. Recognizes `true` and `false` (default). The | |
| Whether the field is a ratio or percent. Recognizes `true` and `false` (default). The |
There was a problem hiding this comment.
My understanding was that we always use ratios in the data we produce, never percentages (ie. ratio * 100), is this assumption wrong? If we have both, do we need to be able to make the distinction via this metadata so that Kibana would know?
There was a problem hiding this comment.
@roncohen @ruflin and I had a small discussion about this yesterday. We see how this can be confusing for users, so we agreed this could be the best approach:
Having only percent stored as a unit (no need for a ratio flag in meta), where the value is expected to be in the [0-1] notation. This is how Metricbeat stores percentages today.
WDYT?
Co-authored-by: debadair <debadair@elastic.co>
|
Thanks @debadair for the help! |
We standardize on some metadata entries that we plan to later leverage in Kibana in order to provide a better out-of-the-box experience, e.g. different visualizations make sense on gauges and counters.
We standardized on some metadata entries that we plan to later leverage
in Kibana in order to provide a better out-of-the-box experience, e.g.
different visualizations make sense on gauges and counters.