Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #538 from influxdata/flux/prometheus-histogram-quantile 

Flux prometheseus.histogramQuantile function
pull/568/head
Scott Anderson 2019-10-25 15:45:34 -06:00 committed by GitHub
parent b004e8378f f71f50b441
commit e5ad9cbffa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
content/v2.0/reference/flux/stdlib/experimental/prometheus/histogramquantile.md Normal file
View File

@ -0,0 +1,46 @@
---
title: prometheus.histogramQuantile() function
description: >
The `prometheus.histogramQuantile()` function calculates quantiles on a set of values
assuming the given histogram data is scraped or read from a Prometheus data source.
menu:
v2_0_ref:
name: prometheus.histogramQuantile
parent: Prometheus
weight: 301
---
The `prometheus.histogramQuantile()` function calculates quantiles on a set of values
assuming the given histogram data is scraped or read from a Prometheus data source.
_**Function type:** Aggregate_
{{% warn %}}
The `prometheus.histogramQuantile()` function is currently experimental and subject to change at any time.
By using this function, you accept the [risks of experimental functions](/v2.0/reference/flux/stdlib/experimental/#use-experimental-functions-at-your-own-risk).
{{% /warn %}}
```js
import "experimental/prometheus"
prometheus.histogramQuantile(
quantile: 0.99
)
```
## Parameters
### quantile
A value between 0.0 and 1.0 indicating the desired quantile.
_**Data type:** Float_
## Examples
### Calculate the 99th quantile in Prometheus data
```js
import "experimental/prometheus"
prometheus.scrape(url: "https://example-url.com/metrics")
|> prometheus.histogramQuantile(quantile: 0.99)
```