1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginPrometheus
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

konnect.getGatewayPluginPrometheus

Explore with Pulumi AI

Using getGatewayPluginPrometheus

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGatewayPluginPrometheus(args: GetGatewayPluginPrometheusArgs, opts?: InvokeOptions): Promise<GetGatewayPluginPrometheusResult>
function getGatewayPluginPrometheusOutput(args: GetGatewayPluginPrometheusOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginPrometheusResult>
Copy
def get_gateway_plugin_prometheus(control_plane_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetGatewayPluginPrometheusResult
def get_gateway_plugin_prometheus_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginPrometheusResult]
Copy
func LookupGatewayPluginPrometheus(ctx *Context, args *LookupGatewayPluginPrometheusArgs, opts ...InvokeOption) (*LookupGatewayPluginPrometheusResult, error)
func LookupGatewayPluginPrometheusOutput(ctx *Context, args *LookupGatewayPluginPrometheusOutputArgs, opts ...InvokeOption) LookupGatewayPluginPrometheusResultOutput
Copy

> Note: This function is named LookupGatewayPluginPrometheus in the Go SDK.

public static class GetGatewayPluginPrometheus 
{
    public static Task<GetGatewayPluginPrometheusResult> InvokeAsync(GetGatewayPluginPrometheusArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginPrometheusResult> Invoke(GetGatewayPluginPrometheusInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayPluginPrometheusResult> getGatewayPluginPrometheus(GetGatewayPluginPrometheusArgs args, InvokeOptions options)
public static Output<GetGatewayPluginPrometheusResult> getGatewayPluginPrometheus(GetGatewayPluginPrometheusArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginPrometheus:getGatewayPluginPrometheus
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ControlPlaneId This property is required. string
ControlPlaneId This property is required. string
controlPlaneId This property is required. String
controlPlaneId This property is required. string
control_plane_id This property is required. str
controlPlaneId This property is required. String

getGatewayPluginPrometheus Result

The following output properties are available:

Supporting Types

GetGatewayPluginPrometheusConfig

AiMetrics This property is required. bool
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.
BandwidthMetrics This property is required. bool
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
LatencyMetrics This property is required. bool
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.
PerConsumer This property is required. bool
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.
StatusCodeMetrics This property is required. bool
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
UpstreamHealthMetrics This property is required. bool
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
AiMetrics This property is required. bool
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.
BandwidthMetrics This property is required. bool
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
LatencyMetrics This property is required. bool
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.
PerConsumer This property is required. bool
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.
StatusCodeMetrics This property is required. bool
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
UpstreamHealthMetrics This property is required. bool
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
aiMetrics This property is required. Boolean
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.
bandwidthMetrics This property is required. Boolean
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
latencyMetrics This property is required. Boolean
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.
perConsumer This property is required. Boolean
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.
statusCodeMetrics This property is required. Boolean
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
upstreamHealthMetrics This property is required. Boolean
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
aiMetrics This property is required. boolean
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.
bandwidthMetrics This property is required. boolean
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
latencyMetrics This property is required. boolean
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.
perConsumer This property is required. boolean
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.
statusCodeMetrics This property is required. boolean
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
upstreamHealthMetrics This property is required. boolean
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
ai_metrics This property is required. bool
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.
bandwidth_metrics This property is required. bool
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
latency_metrics This property is required. bool
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.
per_consumer This property is required. bool
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 This property is required. bool
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
upstream_health_metrics This property is required. bool
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.
aiMetrics This property is required. Boolean
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.
bandwidthMetrics This property is required. Boolean
A boolean value that determines if bandwidth metrics should be collected. If enabled, bandwidth_bytes and stream_sessions_total metrics will be exported.
latencyMetrics This property is required. Boolean
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.
perConsumer This property is required. Boolean
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.
statusCodeMetrics This property is required. Boolean
A boolean value that determines if status code metrics should be collected. If enabled, http_requests_total, stream_sessions_total metrics will be exported.
upstreamHealthMetrics This property is required. Boolean
A boolean value that determines if upstream metrics should be collected. If enabled, upstream_target_health metric will be exported.

GetGatewayPluginPrometheusConsumer

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginPrometheusOrdering

after This property is required. Property Map
before This property is required. Property Map

GetGatewayPluginPrometheusOrderingAfter

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginPrometheusOrderingBefore

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginPrometheusRoute

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginPrometheusService

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.