kic: document 2 new metrics for configuration push size

Kong · Nov 13, 2024 · 27581a8 · 27581a8
1 parent 9775bdb
commit 27581a8
Show file tree

Hide file tree

Showing 4 changed files with 257 additions and 0 deletions.
diff --git a/.github/styles/kong/auto-ignore.txt b/.github/styles/kong/auto-ignore.txt
@@ -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

diff --git a/app/_data/docs_nav_kic_3.4.x.yml b/app/_data/docs_nav_kic_3.4.x.yml
@@ -0,0 +1,223 @@
+product: kubernetes-ingress-controller
+release: 3.4.x
+generate: true
+items:
+  - title: Introduction
+    icon: /assets/images/icons/documentation/icn-flag.svg
+    items:
+      - text: Overview
+        url: /kubernetes-ingress-controller/3.4.x/
+        absolute_url: true
+      - text: Kubernetes Gateway API
+        url: /gateway-api
+      - text: Version Support Policy
+        url: /support-policy
+      - text: Changelog
+        url: >-
+          https://github.com/Kong/kubernetes-ingress-controller/blob/main/CHANGELOG.md
+        absolute_url: true
+        target_blank: true
+  - title: How KIC Works
+    icon: /assets/images/icons/documentation/icn-kubernetes-color.svg
+    items:
+      - text: Architecture
+        url: /concepts/architecture
+      - text: Gateway API
+        url: /concepts/gateway-api
+      - text: Ingress
+        url: /concepts/ingress
+      - text: Custom Resources
+        url: /concepts/custom-resources
+      - text: Using Annotations
+        url: /concepts/annotations
+      - text: Admission Webhook
+        url: /concepts/admission-webhook
+  - title: Get Started
+    icon: /assets/images/icons/documentation/icn-learning.svg
+    items:
+      - text: Install KIC
+        url: /get-started/
+      - text: Services and Routes
+        url: /get-started/services-and-routes
+      - text: Rate Limiting
+        url: /get-started/rate-limiting
+      - text: Proxy Caching
+        url: /get-started/proxy-caching
+      - text: Key Authentication
+        url: /get-started/key-authentication
+
+  - title: KIC in Production
+    icon: /assets/images/icons/documentation/icn-deployment-color.svg
+    items:
+      - text: Deployment Topologies
+        items:
+          - text: Overview
+            url: /production/deployment-topologies/
+          - text: Gateway Discovery
+            url: /production/deployment-topologies/gateway-discovery
+          - text: Database Backed
+            url: /production/deployment-topologies/db-backed
+          - text: Traditional (sidecar)
+            url: /production/deployment-topologies/sidecar
+      - text: Installation Methods
+        items:
+          - text: Helm
+            url: /install/helm
+          - text: Kong Gateway Operator
+            url: /install/gateway-operator
+      - text: Cloud Deployment
+        items:
+          - text: Azure
+            url: /install/cloud/aks
+          - text: Amazon
+            url: /install/cloud/eks
+          - text: Google
+            url: /install/cloud/gke
+      - text: Enterprise License
+        url: /license
+      - text: Observability
+        items:
+          - text: Prometheus Metrics
+            url: /production/observability/prometheus
+          - text: Configuring Prometheus and Grafana
+            url: /production/observability/prometheus-grafana
+          - text: Kubernetes Events
+            url: /production/observability/events
+      - text: Upgrading
+        items:
+          - text: Kong Gateway
+            url: /upgrade/gateway
+          - text: Ingress Controller
+            url: /upgrade/kic
+
+  - title: Guides
+    icon: /assets/images/icons/documentation/icn-solution-guide.svg
+    items:
+      - text: Service Configuration
+        items:
+          - text: HTTP Service
+            url: /guides/services/http
+          - text: TCP Service
+            url: /guides/services/tcp
+          - text: UDP Service
+            url: /guides/services/udp
+          - text: gRPC Service
+            url: /guides/services/grpc
+          - text: TLS
+            url: /guides/services/tls
+          - text: External Service
+            url: /guides/services/external
+          - text: HTTPS Redirects
+            url: /guides/services/https-redirect
+          - text: Multiple Backend Services
+            url: /guides/services/multiple-backends
+          - text: Configuring Gateway API resources across namespaces
+            url: /guides/services/cross-namespace
+          - text: Configuring Custom Kong Entities
+            url: /guides/services/custom-entity
+      - text: Request Manipulation
+        items:
+          - text: Rewriting Hosts and Paths
+            url: /guides/requests/rewrite-host-and-paths
+          - text: Rewrite Annotation
+            url: /guides/requests/rewrite-annotation
+          - text: Customizing load-balancing behavior
+            url: /guides/requests/customizing-load-balancing
+      - text: High Availability
+        items:
+          - text: KIC High Availability
+            url: /guides/high-availability/kic
+          - text: Service Health Checks
+            url: /guides/high-availability/health-checks
+          - text: Last Known Good Config
+            url: /guides/high-availability/last-known-good-config
+          - text: Fallback Configuration
+            url: /guides/high-availability/fallback-config
+      - text: Security
+        items:
+          - text: Kong Vaults
+            url: /guides/security/kong-vault
+          #- text: Cert Manager
+          #  url: /guides/security/cert-manager
+          - text: Using Workspaces
+            url: /guides/security/workspaces
+          - text: Preserving Client IP
+            url: /guides/security/client-ip
+          - text: Kubernetes Secrets in Plugins
+            url: /guides/security/plugin-secrets
+      #- text: Service Mesh
+      #  items:
+      #    - text: Kong Mesh
+      #      url: /guides/mesh/kong-mesh
+      #    - text: Kuma
+      #      url: /guides/mesh/kuma
+      #    - text: Istio
+      #      url: /guides/mesh/istio
+      - text: Migrate
+        items:
+          - text: KongIngress to KongUpstreamPolicy
+            url: /guides/migrate/kongingress
+          - text: Migrating from Ingress to Gateway
+            url: /guides/migrate/ingress-to-gateway
+          - text: Credential Type Labels
+            url: /guides/migrate/credential-kongcredtype-label
+      - text: Customize Deployments
+        items:
+          - text: Images
+            url: /guides/customize/image
+      - text: Custom Ingress Class
+        items:
+          - text: Internal / External Traffic
+            url: /guides/custom-class/internal-external
+
+  - title: Plugins
+    icon: /assets/images/icons/documentation/icn-api-plugins-color.svg
+    items:
+      - text: Custom Plugins
+        url: /plugins/custom
+      - text: Authentication
+        url: /plugins/authentication
+      - text: ACL
+        url: /plugins/acl
+      - text: Rate Limiting
+        url: /plugins/rate-limiting
+      - text: mTLS
+        url: /plugins/mtls
+      - text: OIDC
+        url: /plugins/oidc
+
+  - title: Reference
+    icon: /assets/images/icons/documentation/icn-references-color.svg
+    items:
+      - text: Troubleshooting
+        url: /reference/troubleshooting
+      - text: Version Compatibility
+        url: /reference/version-compatibility
+      - text: Annotations
+        url: /reference/annotations
+      # - text: Configuration Options
+      #   url: /reference/cli-arguments/
+      #   src: reference/cli-arguments-3.4.x
+      - text: Beta Feature Gates
+        url: /reference/feature-gates
+      - text: FAQ
+        items:
+          - text: Plugin Compatibility
+            url: /hub/plugins/compatibility/
+            absolute_url: true
+          - text: Kong Router
+            url: /reference/faq/router
+          - text: Custom nginx.conf
+            url: /reference/faq/nginx.conf
+      # - text: Custom Resource Definitions
+      #   url: /reference/custom-resources
+      #   src: reference/custom-resources-3.4.x
+      - text: Resources Requiring Setting Ingress Class
+        url: /reference/resource-requiring-ingress-class
+        src: reference/ingress-class-requirement
+      - text: Gateway API migration
+        url: /reference/ingress-to-gateway-migration
+      - text: Required Permissions for Installation
+        url: /reference/required-permissions
+      - text: Categories of Failures
+        url: /reference/failure-modes
diff --git a/app/_data/kong_versions.yml b/app/_data/kong_versions.yml
@@ -285,6 +285,10 @@
   version: "3.3.1"
   edition: "kubernetes-ingress-controller"
   latest: true
+- release: "3.4.x"
+  version: "3.4.0"
+  edition: "kubernetes-ingress-controller"
+  label: unreleased
 - edition: gateway-operator
   version: 1.0.3
   release: 1.0.x

diff --git a/app/_src/kubernetes-ingress-controller/production/observability/prometheus.md b/app/_src/kubernetes-ingress-controller/production/observability/prometheus.md
@@ -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
 
@@ -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.