RepoMirrors
/
prometheus
mirror of https://github.com/prometheus/prometheus
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Correct statement in docs about query results returning either floats or histograms but not both. (#11880) 

* Correct statement in docs about query results returning either floats or histograms but not both.

* Move documentation for range and instant vectors under their corresponding headings.

Signed-off-by: Charles Korn <charles.korn@grafana.com>
This commit is contained in:
Charles Korn 2023-01-31 19:04:17 +11:00 committed by GitHub
parent 8e8b718365
commit e023d896f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/querying/api.md
View File

@ -449,9 +449,7 @@ raw numbers.
The keys `"histogram"` and `"histograms"` only show up if the experimental The keys `"histogram"` and `"histograms"` only show up if the experimental
native histograms are present in the response. Their placeholder `<histogram>` native histograms are present in the response. Their placeholder `<histogram>`
is explained in detail in its own section below. Any one object will only have is explained in detail in its own section below.
the `"value"`/`"values"` key or the `"histogram"`/`"histograms"` key, but not
both.
### Range vectors ### Range vectors
@ -469,6 +467,9 @@ Range vectors are returned as result type `matrix`. The corresponding
] ]
``` ```
Each series could have the `"values"` key, or the `"histograms"` key, or both.
For a given timestamp, there will only be one sample of either float or histogram type.
### Instant vectors ### Instant vectors
Instant vectors are returned as result type `vector`. The corresponding Instant vectors are returned as result type `vector`. The corresponding
@ -485,6 +486,8 @@ Instant vectors are returned as result type `vector`. The corresponding
] ]
``` ```
Each series could have the `"value"` key, or the `"histogram"` key, but not both.
### Scalars ### Scalars
Scalar results are returned as result type `scalar`. The corresponding Scalar results are returned as result type `scalar`. The corresponding