Prometheus

Overview Examples Configuration reference Changelog API reference

Configuration

configobject

Hide Child Parameters

ai_metricsboolean

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.

Default:false

bandwidth_metricsboolean

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

Default:false

latency_metricsboolean

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.

Default:false

per_consumerboolean

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.

Default:false

status_code_metricsboolean

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

Default:false

upstream_health_metricsboolean

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

Default:false

wasm_metricsboolean

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

Default:false

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

protocolsarray[string]

A string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

Prometheus

Configuration

Did this doc help?

Help us make these docs great!

Still need help