1.30.0 (April 16, 2024)

Incompatible behavior changes

Changes that are expected to cause an incompatibility if applicable; deployment changes are likely required

  • http: Remove the hop by hop TE header from downstream request headers if it’s not set to trailers, else keep it. This change can be temporarily reverted by setting envoy.reloadable_features.sanitize_te to false.

  • http2: Changes the default value of envoy.reloadable_features.http2_use_oghttp2 to false. This changes the codec used for HTTP/2 requests and responses. A number of users have reported issues with Oghttp2 including issue #32611 and issue #32401. This behavior can be reverted by setting the feature to true.

  • stats: The runtime flag envoy.reloadable_features.enable_include_histograms is now enabled by default. This causes the includeHistogram() method on Stats::SinkPredicates to filter histograms to be flushed to stat sinks.

Minor behavior changes

Changes that may cause incompatibilities for some users, but should not for most

  • adaptive-concurrency/stats: Multiply the gradient value stat by 1000 to make it more granular (values will range between 500 and 2000).

  • aws: AWS region string is now retrieved from environment and profile consistently within aws_request_signer and grpc_credentials/aws_iam extensions. Region field in aws_request_signer is now optional, explicitly configured xDS region will take preference. aws_request_signer documentation now reflects the region chain.

  • config-parsing/http-cache: envoy.restart_features.use_fast_protobuf_hash was flipped to true by default. The expectation is that this will improve performance of the hash operation by 2x to 10x, and reduce config update time by 10-25%. This change will also cause a one-time cache flush for file_system_http_cache.

  • dns: Allowing dns_min_refresh_rate to go as low as 1s.

  • dns: Fixing a bug in the getaddrinfo resolver where it did not reresolve on EAI_AGAIN. This behavioral change can be temporarily reverted by setting envoy.reloadable_features.dns_reresolve_on_eai_again to false.

  • golang: Change RegisterHttpFilterConfigFactoryAndParser to RegisterHttpFilterFactoryAndConfigParser.

  • golang: Not implicitly clearing route cache in HeaderMap.Set, introduce a new API ClearRouteCache to do it.

  • http: Enable obsolete line folding in BalsaParser (for behavior parity with http-parser, the previously used HTTP/1 parser).

  • http: When the HTTP CONNECT request method is enabled using RouteAction.UpgradeConfig, CONNECT requests will now be proxied to the upstream, unless the connect_config field is also set. (Previously Envoy would terminate CONNECT requests even when the connect_config field was unset.) The updated behavior should now be consistent with the existing documentation. This change can be reverted by setting envoy.reloadable_features.http_route_connect_proxy_by_default to false.

  • http2: Simplifies integration with the codec by removing translation between nghttp2 callbacks and Http2VisitorInterface events. Guarded by envoy.reloadable_features.http2_skip_callback_visitor.

  • http3: Disables recvmmsg (multi-message) for reading packets from a client QUIC UDP socket, if GRO is not set or not supported. recvmsg will be used instead. This behavior change can be reverted by setting envoy.reloadable_features.disallow_quic_client_udp_mmsg to false.

  • http3: Make GRO (Generic Receive Offload) for reading packets from a client QUIC UDP socket configurable. See https://www.kernel.org/doc/html/next/networking/segmentation-offloads.html for a description of GRO. This behavior change can be enabled by setting envoy.reloadable_features.prefer_quic_client_udp_gro to true.

  • lua: Previously, tracing spans generated by httpCall were always sampled by default. Now, the default sampling decision of an httpCall span is inherited from the parent span, so that no “orphaned” sampled span associated with the httpCall is emitted. The default remains overridable with the trace_sampled option.

  • proxy_status: Add more conversion in the proxy status utility. It can be disabled by the runtime guard envoy.reloadable_features.proxy_status_mapping_more_core_response_flags.

  • quic: Server preferred address is now sent to non-QUICHE QUIC clients when configured. This behavior can be disabled with runtime flag envoy.reloadable_features.quic_send_server_preferred_address_to_all_clients.

  • quic: Make each upstream connection to read as many as 32 packets in each event loop. This feature can be disabled by setting envoy.reloadable_features.quic_upstream_reads_fixed_number_packets to false.

  • quic: Port migration is default turned off. QUIC client connections will no longer attempt to migrate to a new port when connections is degrading. Can be manually turned on via port_migration.

  • sockets: Failure to create an upstream socket should now result in clean connection failure rather than failing a release assert. This behavior can be temporarily reverted by setting runtime feature envoy.restart_features_.allow_client_socket_creation_failure to false.

  • stats: thread_local_cluster_manager.worker_0.* metrics are now parsed to use the worker_id tag like other metrics with worker_id do, when use_all_default_tags is true.

  • upstream: Upstream now excludes hosts set to DRAINING state via EDS from load balancing and panic routing threshold calculation. This feature can be disabled by setting envoy.reloadable_features.exclude_host_in_eds_status_draining to false.

  • xds: Delta SDS removals will no longer result in a “Missing SDS resources” NACK and instead will be ignored.

