Zstd Compressor¶

This extension may be referenced by the qualified name envoy.compression.zstd.compressor

Note

This extension is intended to be robust against untrusted downstream traffic. It assumes that the upstream is trusted.

Tip

This extension extends and can be used with the following extension category:

extensions.compression.zstd.compressor.v3.Zstd¶

{
  "compression_level": "{...}",
  "enable_checksum": "...",
  "strategy": "...",
  "dictionary": "{...}",
  "chunk_size": "{...}"
}

compression_level: (UInt32Value) Set compression parameters according to pre-defined compression level table. Note that exact compression parameters are dynamically determined, depending on both compression level and source content size (when known). Value 0 means default, and default level is 3. Setting a level does not automatically set all other compression parameters to default. Setting this will however eventually dynamically impact the compression parameters which have not been manually set. The manually set ones will ‘stick’.

enable_checksum: (bool) A 32-bits checksum of content is written at end of frame. If not set, defaults to false.

strategy: (extensions.compression.zstd.compressor.v3.Zstd.Strategy) The higher the value of selected strategy, the more complex it is, resulting in stronger and slower compression. Special: value 0 means “use default strategy”.

dictionary: (config.core.v3.DataSource) A dictionary for compression. Zstd offers dictionary compression, which greatly improves efficiency on small files and messages. Each dictionary will be generated with a dictionary ID that can be used to search the same dictionary during decompression. Please refer to zstd manual to train a specific dictionary for compression.

chunk_size: (UInt32Value) Value for compressor’s next output buffer. If not set, defaults to 4096.