Example PromQL Queries

Provides example PromQL queries you can use to analyze Apinizer Gateway metrics. Includes ready query examples for API traffic analyses, external connection analyses, cache analyses, and JVM analyses. You can monitor and analyze Gateway performance using these queries in Prometheus or Grafana.

API Traffic Analyses

Total API Request Count

Total Request Count for 1 Hour

Calculates the total number of API requests in the specified time range.

sum(increase(apinizer_api_traffic_total_count_total[1h]))

Request Count per API

Request Count per API for 5 Minutes

Calculates the request count separately for each API.

sum by (api_name) (increase(apinizer_api_traffic_total_count_tagged_total[5m]))

API Success Rate

Success Rate (%) for 10 Minutes

Calculates the ratio of successful requests to total requests as a percentage.

(sum(increase(apinizer_api_traffic_success_count_total[10m])) / sum(increase(apinizer_api_traffic_total_count_total[10m]))) * 100

APIs with Highest Error Rate

Highest Error Rate for 15 Minutes

Lists the top 5 APIs with the highest error rate.

topk(5, sum by (api_name) (increase(apinizer_api_traffic_error_count_tagged_total[15m])) / sum by (api_name) (increase(apinizer_api_traffic_total_count_tagged_total[15m])))

Average Response Time per API

Average Response Time for 5 Minutes

Calculates the average response time for each API.

sum by (api_name) (rate(apinizer_api_traffic_total_time_tagged_seconds_sum[5m])) / sum by (api_name) (rate(apinizer_api_traffic_total_time_tagged_seconds_count[5m]))

External Connection Analyses

Error Rate per Target URL

Error Rate per URL for 5 Minutes

Calculates the error rate for each external URL.

sum by (url) (increase(apinizer_external_requests_total_count_tagged_total[5m])) / sum by (url) (increase(apinizer_external_requests_total_count_tagged_total[5m]))

Slowest Services

Slowest Services for 5 Minutes

Lists the top 5 services with the highest average response time.

topk(5, sum by (url) (rate(apinizer_external_response_time_seconds_sum[5m])) / sum by (url) (rate(apinizer_external_response_time_seconds_count[5m])))

Cache Analyses

Cache Hit Rate

General Cache Hit Rate (%) for 5 Minutes

Calculates the general cache hit rate for all APIs as a percentage.

(sum(increase(apinizer_api_traffic_cache_hits_count_total[5m])) / sum(increase(apinizer_api_traffic_total_count_total[5m]))) * 100

Cache Hit Rate per API

Cache Hit Rate per API (%) for 5 Minutes

Calculates the cache hit rate separately for each API.

sum by (api_name) (increase(apinizer_api_traffic_cache_hits_count_tagged_total[5m])) / sum by (api_name) (increase(apinizer_api_traffic_total_count_tagged_total[5m])) * 100

JVM Analyses

Memory Usage Percentage

Instant Memory Usage Percentage

Calculates the ratio of memory used by JVM to maximum memory amount as a percentage.

sum(jvm_memory_used_bytes) / sum(jvm_memory_max_bytes) * 100

Garbage Collection Duration

GC Duration for 5 Minutes

Calculates the total duration of Garbage Collection operations.

sum(rate(jvm_gc_pause_seconds_sum[5m]))

Thread Count

Instant Thread Count

Shows the number of active threads running in JVM.

sum(jvm_threads_live_threads)