Bug fixes

Changes expected to improve the state of the world and are unlikely to have negative effects

  • admin: Fixed a bug where the config_dump and init_dump admin endpoint would return an empty response when called with empty query parameters (e.g. /config_dump?resource=&mask=&name_regex=).

  • admin: Removing the ECDS config entry from the config dump when it does not exist (or has expired).

  • deps: Updated QUICHE dependencies to incorporate fixes for #32401.

  • eds-caching: Fixing an issue where EDS caching is used (protected by the envoy.restart_features.use_eds_cache_for_ads runtime flag that is false by default), when multiple clusters use the same EDS resource, and that cached EDS resource is used.

  • geoip: Switch to use StopAllIterationAndWatermark instead of StopIteration in GeoIP filter to fix an issue where large POST request body may get corrupted when GeoIP is enabled.

  • http: Fixed crash when HTTP request idle and per try timeouts occurs within backoff interval.

  • http2: Update nghttp2 to resolve CVE-2024-30255.

  • http3/upstream: Fixing a bug with HTTP/3 upstream using a non-threadsafe cache cross-thread. Bumping HTTP/3 support down to alpha as the severity of this bug indicates it is both not in use and not GA quality code.

  • jwt_authn: Added max_lifetime and require_expiration to limit the maximum remaining lifetime of a token from a JwtProvider and implement restrictions for JWT-SVIDs.

  • jwt_authn: Fixed JWT extractor, which concatenated headers with a comma, resultig in invalid tokens.

  • load_balancing: Added randomization in host load-balancing initialization. This helps desynchronizing Envoys across a fleet by randomizing the scheduler starting point. This can be temporarily reverted by setting runtime guard envoy.reloadable_features.edf_lb_host_scheduler_init_fix to false.

  • load_balancing: Added randomization in locality load-balancing initialization. This helps desynchronizing Envoys across a fleet by randomizing the scheduler starting point. This can be temporarily reverted by setting runtime guard envoy.reloadable_features.edf_lb_locality_scheduler_init_fix to false.

  • oauth: The refresh and access tokens are not expired simultaneously so the access token can be updated using the refresh token. The expiration time of the refresh token is taken from the exp claim of jwt by default. If the claim is ommited in the jwt then default_refresh_token_expires_in specifies the lifetime of the refresh token. The default value is 604800 seconds (a week).

  • oauth: When performing a token refresh and forwarding tokens upstream, replace existing token cookies rather than appending as another Cookie header.

  • prefix_matcher_tree: Fixed issue in matcher prefix tree lookup. The lookup did not function correctly when the prefix tree had overlapping prefixes. For example: with prefixes /foo and /foo/bar, it would have incorrectly said no prefix match for /foo/.

  • proxy_protocol: Fix crash due to uncaught exception when the operating system does not support an address type (such as IPv6) that is received in a proxy protocol header. Connections will instead be dropped/reset.

  • proxy_protocol: Fixed a bug where TLVs with non-utf8 characters were inserted as protobuf values into filter metadata circumventing ext_authz checks when failure_mode_allow is set to true.

  • proxy_protocol: Fixed a crash when Envoy is configured for PROXY protocol on both a listener and cluster, and the listener receives a PROXY protocol header with address type LOCAL (typically used for health checks).

  • quic: Added support for QUIC listeners to echo incoming ECN marks to the peer. Currently disabled. When changes are complete and this is enabled, it can be disabled by setting runtime flag envoy.reloadable_features.quic_receive_ecn to false.

  • quic: Fixed crash bug with QUIC upstream + X.509v1 certificates.

  • router: Fix a timing issue when upstream requests are empty when decoding data and send local reply when that happens. This is controlled by envoy_reloadable_features_send_local_reply_when_no_buffer_and_upstream_request.

  • stateful_session: Support 0 TTL for proto-encoded cookies, which disables cookie expiration by Envoy.

  • tcp/udp/tunneling: fixed a bug where second HTTP response headers received would cause Envoy to crash in cases where propagate_response_headers and retry configurations are enabled at the same time, and an upstream request is retried multiple times.

  • tcp_proxy: When tunneling TCP over HTTP, closed the downstream connection (for writing only) when upstream trailers are read to support half close semantics during TCP tunneling. This behavioral change can be temporarily reverted by setting runtime guard envoy.reloadable_features.tcp_tunneling_send_downstream_fin_on_upstream_trailers to false.

  • tls: Fix crash due to uncaught exception when the operating system does not support an address type (such as IPv6) that is received in an mTLS client cert IP SAN. These SANs will be ignored. This applies only when using formatter %DOWNSTREAM_PEER_IP_SAN%.

  • tracers: use unary RPC calls for OpenTelemetry trace exports, rather than client-side streaming connections.

  • tracing: Dynatrace resource detector: Only log warning message when no enrichment attributes are found.

  • tracing: Prevent Envoy from crashing at start up when the OpenTelemetry environment resource detector cannot detect any attributes.

  • url matching: Fixed excessive CPU utilization when using regex URL template matcher.

  • xds: Reject xDS configurations where the rate-limit’s fill_rate is set to Infinity or NaN.

