Skip to content

Commit e33277e

Browse files
committed
doc: update docs
- add a note to "how it works" section about supported compression algorithms
1 parent f0d07f3 commit e33277e

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

website/cue/reference/components/sinks/prometheus_remote_write.cue

+9
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,15 @@ components: sinks: prometheus_remote_write: {
100100
values for each name, Vector will only send the last value specified.
101101
"""
102102
}
103+
compression_schemes: {
104+
title: "Compression schemes"
105+
body: """
106+
Officially according to the [Prometheus Remote-Write specification](\(urls.prometheus_remote_write_spec)),
107+
the only supported compression scheme is [Snappy](\(urls.snappy)). However,
108+
there are a number of other implementations that do support other schemes. Thus
109+
Vector also supports using Gzip and Zstd.
110+
"""
111+
}
103112
}
104113

105114
telemetry: metrics: {

website/cue/reference/urls.cue

+1
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,7 @@ urls: {
412412
prometheus_remote_integrations: "https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage"
413413
prometheus_remote_write: "https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write"
414414
prometheus_remote_write_protocol: "https://docs.google.com/document/d/1LPhVRSFkGNSuU1fBd81ulhsCPR4hkSZyyBj1SZ8fWOM/edit#heading=h.n0d0vphea3fe"
415+
prometheus_remote_write_spec: "https://prometheus.io/docs/concepts/remote_write_spec/#protocol"
415416
protobuf: "https://developers.google.com/protocol-buffers"
416417
pulsar: "https://pulsar.apache.org/"
417418
pulsar_protocol: "https://pulsar.apache.org/docs/en/develop-binary-protocol/"

0 commit comments

Comments
 (0)