Skip to content

Commit 5821e57

Browse files
mattdurhamclayton-cornelltpaschalis
committed
Add quick detail on meta labels. (#4400)
* Add quick detail on meta labels. * Add more technical details * Fix extra * * Update docs/sources/flow/reference/components/prometheus.scrape.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/flow/reference/components/prometheus.scrape.md Co-authored-by: Paschalis Tsilias <[email protected]> --------- Co-authored-by: Clayton Cornell <[email protected]> Co-authored-by: Paschalis Tsilias <[email protected]>
1 parent 5c92faf commit 5821e57

File tree

6 files changed

+24
-6
lines changed

6 files changed

+24
-6
lines changed

docs/sources/flow/reference/components/loki.write.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,8 @@ loki.write "default" {
204204
}
205205
```
206206

207-
## Compression
207+
## Technical details
208208

209209
`loki.write` uses [snappy](https://en.wikipedia.org/wiki/Snappy_(compression)) for compression.
210+
211+
Any labels that start with `__` will be removed before sending to the endpoint.

docs/sources/flow/reference/components/otelcol.receiver.jaeger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,6 @@ otelcol.exporter.otlp "default" {
263263
}
264264
```
265265

266-
## Compression
266+
## Technical details
267267

268268
`otelcol.receiver.jaeger` supports [gzip](https://en.wikipedia.org/wiki/Gzip) for compression.

docs/sources/flow/reference/components/otelcol.receiver.otlp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,6 @@ otelcol.exporter.otlp "default" {
219219
}
220220
```
221221

222-
## Compression
222+
## Technical details
223223

224224
`otelcol.receiver.otlp` supports [gzip](https://en.wikipedia.org/wiki/Gzip) for compression.

docs/sources/flow/reference/components/prometheus.receive_http.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,6 @@ prometheus.remote_write "local" {
120120
}
121121
```
122122

123-
## Compression
123+
## Technical details
124124

125125
`prometheus.receive_http` uses [snappy](https://en.wikipedia.org/wiki/Snappy_(compression)) for compression.

docs/sources/flow/reference/components/prometheus.remote_write.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,9 @@ prometheus.remote_write "default" {
352352
}
353353
```
354354

355-
## Compression
355+
356+
## Technical details
356357

357358
`prometheus.remote_write` uses [snappy](https://en.wikipedia.org/wiki/Snappy_(compression)) for compression.
359+
360+
Any labels that start with `__` will be removed before sending to the endpoint.

docs/sources/flow/reference/components/prometheus.scrape.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,19 @@ http://blackbox-exporter:9115/probe?target=grafana.com&module=http_2xx
257257
http://blackbox-exporter:9116/probe?target=grafana.com&module=http_2xx
258258
```
259259

260-
## Compression
260+
### Technical details
261261

262262
`prometheus.scrape` supports [gzip](https://en.wikipedia.org/wiki/Gzip) compression.
263+
264+
The following special labels can change the behavior of prometheus.scrape:
265+
* `__address__` is the name of the label that holds the `<host>:<port>` address of a scrape target.
266+
* `__metrics_path__` is the name of the label that holds the path on which to scrape a target.
267+
* `__scheme__` is the name of the label that holds the scheme (http,https) on which to scrape a target.
268+
* `__scrape_interval__` is the name of the label that holds the scrape interval used to scrape a target.
269+
* `__scrape_timeout__` is the name of the label that holds the scrape timeout used to scrape a target.
270+
* `__param__` is a prefix for labels that provide URL parameters used to scrape a target.
271+
272+
Special labels added after a scrape
273+
* `__name__` is the label name indicating the metric name of a timeseries.
274+
* `job` is the label name indicating the job from which a timeseries was scraped.
275+
* `instance` is the label name used for the instance label.

0 commit comments

Comments
 (0)