Removed config or runtime

Normally occurs at the end of the deprecation period

  • active_health_check: Removed envoy.reloadable_features.keep_endpoint_active_hc_status_on_locality_update runtime flag and legacy code paths.

  • aws: Removed envoy.reloadable_features.enable_aws_credentials_file runtime flag and legacy code paths.

  • http: Removed envoy.reloadable_features.allow_absolute_url_with_mixed_scheme runtime flag and legacy code paths.

  • http: Removed envoy_reloadable_features_append_xfh_idempotent runtime flag and legacy code paths.

  • http1: Removed envoy.reloadable_features.http1_allow_codec_error_response_after_1xx_headers runtime flag and legacy code paths.

  • overload_manager: removed envoy.reloadable_features.overload_manager_error_unknown_action and legacy code paths.

  • resource_monitors: removed envoy.reloadable_features.count_unused_mapped_pages_as_free runtime flag and legacy code paths.

  • upstream: removed envoy_reloadable_features_initialize_upstream_filters and legacy code paths.

New features

  • access_log: Added %COMMON_DURATION% to access log format to log the duration of the request. The start time point, end time point and duration precision can be configured in this new command.

  • access_log: added support for %UPSTREAM_CONNECTION_ID% for the upstream connection identifier.

  • access_loggers: Added Fluentd access logger to support flushing access logs in Fluentd format.

  • access_loggers: Added retry options to Fluentd Access Logger to support upstream reconnect options, backoff intervals.

  • admin: The /stats/prometheus endpoint can now emit Prometheus summary metric types by explicitly setting the histogram_buckets query parameter to summary.

  • aws: Update credential_provider utility to support EKS Pod Identity provided via token file.

  • aws_lambda: Added host_rewrite config to be used during signature.

  • aws_lambda: The aws_lambda filter now supports the credentials_profile parameter. This enables choosing different credential profiles for each filter instance.

  • aws_lambda: Update aws_lambda filter to support use as an upstream HTTP filter. This allows successful calculation of signatures after the forwarding stage has completed, particularly if the path element is modified.

  • aws_request_signing: Update aws_request_signing filter to support optionally sending the aws signature in query parameters rather than headers, by specifying the query_string configuration section.

  • aws_request_signing: Update aws_request_signing filter to support use as an upstream HTTP filter. This allows successful calculation of signatures after the forwarding stage has completed, particularly if the path element is modified.

  • basic_auth: Added forward_username_header config to forward the username to the backend.

  • composite: Convert composite fiter into dual filter so it can be installed in the upstream filter chain.

  • compression: Added Qatzstd compressor.

  • cors: Added configuration option to return local response when CORS preflight’s origin does not match allowed origin.

  • ext_authz: Added support for populating the tls_session check request attribute for network ext_authz by setting include_tls_session to true.

  • ext_authz: The proto field headers’s value type is string. Thus, it is unable to support non-utf8 characters in header values. To support header values with non-utf8 characters, a new boolean field was added to the ext_authz config encode_raw_headers. When this is set to true, the new field in HttpRequest.header_map (specifically header_map.headers.raw_value) gets populated with the raw values instead of headers, which normally contains UTF-8 sanitized header values. Also, since the new field is not a map, headers with the same key are not combined into a single comma-seperated header.

  • ext_proc: Added grpc_initial_metadata config API to allow extending inherited metadata from ExternalProcessor.grpc_service and ExtProcOverrides.grpc_service with the new or updated values.

  • ext_proc: added metadata_options config API to enable sending and receiving metadata from/to the external processing server. Both typed and untyped dynamic metadata may be sent to the server. If receiving_namespaces is defined, returned metadata may be written to the specified allowed namespaces.

  • ext_proc: implemented request_attributes and response_attributes config APIs to enable sending and receiving attributes to/from the external processing server.

  • ext_proc: made the ExternalProcessor work as an upstream filter.

  • filters: Added per-route configuration support to the Basic Auth filter.

  • filters: Added the credential injector filter, which can be used to inject credentials into the HTTP headers.

  • formatters: Added formatters to Fluentd access logger to allow adding extension commands when formatter access logs.

  • grpc: Added maximum gRPC message size that is allowed to be received in Envoy gRPC. If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error. This limit is applied to individual messages in the streaming response and not the total size of streaming response. Defaults to 0, which means unlimited.

  • grpc reverse bridge: Change HTTP status to 200 to respect the gRPC protocol. This may cause problems for incorrect gRPC clients expecting the filter to preserve HTTP 1.1 responses. This behavioral change can be temporarily reverted by setting runtime guard envoy.reloadable_features.grpc_http1_reverse_bridge_change_http_status to false.

  • health_checks: added a configuration option that enables health check logs on each successful health check.

  • hot_restart: Added new command-line flag --skip-hot-restart-on-no-parent.

  • http: Added DownstreamRemoteReset to CoreResponseFlag, and it is set when stream is remote reset.

  • http3: Added experimental support for sending and receiving HTTP/3 METADATA frames.

  • jwt_authn: Added subjects to allow restrictions of subjects a JwtProvider can assert.

  • load shed point: Added load shed point envoy.load_shed_points.http_downstream_filter_check that makes load shed check availabe in HTTP decoder filters, and right now it is only available in router. It will send local reply directly when Envoy is under pressure, typically memory.

  • load_shed_point: Added load shed point envoy.load_shed_points.hcm_ondata_creating_codec that closes connections before creating codec if Envoy is under pressure, typically memory.

  • lua: Added a new connectionStreamInfo() which could be used to access the streamInfo object on the connection. This addition is helpful in scenarios requiring the retrieval of dynamic metadata from network filters, such as the Proxy Protocol, etc.

  • match_delegate: Convert match_delegate fiter into dual filter so it can be installed in the upstream filter chain.

  • monitoring: Add Envoy::ExecutionContext, which is notified by ScopeTrackerScopeState’s constructor and destructor. This feature is disabled by default, it can be enabled by runtime feature flag envoy.restart_features.enable_execution_context. For more details, please see https://github.com/envoyproxy/envoy/issues/32012.

  • oauth: deny_redirect_matcher to support disabling authorization redirects for specific requests, e.g. AJAX requests.

  • opentelemetry/grpc/access_log: Added support to configure trace ID in OpenTelemetry logs.

  • overload: added a configuration option to add x-envoy-local-overloaded header when Overload Manager is triggered.

  • proxy_protocol: Added disallowed_versions to enforce the filter only matches specific PROXY protocol versions.

  • proxy_protocol: Added new statistics to the proxy protocol filter to track connections found/disallowed/errored by PROXY protocol version.

  • quic: Added QUIC protocol option send_disable_active_migration to make the server send clients a transport parameter to discourage client endpoints from active migration.

  • quic: Added support for QUIC listeners to choose certificates based on SNI and load certificates from formats other than PEM, such as pkcs12. This behavior can be disabled with runtime flag envoy.restart_features.quic_handle_certs_with_shared_tls_code.

  • rbac: Added rules_stat_prefix to allow adding custom prefix to the stats emitted by rules.

  • rbac: Added uri_template which uses existing UriTemplateMatchConfig to allow use of glob patterns for URI path matching in RBAC.

  • rbac: Added additional statistics for rules and shadow rules to the RBAC HTTP filter.

  • redis: Added support for the ECHO command.

  • string matcher: Added an extension point for custom string matcher implementations. An implementation for running a Lua script is included.

  • tcp_proxy: added an option to dynamically set a per downstream connection idle timeout period object under the key envoy.tcp_proxy.per_connection_idle_timeout_ms. If this filter state value exists, it will override the idle timeout specified in the filter configuration and the default idle timeout.

  • tracing: Added User-Agent header to OTLP trace exporters according to the OpenTelemetry specification.

  • tracing: Added support for variant span attribute type for the OpenTelemetry tracer.

  • tracing: Added support to configure a Dynatrace sampler for the OpenTelemetry tracer.

  • tracing: Datadog: span attributes and trace sampling can be configured remotely.

  • tracing: Dynatrace sampler fetches configuration from Dynatrace API.

  • upstream: Added selection_method option to the least request load balancer. If set to FULL_SCAN, Envoy will select the host with the fewest active requests from the entire host set rather than choice_count random choices.

  • wasm: added verify_signature foreign function to verify cryptographic signatures.

Deprecated