Update prometheus input documentation
This commit is contained in:
parent
5eff12a840
commit
bf3fdbd841
|
@ -1,77 +1,47 @@
|
||||||
# Prometheus Input Plugin
|
# Prometheus Input Plugin
|
||||||
|
|
||||||
The prometheus input plugin gathers metrics from any webpage
|
The prometheus input plugin gathers metrics from HTTP servers exposing metrics
|
||||||
exposing metrics with Prometheus format
|
in Prometheus format.
|
||||||
|
|
||||||
### Configuration:
|
### Configuration:
|
||||||
|
|
||||||
Example for Kubernetes API server
|
|
||||||
```toml
|
```toml
|
||||||
# Get all metrics from Kubernetes API server
|
# Read metrics from one or many prometheus clients
|
||||||
[[inputs.prometheus]]
|
[[inputs.prometheus]]
|
||||||
# An array of urls to scrape metrics from.
|
## An array of urls to scrape metrics from.
|
||||||
urls = ["http://my-kube-apiserver:8080/metrics"]
|
urls = ["http://localhost:9100/metrics"]
|
||||||
|
|
||||||
|
## An array of Kubernetes services to scrape metrics from.
|
||||||
|
# kubernetes_services = ["http://my-service-dns.my-namespace:9100/metrics"]
|
||||||
|
|
||||||
|
## Use bearer token for authorization
|
||||||
|
# bearer_token = /path/to/bearer/token
|
||||||
|
|
||||||
|
## Specify timeout duration for slower prometheus clients (default is 3s)
|
||||||
|
# response_timeout = "3s"
|
||||||
|
|
||||||
|
## Optional SSL Config
|
||||||
|
# ssl_ca = /path/to/cafile
|
||||||
|
# ssl_cert = /path/to/certfile
|
||||||
|
# ssl_key = /path/to/keyfile
|
||||||
|
## Use SSL but skip chain & host verification
|
||||||
|
# insecure_skip_verify = false
|
||||||
```
|
```
|
||||||
|
|
||||||
Specify a 10 second timeout for slower/over-loaded clients
|
#### Kubernetes Service Discovery
|
||||||
```toml
|
|
||||||
# Get all metrics from Kubernetes API server
|
|
||||||
[[inputs.prometheus]]
|
|
||||||
# An array of urls to scrape metrics from.
|
|
||||||
urls = ["http://my-kube-apiserver:8080/metrics"]
|
|
||||||
|
|
||||||
# Specify timeout duration for slower prometheus clients (default is 3s)
|
URLs listed in the `kubernetes_services` parameter will be expanded
|
||||||
response_timeout = "10s"
|
by looking up all A records assigned to the hostname as described in
|
||||||
```
|
[Kubernetes DNS service discovery](https://kubernetes.io/docs/concepts/services-networking/service/#dns).
|
||||||
|
|
||||||
You can use more complex configuration
|
This method can be used to locate all
|
||||||
to filter and some tags
|
[Kubernetes headless services](https://kubernetes.io/docs/concepts/services-networking/service/#headless-services).
|
||||||
|
|
||||||
```toml
|
#### Bearer Token
|
||||||
# Get all metrics from Kubernetes API server
|
|
||||||
[[inputs.prometheus]]
|
|
||||||
# An array of urls to scrape metrics from.
|
|
||||||
urls = ["http://my-kube-apiserver:8080/metrics"]
|
|
||||||
# Get only metrics with "apiserver_" string is in metric name
|
|
||||||
namepass = ["apiserver_*"]
|
|
||||||
# Add a metric name prefix
|
|
||||||
name_prefix = "k8s_"
|
|
||||||
# Add tags to be able to make beautiful dashboards
|
|
||||||
[inputs.prometheus.tags]
|
|
||||||
kubeservice = "kube-apiserver"
|
|
||||||
```
|
|
||||||
|
|
||||||
```toml
|
If set, the file specified by the `bearer_token` parameter will be read on
|
||||||
# Authorize with a bearer token skipping cert verification
|
each interval and its contents will be appended to the Bearer string in the
|
||||||
[[inputs.prometheus]]
|
Authorization header.
|
||||||
# An array of urls to scrape metrics from.
|
|
||||||
urls = ["http://my-kube-apiserver:8080/metrics"]
|
|
||||||
bearer_token = '/path/to/bearer/token'
|
|
||||||
insecure_skip_verify = true
|
|
||||||
```
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# Authorize using x509 certs
|
|
||||||
[[inputs.prometheus]]
|
|
||||||
# An array of urls to scrape metrics from.
|
|
||||||
urls = ["https://my-kube-apiserver:8080/metrics"]
|
|
||||||
|
|
||||||
ssl_ca = '/path/to/cafile'
|
|
||||||
ssl_cert = '/path/to/certfile'
|
|
||||||
ssl_key = '/path/to/keyfile'
|
|
||||||
```
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# Use with [Kubernetes headless services](https://kubernetes.io/docs/concepts/services-networking/service/#headless-services)
|
|
||||||
[[inputs.prometheus]]
|
|
||||||
# An array of urls to scrape metrics from.
|
|
||||||
urls = ["https://my-kube-apiserver:8080/metrics"]
|
|
||||||
|
|
||||||
# An array of Kubernetes services to scrape metrics from.
|
|
||||||
# The IP addresses of all pods behind these services will be resolved and
|
|
||||||
# then scraped
|
|
||||||
kubernetes_services = ["https://my-headless-service.my-namespace:8080/metrics"]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Usage for Caddy HTTP server
|
### Usage for Caddy HTTP server
|
||||||
|
|
||||||
|
@ -91,46 +61,45 @@ If you want to monitor Caddy, you need to use Caddy with its Prometheus plugin:
|
||||||
> This is the default URL where Caddy Prometheus plugin will send data.
|
> This is the default URL where Caddy Prometheus plugin will send data.
|
||||||
> For more details, please read the [Caddy Prometheus documentation](https://github.com/miekg/caddy-prometheus/blob/master/README.md).
|
> For more details, please read the [Caddy Prometheus documentation](https://github.com/miekg/caddy-prometheus/blob/master/README.md).
|
||||||
|
|
||||||
### Measurements & Fields & Tags:
|
### Metrics:
|
||||||
|
|
||||||
Measurements and fields could be any thing.
|
Measurement names are based on the Metric Family and tags are created for each
|
||||||
It just depends of what you're quering.
|
label. The value is added to a field named based on the metric type.
|
||||||
|
|
||||||
Example:
|
All metrics receive the `url` tag indicating the related URL specified in the
|
||||||
|
Telegraf configuration. If using Kubernetes service discovery the `address`
|
||||||
```
|
tag is also added indicating the discovered ip address.
|
||||||
# HELP go_gc_duration_seconds A summary of the GC invocation durations.
|
|
||||||
# TYPE go_gc_duration_seconds summary
|
|
||||||
go_gc_duration_seconds{quantile="0"} 0.00010425500000000001
|
|
||||||
go_gc_duration_seconds{quantile="0.25"} 0.000139108
|
|
||||||
go_gc_duration_seconds{quantile="0.5"} 0.00015749400000000002
|
|
||||||
go_gc_duration_seconds{quantile="0.75"} 0.000331463
|
|
||||||
go_gc_duration_seconds{quantile="1"} 0.000667154
|
|
||||||
go_gc_duration_seconds_sum 0.0018183950000000002
|
|
||||||
go_gc_duration_seconds_count 7
|
|
||||||
# HELP go_goroutines Number of goroutines that currently exist.
|
|
||||||
# TYPE go_goroutines gauge
|
|
||||||
go_goroutines 15
|
|
||||||
```
|
|
||||||
|
|
||||||
- go_goroutines,
|
|
||||||
- gauge (integer, unit)
|
|
||||||
- go_gc_duration_seconds
|
|
||||||
- field3 (integer, bytes)
|
|
||||||
|
|
||||||
- All measurements have the following tags:
|
|
||||||
- url=http://my-kube-apiserver:8080/metrics
|
|
||||||
- go_goroutines has the following tags:
|
|
||||||
- kubeservice=kube-apiserver
|
|
||||||
- go_gc_duration_seconds has the following tags:
|
|
||||||
- kubeservice=kube-apiserver
|
|
||||||
|
|
||||||
### Example Output:
|
### Example Output:
|
||||||
|
|
||||||
Example of output with configuration given above:
|
**Source**
|
||||||
|
```
|
||||||
|
# HELP go_gc_duration_seconds A summary of the GC invocation durations.
|
||||||
|
# TYPE go_gc_duration_seconds summary
|
||||||
|
go_gc_duration_seconds{quantile="0"} 7.4545e-05
|
||||||
|
go_gc_duration_seconds{quantile="0.25"} 7.6999e-05
|
||||||
|
go_gc_duration_seconds{quantile="0.5"} 0.000277935
|
||||||
|
go_gc_duration_seconds{quantile="0.75"} 0.000706591
|
||||||
|
go_gc_duration_seconds{quantile="1"} 0.000706591
|
||||||
|
go_gc_duration_seconds_sum 0.00113607
|
||||||
|
go_gc_duration_seconds_count 4
|
||||||
|
# HELP go_goroutines Number of goroutines that currently exist.
|
||||||
|
# TYPE go_goroutines gauge
|
||||||
|
go_goroutines 15
|
||||||
|
# HELP cpu_usage_user Telegraf collected metric
|
||||||
|
# TYPE cpu_usage_user gauge
|
||||||
|
cpu_usage_user{cpu="cpu0"} 1.4112903225816156
|
||||||
|
cpu_usage_user{cpu="cpu1"} 0.702106318955865
|
||||||
|
cpu_usage_user{cpu="cpu2"} 2.0161290322588776
|
||||||
|
cpu_usage_user{cpu="cpu3"} 1.5045135406226022
|
||||||
|
```
|
||||||
|
|
||||||
|
**Output**
|
||||||
```
|
```
|
||||||
$ ./telegraf --config telegraf.conf --test
|
go_gc_duration_seconds,url=http://example.org:9273/metrics 1=0.001336611,count=14,sum=0.004527551,0=0.000057965,0.25=0.000083812,0.5=0.000286537,0.75=0.000365303 1505776733000000000
|
||||||
k8s_go_goroutines,kubeservice=kube-apiserver,url=http://my-kube-apiserver:8080/metrics gauge=536 1456857329391929813
|
go_goroutines,url=http://example.org:9273/metrics gauge=21 1505776695000000000
|
||||||
k8s_go_gc_duration_seconds,kubeservice=kube-apiserver,url=http://my-kube-apiserver:8080/metrics 0=0.038002142,0.25=0.041732467,0.5=0.04336492,0.75=0.047271799,1=0.058295811,count=0,sum=208.334617406 1456857329391929813
|
cpu_usage_user,cpu=cpu0,url=http://example.org:9273/metrics gauge=1.513622603430151 1505776751000000000
|
||||||
|
cpu_usage_user,cpu=cpu1,url=http://example.org:9273/metrics gauge=5.829145728641773 1505776751000000000
|
||||||
|
cpu_usage_user,cpu=cpu2,url=http://example.org:9273/metrics gauge=2.119071644805144 1505776751000000000
|
||||||
|
cpu_usage_user,cpu=cpu3,url=http://example.org:9273/metrics gauge=1.5228426395944945 1505776751000000000
|
||||||
```
|
```
|
||||||
|
|
|
@ -69,7 +69,7 @@ func Parse(buf []byte, header http.Header) ([]telegraf.Metric, error) {
|
||||||
fields["count"] = float64(m.GetSummary().GetSampleCount())
|
fields["count"] = float64(m.GetSummary().GetSampleCount())
|
||||||
fields["sum"] = float64(m.GetSummary().GetSampleSum())
|
fields["sum"] = float64(m.GetSummary().GetSampleSum())
|
||||||
} else if mf.GetType() == dto.MetricType_HISTOGRAM {
|
} else if mf.GetType() == dto.MetricType_HISTOGRAM {
|
||||||
// historgram metric
|
// histogram metric
|
||||||
fields = makeBuckets(m)
|
fields = makeBuckets(m)
|
||||||
fields["count"] = float64(m.GetHistogram().GetSampleCount())
|
fields["count"] = float64(m.GetHistogram().GetSampleCount())
|
||||||
fields["sum"] = float64(m.GetHistogram().GetSampleSum())
|
fields["sum"] = float64(m.GetHistogram().GetSampleSum())
|
||||||
|
|
|
@ -47,7 +47,7 @@ var sampleConfig = `
|
||||||
urls = ["http://localhost:9100/metrics"]
|
urls = ["http://localhost:9100/metrics"]
|
||||||
|
|
||||||
## An array of Kubernetes services to scrape metrics from.
|
## An array of Kubernetes services to scrape metrics from.
|
||||||
kubernetes_services = ["http://my-service-dns.my-namespace:9100/metrics"]
|
# kubernetes_services = ["http://my-service-dns.my-namespace:9100/metrics"]
|
||||||
|
|
||||||
## Use bearer token for authorization
|
## Use bearer token for authorization
|
||||||
# bearer_token = /path/to/bearer/token
|
# bearer_token = /path/to/bearer/token
|
||||||
|
|
Loading…
Reference in New Issue