-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
47 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Prometheus | ||
|
||
The `prometheusremotewrite` data format converts metrics into the Prometheus protobuf | ||
exposition format. | ||
|
||
**Warning**: When generating histogram and summary types, output may | ||
not be correct if the metric spans multiple batches. This issue can be | ||
somewhat, but not fully, mitigated by using outputs that support writing in | ||
"batch format". When using histogram and summary types, it is recommended to | ||
use only the `prometheus_client` output. | ||
|
||
### Configuration | ||
|
||
```toml | ||
[[outputs.http]] | ||
url = "https://cortex/api/prom/push" | ||
data_format = "prometheusremotewrite" | ||
tls_ca = "/etc/telegraf/ca.pem" | ||
tls_cert = "/etc/telegraf/cert.pem" | ||
tls_key = "/etc/telegraf/key.pem" | ||
[outputs.http.headers] | ||
Content-Type = "application/x-protobuf" | ||
Content-Encoding = "snappy" | ||
X-Prometheus-Remote-Write-Version = "0.1.0" | ||
``` | ||
|
||
### Metrics | ||
|
||
A Prometheus metric is created for each integer, float, boolean or unsigned | ||
field. Boolean values are converted to *1.0* for true and *0.0* for false. | ||
|
||
The Prometheus metric names are produced by joining the measurement name with | ||
the field key. In the special case where the measurement name is `prometheus` | ||
it is not included in the final metric name. | ||
|
||
Prometheus labels are produced for each tag. | ||
|
||
**Note:** String fields are ignored and do not produce Prometheus metrics. |
2 changes: 1 addition & 1 deletion
2
...s_remote_write/prometheus_remote_write.go → ...theusremotewrite/prometheusremotewrite.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
package prometheus_remote_write | ||
package prometheusremotewrite | ||
|
||
import ( | ||
"bytes" | ||
|
2 changes: 1 addition & 1 deletion
2
...ote_write/prometheus_remote_write_test.go → ...remotewrite/prometheusremotewrite_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
package prometheus_remote_write | ||
package prometheusremotewrite | ||
|
||
import ( | ||
"bytes" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters