Event Gateway breaking changes and known issues

Before upgrading, review any configuration or breaking changes in the version you’re upgrading to and prior versions that affect your current installation.

1.1.x breaking changes

Review the changelog for all the changes in this release.

1.1.0

Breaking changes in the Event Gateway 1.1.0 release.

Environment variable prefix for data planes

The data plane configuration prefix has changed from KEG__KONNECT__ or KONNECT_ to KONG_KONNECT_. The old environment variables are no longer accepted.

For example, to pass configuration settings to a new data plane, you would use:

docker run -d \
-e "KONG_KONNECT_REGION=us" \
-e "KONG_KONNECT_DOMAIN=konghq.com" \
-e "KONG_KONNECT_GATEWAY_CLUSTER_ID=your-gateway-id" \
-e "KONG_KONNECT_CLIENT_CERT=example-cert" \
-e "KONG_KONNECT_CLIENT_KEY=example-key" \
-p 19092-19101:19092-19101 \
kong/kong-event-gateway:1.1.0

For more information about configuring data planes at startup and all options, see the Event Gateway configuration reference.

Metrics naming convention

Event Gateway metrics have been renamed to more closely follow OpenTelemetry semantic conventions.

Key changes:

  1. Delimiter change: _ > . (Prometheus > OTel convention)
  2. Suffix stripping: _count, _seconds, _ms, and _active suffixes removed. The unit is now in metadata only.
  3. Unit normalization: All durations are now in seconds. Previously, the metrics were a mix of seconds and ms.
  4. Label namespacing: Labels now use dotted namespaces (for example, result > kong.keg.result).
  5. Common labels changed:
    • topic > messaging.destination.name
    • policy_konnect_* > kong.konnect.policy.* and kong.keg.policy.*

For example:

  • Old metric: kong_keg_kafka_backend_connection_error_count
  • New metric: kong.keg.kafka.backend.connection.errors

Removed in 1.1:

1.0 Metric

Description

kong_keg_konnect_request_count Konnect request count histogram. Merged into kong.keg.konnect.request.duration and gained a http.response.status_code label.

New in 1.1:

1.1 Metric

Description

kong.keg.config.errors Config loading error count.
kong.keg.config.loaded Config version loaded from CP.
kong.keg.kafka.connection.errors Proxied connections that have errors.
kong.keg.kafka.decrypt.attempts Decryption attempt count.
kong.keg.kafka.encrypt.attempts Encryption attempt count.
kong.keg.kafka.kscheme.attempts Kscheme script attempt count.
kong.keg.kafka.policy.condition.failures Policy condition execution errors.

For all metrics in 1.1.0, see the metrics reference.

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!