[4.6] Documents grpc compression

axoflow · Jan 25, 2024 · f7f54b7 · f7f54b7
1 parent 160f001
commit f7f54b7
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/content/chapter-destinations/destination-syslog-ng-otlp/_index.md b/content/chapter-destinations/destination-syslog-ng-otlp/_index.md
@@ -31,6 +31,8 @@ The `syslog-ng-otlp()` destination has the following options.
 
 {{% include-headless "chunk/option-destination-batch-timeout.md" %}}
 
+{{< include-headless "chunk/option-destination-grpc-compression.md" >}}
+
 {{< include-headless "chunk/option-destination-diskbuffer.md" >}}
 
 {{< include-headless "chunk/option-destination-hook.md" >}}

diff --git a/content/chapter-destinations/opentelemetry/_index.md b/content/chapter-destinations/opentelemetry/_index.md
@@ -62,6 +62,8 @@ log non_otel_to_otel_tls {
 
 {{< include-headless "chunk/option-destination-threaded-batching.md" >}}
 
+{{< include-headless "chunk/option-destination-grpc-compression.md" >}}
+
 {{< include-headless "chunk/option-destination-threaded-workers.md" >}}
 
 <!-- FIXME xinclude other common options

diff --git a/content/headless/chunk/option-destination-grpc-compression.md b/content/headless/chunk/option-destination-grpc-compression.md
@@ -0,0 +1,14 @@
+---
+---
+<!-- This file is under the copyright of Axoflow, and licensed under Apache License 2.0, except for using the Axoflow and AxoSyslog trademarks. -->
+
+## compression()
+
+|          |                            |
+| -------- | -------------------------- |
+| Type:    | boolean |
+| Default: | `no` |
+
+Available in {{% param "product_name" %}} version 4.5.0 and later.
+
+*Description:* Enables compression in gRPC requests. Although gRPC supports various compression methods, currently only deflate is supported (which is basically the same as gzip).