Skip to content

Commit

Permalink
docs(kic): update metrics reference (#7839)
Browse files Browse the repository at this point in the history
  • Loading branch information
czeslavo committed Sep 23, 2024
1 parent dfc3a87 commit c748496
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .github/styles/kong/auto-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,12 @@ ingress_controller_fallback_configuration_push_duration_milliseconds
ingress_controller_fallback_configuration_push_last
ingress_controller_fallback_translation_broken_resource_count
ingress_controller_fallback_translation_count
ingress_controller_fallback_translation_duration_milliseconds
ingress_controller_processed_config_snapshot_cache_hit
ingress_controller_processed_config_snapshot_cache_miss
ingress_controller_translation_broken_resource_count
ingress_controller_translation_count
ingress_controller_translation_duration_milliseconds
inlineString
involvedObject
kuma
Expand Down Expand Up @@ -103,4 +105,4 @@ KongClusterPlugin
KongConsumer
Rekor
Sigstore
Hasura
Hasura
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,19 @@ This metric provides these labels:
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.

{% if_version gte:3.3.x %}

### ingress_controller_translation_duration_milliseconds

`ingress_controller_translation_duration_milliseconds` (type: `histogram`) is the amount of time, in milliseconds, that
it takes to translate the Kubernetes state to the {{site.base_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.

{% endif_version %}

### ingress_controller_configuration_push_duration_milliseconds

`ingress_controller_configuration_push_duration_milliseconds` (type: `histogram`) is the amount of time, in milliseconds, that it takes to push the configuration to {{site.base_gateway}}.
Expand Down Expand Up @@ -84,6 +97,19 @@ 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.

{% if_version gte:3.3.x %}

### ingress_controller_fallback_translation_duration_milliseconds

`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 {{site.base_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.

{% endif_version %}

### ingress_controller_fallback_translation_broken_resource_count

`ingress_controller_fallback_translation_broken_resource_count` (type: `gauge`) provides the number of resources that the controller cannot successfully translate to Kong configuration in fallback mode.
Expand Down

0 comments on commit c748496

Please sign in to comment.