Available metrics in Prometheus format

This article lists exposed metrics, i.e., for monitoring licensed throughput and common indicator values. Prometheus supports different metric types such as counter, gauge, histogram, and summary.

Engine metrics

Metric name

Metric type

Description

Standard Envoy metrics – see Envoy documentation.

–

microgateway_build_info

gauge

Metric shows the static value 1, labeled by the Microgateway Engine version information.

Example:
microgateway_build_info{version="4.2.0"} 1

microgateway_license_http_rq_total

counter

Number of total requests.

microgateway_http_downstream_rq_blocked_total

counter

Number of requests (rq) blocked by an Engine filter.

microgateway_http_downstream_rs_blocked_total

counter

Number of responses (rs) blocked by an Engine filter.

microgateway_http_downstream_rq_deny_rule_total

counter

Number of requests (rq) that triggered the built-in deny rules.

microgateway_http_downstream_rq_limit_total

counter

This metric counts how often a specific limit was triggered by requests (rq).

  • The metric has the following additional labels:
  • envoy_cluster_name
  • limit_name
  • threat_handling_mode
  • This metric supports all limit types:
  • general_body_size
  • general_path_length
  • parameter_count
  • parameter_name_length
  • parameter_value_length
  • json_nesting_depth
  • json_key_count json_element_count
  • json_key_length json_value_length

Operator metrics

Metric name

Metric type

Description

microgateway_build_info

gauge

Metric shows the static value 1, labeled by the Migrogateway Operator version information.

Example:
microgateway_build_info{version="4.2.0"} 1

microgateway_sidecars

gauge

The number of injected Airlock Microgateway Engine sidecars managed by this Operator instance.

microgateway_license_max_sidecars 1

gauge

The licensed sidecar count. A value of inf means there is no limit.

microgateway_license_valid 1

gauge

Whether the Airlock Microgateway Operator has a valid license 1 or not 0.

microgateway_license_max_rq_count_per_month 1

gauge

The licensed request count per month. When using the community edition license, no monthly count is available, but instead the value NaN is shown.

microgateway_license_is_premium 1

gauge

Whether the active license (if any) is a premium license 1 or not 0.

microgateway_license_expiry_timestamp_seconds 1

gauge

(Unix) timestamp when the active license expires.

1

License-related metric. See also Licensing and license-dependent behavior article.
Note that when the license changes, the metrics are updated and the license status changed is logged. This can take up to 1 minute after the secret is adjusted since Kubernetes updates mounted config maps only periodically.