Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

kic: document 2 new metrics for configuration push size #8134

Merged
merged 1 commit into from
Nov 18, 2024
Merged

kic: document 2 new metrics for configuration push size #8134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/styles/kong/auto-ignore.txt
View file
Open in desktop
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
28 changes: 28 additions & 0 deletions app/_src/kubernetes-ingress-controller/production/observability/prometheus.md
View file
Open in desktop
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
Loading