Skip to content

[Dashboard] Kong Gateway #6028

@therealpandey

Description

@therealpandey

Dashboard Name

Kong Monitoring Dashboard

Expected Dashboard Sections and Panels

(Can be tweaked (add or remove panels/sections) according to available metrics)

General Overview

This section provides a high-level overview of Kong's health and performance metrics, allowing for a quick assessment of the API gateway's current state.

Panels

  • Total Requests

    • Description: Displays the total number of API requests handled by Kong.
  • Active Connections

    • Description: Shows the number of active connections currently managed by Kong.
  • Uptime

    • Description: Displays the total uptime of the Kong instance since the last restart.
  • CPU Usage

    • Description: Illustrates the CPU usage by the Kong process, indicating the percentage of CPU resources consumed.
  • Memory Usage

    • Description: Shows the memory consumption of Kong, helping identify potential memory leaks or inefficiencies.

Request Metrics

This section focuses on metrics related to API request handling, providing insights into request rates, response statuses, and processing times.

Panels

  • Request Rate

    • Description: Displays the rate of incoming API requests per second/minute.
  • Response Status Codes

    • Description: Shows the distribution of HTTP response status codes (e.g., 2xx, 4xx, 5xx) returned by Kong.
  • Request Size

    • Description: Illustrates the average and percentile sizes of incoming API requests.
  • Response Size

    • Description: Displays the average and percentile sizes of responses sent by Kong.

Latency Metrics

This section provides insights into the latency of API requests, helping identify performance bottlenecks and ensuring timely responses.

Panels

  • Average Request Latency

    • Description: Shows the average time taken to process API requests.
  • Request Latency Percentiles

    • Description: Displays latency percentiles (e.g., 50th, 90th, 99th) to highlight variations in request processing times.
  • Upstream Latency

    • Description: Illustrates the latency of upstream services that Kong communicates with during request processing.

Error Metrics

This section monitors errors and failures within Kong operations, aiding in the troubleshooting and resolution of issues.

Panels

  • Total Errors

    • Description: Displays the total number of errors encountered by Kong.
  • Error Rate

    • Description: Shows the rate of errors per second/minute, helping to identify spikes or trends.
  • Top Error Types

    • Description: Lists the most common error types (e.g., connection timeouts, authentication failures) encountered by Kong.
  • Failed Requests by Service

    • Description: Monitors the number of failed requests segmented by the upstream service, aiding in pinpointing problematic services.

Traffic Metrics

This section provides insights into the traffic patterns managed by Kong, including data throughput and connection metrics.

Panels

  • Incoming Traffic Volume

    • Description: Displays the amount of incoming traffic to Kong, measured in requests per second and data volume.
  • Outgoing Traffic Volume

    • Description: Shows the amount of outgoing traffic from Kong to upstream services.
  • Connection Rate

    • Description: Illustrates the rate of new connections being established with Kong.
  • Rejected Connections

    • Description: Monitors the number of connection attempts rejected by Kong, highlighting potential overloads or misconfigurations.

Plugin Metrics

This section tracks metrics related to the various plugins enabled in Kong, providing visibility into their usage and performance.

Panels

  • Active Plugins

    • Description: Lists the active plugins and the number of requests processed by each.
  • Plugin Error Rates

    • Description: Displays the error rates associated with each plugin, aiding in identifying problematic plugins.
  • Plugin Latency

    • Description: Shows the additional latency introduced by each plugin during request processing.

Resource Usage

This section provides insights into the resource consumption of Kong, ensuring it operates efficiently within the infrastructure.

Panels

  • CPU Usage

    • Description: Displays the CPU usage by Kong pods/services, indicating the processing load.
  • Memory Usage

    • Description: Shows the memory consumption of Kong, helping identify potential memory leaks or inefficiencies.
  • Pod Restarts

    • Description: Monitors the number of times Kong pods have restarted, which could indicate stability issues.

Expected Dashboard Variables

  • namespace – Filter metrics based on the Kubernetes namespace where Kong is deployed.
  • service – Select specific Kong services to filter metrics.
  • deployment.environment – Filter metrics based on the deployment environment (e.g., production, staging).
  • cluster - K8s clustername

References or Screenshots

📋 Notes

Please review the CONTRIBUTING.md for guidelines on dashboard structure, naming conventions, and how to submit a pull request.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions