Fixed heap (proto)

This extension has the qualified name envoy.resource_monitors.fixed_heap

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension does not operate on the data plane and hence is intended to be robust against untrusted traffic.

Tip

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

• envoy.resource_monitors

This extension must be configured with one of the following type URLs:

• type.googleapis.com/envoy.extensions.resource_monitors.fixed_heap.v3.FixedHeapConfig

extensions.resource_monitors.fixed_heap.v3.FixedHeapConfig

[extensions.resource_monitors.fixed_heap.v3.FixedHeapConfig proto]

The fixed heap resource monitor reports the Envoy process memory pressure, computed as a fraction of currently reserved heap memory divided by a statically configured maximum specified in the FixedHeapConfig.

{
  "max_heap_size_bytes": ...,
  "max_heap_size_bytes_runtime": {...}
}

max_heap_size_bytes

(uint64) Static value for max heap size in bytes set at startup. Exactly one of max_heap_size_bytes or max_heap_size_bytes_runtime must be set. If set, the expected value must be greater than 0, otherwise validation will fail.

max_heap_size_bytes_runtime

(config.core.v3.RuntimeUInt64) Runtime overlay for max heap size in bytes. When set, the value can be overridden at runtime during startup or later without restart. Exactly one of max_heap_size_bytes or max_heap_size_bytes_runtime must be set. If set, the expected value must be greater than 0, otherwise validation will fail.