Skip to content

Commit

Permalink
kic: document 2 new metrics for configuration push size
Browse files Browse the repository at this point in the history
  • Loading branch information
programmer04 committed Nov 18, 2024
1 parent 34c42e6 commit 529eeb2
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/styles/kong/auto-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ firstTimestamp
foogineer
geos
if_version
ingress_controller_configuration_push_size
ingress_controller_configuration_push_broken_resource_count
ingress_controller_configuration_push_count
ingress_controller_configuration_push_duration_milliseconds
ingress_controller_configuration_push_last_successful
ingress_controller_fallback_configuration_push_size
ingress_controller_fallback_cache_generation_duration_milliseconds
ingress_controller_fallback_configuration_push_broken_resource_count
ingress_controller_fallback_configuration_push_count
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,20 @@ This metric provides these labels:
{% endif_version -%}
* `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.

{% if_version gte:3.4.x %}

### ingress_controller_configuration_push_size

`ingress_controller_configuration_push_size` (type: `gauge`) is the size of the configuration pushed to Kong, in bytes.

This metric provides these labels:

* `dataplane` describes the dataplane 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`).

{% endif_version -%}

{% if_version gte:2.11.x %}
### ingress_controller_configuration_push_broken_resource_count

Expand Down Expand Up @@ -146,6 +160,20 @@ 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 occurs. If `success` is `true`, the push succeeded without errors.

{% if_version gte:3.4.x %}

### ingress_controller_fallback_configuration_push_size

`ingress_controller_fallback_configuration_push_size` (type: `gauge`) is the size of the configuration pushed to Kong in fallback mode, in bytes.

This metric provides these labels:

* `dataplane` describes the dataplane 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`).

{% endif_version %}

### ingress_controller_fallback_configuration_push_broken_resource_count

`ingress_controller_fallback_configuration_push_broken_resource_count` (type: `gauge`) provides the number of resources not accepted by Kong when attempting to push the fallback configuration.
Expand Down

0 comments on commit 529eeb2

Please sign in to comment.