Prometheus Configuration

Configuration

This plugin is compatible with DB-less mode.

The database will always be reported as reachable in Prometheus with DB-less. Additionally, the DB entity count metric (kong_db_entities_total) is not emitted in DB-less mode.

Compatible protocols

The Prometheus plugin is compatible with the following protocols:

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case prometheus.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example prometheus_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• consumer.name or consumer.id

  string

  The name or ID of the consumer the plugin targets. Set one of these parameters if adding the plugin to a consumer through the top-level /plugins endpoint. Not required if using /consumers/{consumerName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • per_consumer

    boolean default: false

    A boolean value that determines if per-consumer metrics should be collected. If enabled, the kong_http_requests_total and kong_bandwidth_bytes metrics fill in the consumer label when available.

  • status_code_metrics

    boolean default: false

    A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.

  • ai_metrics

    boolean default: false

    A boolean value that determines if ai metrics should be collected. If enabled, the ai_llm_requests_total, ai_llm_cost_total and ai_llm_tokens_total metrics will be exported.

  • latency_metrics

    boolean default: false

    A boolean value that determines if latency metrics should be collected. If enabled, kong_latency_ms, upstream_latency_ms and request_latency_ms metrics will be exported.

  • bandwidth_metrics

    boolean default: false

    A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.

  • upstream_health_metrics

    boolean default: false

    A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.

  • wasm_metrics

    boolean default: false

    A boolean value that determines if Wasm metrics should be collected.