Both Kong Ingress Controller and Kong Gateway expose Prometheus metrics:
Kong Ingress Controller exposes the following Prometheus metrics:
Kong Ingress Controller exposes the following Prometheus metrics:
ingress_controller_configuration_push_count (type: counter) provides the number of successful or failed configuration pushes to Kong Gateway.
This metric provides these labels:
protocol describes the configuration protocol in use, which can be db-less or deck.success logs the status of configuration updates. If success is false, an unrecoverable error occurred. If success is true, the push succeeded with no errors.failure_reason is populated if success="false". It describes the reason for the failure:
conflict: A configuration conflict that must be manually fixednetwork: A network related issues, such as Kong Gateway is offlineother: Other issues, such as Kong Gateway reporting a non-conflict errordataplane describes the Data Plane that was the target of configuration push.ingress_controller_translation_count (type: counter) provides the number of translations from the Kubernetes state to the Kong Gateway state.
This metric provides the success label. success logs the status of configuration updates. If success is false, an unrecoverable error occurred.
If success is true, the translation succeeded with no errors.
ingress_controller_translation_duration_milliseconds (type: histogram) is the amount of time, in milliseconds, that
it takes to translate the Kubernetes state to the Kong Gateway state.
This metric provides the success label. success logs the status of the translation. If success is false, an unrecoverable error occurs. If success is true, the translation succeeded without errors.
ingress_controller_configuration_push_duration_milliseconds (type: histogram) is the amount of time, in milliseconds, that it takes to push the configuration to Kong Gateway.
This metric provides these labels:
protocol describes the configuration protocol in use, which can be db-less or deck.dataplane describes the Data Plane that was the target of configuration push.success logs the status of configuration updates. If success is false, an unrecoverable error occurred. If success is true, the push succeeded with no errors.ingress_controller_configuration_push_size (type: gauge) is the size of the configuration pushed to Kong Gateway, in bytes.
This metric provides these labels:
dataplane describes the Data Plane that was the target of the configuration push.protocol describes the configuration protocol (metric is presented for db-less, for deck it doesn’t exist) in use.success describes whether there were unrecoverable errors (false) or not (true).ingress_controller_configuration_push_broken_resource_count (type: counter) provides the number of resources not accepted by Kong Gateway when attempting to push configuration.
This metric provides the dataplane label. This specifies the Data Plane that was the target of the configuration push.
ingress_controller_configuration_push_last_successful (type: gauge) provides the time of the last successful configuration push.
This metric provides the dataplane label. This specifies the Data Plane that was the target of the configuration push.
ingress_controller_translation_broken_resource_count (type: gauge) provides the number of resources that the controller cannot successfully translate to Kong Gateway configuration.
ingress_controller_fallback_translation_count (type: counter) provides the count of translations from Kubernetes state to Kong Gateway state in fallback mode.
This metric provides the success label. success logs the status of the translation. If success is false, an unrecoverable error occurs. If success is true, the translation succeeded without errors.
ingress_controller_fallback_translation_duration_milliseconds (type: histogram) provides the amount of time, in milliseconds,
that it takes to translate the Kubernetes state to the Kong Gateway state in fallback mode.
This metric provides the success label. success logs the status of the translation. If success is false, an unrecoverable error occurs. If success is true, the translation succeeded without errors.
ingress_controller_fallback_translation_broken_resource_count (type: gauge) provides the number of resources that the controller cannot successfully translate to Kong Gateway configuration in fallback mode.
ingress_controller_fallback_configuration_push_count (type: counter) provides the count of successful/failed fallback configuration pushes to Kong Gateway.
This metric provides these labels:
dataplane describes the Data Plane that was the target of the configuration push.protocol describes the configuration protocol in use, which can be db-less or deck.success logs the status of configuration updates. If success is false, an unrecoverable error occurs. If success is true, the push succeeded without errors.failure_reason is populated if success="false". It describes the reason for the failure:
conflict: A configuration conflict that must be manually fixednetwork: A network related issue, such as Kong Gateway being offlineother: Other issues, such as Kong Gateway reporting a non-conflict erroringress_controller_fallback_configuration_push_last (type: gauge) provides the time of the last successful fallback configuration push.
This metric provides the dataplane label. dataplane describes the Data Plane that was the target of the configuration push.
ingress_controller_fallback_configuration_push_duration_milliseconds (type: histogram) provides the amount of time, in milliseconds, that it takes to push the fallback configuration to Kong Gateway.
This metric provides these labels:
dataplane describes the Data Plane that was the target of the configuration push.protocol describes the configuration protocol in use, which can be db-less or deck.success logs the status of configuration updates. If success is false, an unrecoverable error occurs. If success is true, the push succeeded without errors.ingress_controller_fallback_configuration_push_size (type: gauge) is the size of the configuration pushed to Kong Gateway in fallback mode, in bytes.
This metric provides these labels:
dataplane describes the Data Plane that was the target of the configuration push.protocol describes the configuration protocol (metric is presented for db-less, for deck it doesn’t exist) in use.success describes whether there were unrecoverable errors (false) or not (true).ingress_controller_fallback_configuration_push_broken_resource_count (type: gauge) provides the number of resources that Kong Gateway doesn’t accept when attempting to push the fallback configuration.
This metric provides the dataplane label. dataplane describes the Data Plane that was the target of the configuration push.
ingress_controller_fallback_cache_generation_duration_milliseconds (type: histogram) provides the amount of time, in milliseconds, that it takes to generate a fallback cache.
This metric provides the success label. success logs the status of cache generation. If success is false, an unrecoverable error occurs. If success is true, the cache generation succeeded without errors.
ingress_controller_processed_config_snapshot_cache_hit (type: counter) provides the count of times the controller hit the processed configuration snapshot cache and skipped generating a new one.
ingress_controller_processed_config_snapshot_cache_miss (type: counter) provides the count of times the controller missed the processed configuration snapshot cache and had to generate a new one.
In addition, Kong Ingress Controller exposes more low-level performance metrics, but these may change from version to version because they are provided by the underlying frameworks of Kong Ingress Controller.
A non-exhaustive list of these low-level metrics is described in the following:
If I have multiple Data Plane nodes with the Prometheus plugin enabled, does the metrics data reflect the status of a single node or the aggregated status across all nodes?
Metrics data is reported per-node (each Data Plane) per-subsystem (HTTP or TCP).