konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
konnect.getGatewayPluginOpentelemetry
Explore with Pulumi AI
Using getGatewayPluginOpentelemetry
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 getGatewayPluginOpentelemetry(args: GetGatewayPluginOpentelemetryArgs, opts?: InvokeOptions): Promise<GetGatewayPluginOpentelemetryResult>
function getGatewayPluginOpentelemetryOutput(args: GetGatewayPluginOpentelemetryOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginOpentelemetryResult>def get_gateway_plugin_opentelemetry(control_plane_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetGatewayPluginOpentelemetryResult
def get_gateway_plugin_opentelemetry_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginOpentelemetryResult]func LookupGatewayPluginOpentelemetry(ctx *Context, args *LookupGatewayPluginOpentelemetryArgs, opts ...InvokeOption) (*LookupGatewayPluginOpentelemetryResult, error)
func LookupGatewayPluginOpentelemetryOutput(ctx *Context, args *LookupGatewayPluginOpentelemetryOutputArgs, opts ...InvokeOption) LookupGatewayPluginOpentelemetryResultOutput> Note: This function is named LookupGatewayPluginOpentelemetry in the Go SDK.
public static class GetGatewayPluginOpentelemetry 
{
    public static Task<GetGatewayPluginOpentelemetryResult> InvokeAsync(GetGatewayPluginOpentelemetryArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginOpentelemetryResult> Invoke(GetGatewayPluginOpentelemetryInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGatewayPluginOpentelemetryResult> getGatewayPluginOpentelemetry(GetGatewayPluginOpentelemetryArgs args, InvokeOptions options)
public static Output<GetGatewayPluginOpentelemetryResult> getGatewayPluginOpentelemetry(GetGatewayPluginOpentelemetryArgs args, InvokeOptions options)
fn::invoke:
  function: konnect:index/getGatewayPluginOpentelemetry:getGatewayPluginOpentelemetry
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ControlPlane stringId 
- ControlPlane stringId 
- controlPlane StringId 
- controlPlane stringId 
- control_plane_ strid 
- controlPlane StringId 
getGatewayPluginOpentelemetry Result
The following output properties are available:
- Config
GetGateway Plugin Opentelemetry Config 
- Consumer
GetGateway Plugin Opentelemetry Consumer 
- ControlPlane stringId 
- CreatedAt double
- Enabled bool
- Id string
- InstanceName string
- Ordering
GetGateway Plugin Opentelemetry Ordering 
- Protocols List<string>
- Route
GetGateway Plugin Opentelemetry Route 
- Service
GetGateway Plugin Opentelemetry Service 
- List<string>
- UpdatedAt double
- Config
GetGateway Plugin Opentelemetry Config 
- Consumer
GetGateway Plugin Opentelemetry Consumer 
- ControlPlane stringId 
- CreatedAt float64
- Enabled bool
- Id string
- InstanceName string
- Ordering
GetGateway Plugin Opentelemetry Ordering 
- Protocols []string
- Route
GetGateway Plugin Opentelemetry Route 
- Service
GetGateway Plugin Opentelemetry Service 
- []string
- UpdatedAt float64
- config
GetGateway Plugin Opentelemetry Config 
- consumer
GetGateway Plugin Opentelemetry Consumer 
- controlPlane StringId 
- createdAt Double
- enabled Boolean
- id String
- instanceName String
- ordering
GetGateway Plugin Opentelemetry Ordering 
- protocols List<String>
- route
GetGateway Plugin Opentelemetry Route 
- service
GetGateway Plugin Opentelemetry Service 
- List<String>
- updatedAt Double
- config
GetGateway Plugin Opentelemetry Config 
- consumer
GetGateway Plugin Opentelemetry Consumer 
- controlPlane stringId 
- createdAt number
- enabled boolean
- id string
- instanceName string
- ordering
GetGateway Plugin Opentelemetry Ordering 
- protocols string[]
- route
GetGateway Plugin Opentelemetry Route 
- service
GetGateway Plugin Opentelemetry Service 
- string[]
- updatedAt number
- config
GetGateway Plugin Opentelemetry Config 
- consumer
GetGateway Plugin Opentelemetry Consumer 
- control_plane_ strid 
- created_at float
- enabled bool
- id str
- instance_name str
- ordering
GetGateway Plugin Opentelemetry Ordering 
- protocols Sequence[str]
- route
GetGateway Plugin Opentelemetry Route 
- service
GetGateway Plugin Opentelemetry Service 
- Sequence[str]
- updated_at float
- config Property Map
- consumer Property Map
- controlPlane StringId 
- createdAt Number
- enabled Boolean
- id String
- instanceName String
- ordering Property Map
- protocols List<String>
- route Property Map
- service Property Map
- List<String>
- updatedAt Number
Supporting Types
GetGatewayPluginOpentelemetryConfig    
- BatchFlush doubleDelay 
- The delay, in seconds, between two consecutive batches.
- BatchSpan doubleCount 
- The number of spans to be sent in a single batch.
- ConnectTimeout double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- HeaderType string
- Headers Dictionary<string, string>
- The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.
- HttpResponse stringHeader For Traceid 
- LogsEndpoint string
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- Propagation
GetGateway Plugin Opentelemetry Config Propagation 
- Queue
GetGateway Plugin Opentelemetry Config Queue 
- ReadTimeout double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- ResourceAttributes Dictionary<string, string>
- SamplingRate double
- Tracing sampling rate for configuring the probability-based sampler. When set, this value supersedes the global tracing_sampling_ratesetting from kong.conf.
- SendTimeout double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- TracesEndpoint string
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- BatchFlush float64Delay 
- The delay, in seconds, between two consecutive batches.
- BatchSpan float64Count 
- The number of spans to be sent in a single batch.
- ConnectTimeout float64
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- HeaderType string
- Headers map[string]string
- The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.
- HttpResponse stringHeader For Traceid 
- LogsEndpoint string
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- Propagation
GetGateway Plugin Opentelemetry Config Propagation 
- Queue
GetGateway Plugin Opentelemetry Config Queue 
- ReadTimeout float64
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- ResourceAttributes map[string]string
- SamplingRate float64
- Tracing sampling rate for configuring the probability-based sampler. When set, this value supersedes the global tracing_sampling_ratesetting from kong.conf.
- SendTimeout float64
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- TracesEndpoint string
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- batchFlush DoubleDelay 
- The delay, in seconds, between two consecutive batches.
- batchSpan DoubleCount 
- The number of spans to be sent in a single batch.
- connectTimeout Double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- headerType String
- headers Map<String,String>
- The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.
- httpResponse StringHeader For Traceid 
- logsEndpoint String
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- propagation
GetGateway Plugin Opentelemetry Config Propagation 
- queue
GetGateway Plugin Opentelemetry Config Queue 
- readTimeout Double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- resourceAttributes Map<String,String>
- samplingRate Double
- Tracing sampling rate for configuring the probability-based sampler. When set, this value supersedes the global tracing_sampling_ratesetting from kong.conf.
- sendTimeout Double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- tracesEndpoint String
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- batchFlush numberDelay 
- The delay, in seconds, between two consecutive batches.
- batchSpan numberCount 
- The number of spans to be sent in a single batch.
- connectTimeout number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- headerType string
- headers {[key: string]: string}
- The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.
- httpResponse stringHeader For Traceid 
- logsEndpoint string
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- propagation
GetGateway Plugin Opentelemetry Config Propagation 
- queue
GetGateway Plugin Opentelemetry Config Queue 
- readTimeout number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- resourceAttributes {[key: string]: string}
- samplingRate number
- Tracing sampling rate for configuring the probability-based sampler. When set, this value supersedes the global tracing_sampling_ratesetting from kong.conf.
- sendTimeout number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- tracesEndpoint string
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- batch_flush_ floatdelay 
- The delay, in seconds, between two consecutive batches.
- batch_span_ floatcount 
- The number of spans to be sent in a single batch.
- connect_timeout float
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- header_type str
- headers Mapping[str, str]
- The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.
- http_response_ strheader_ for_ traceid 
- logs_endpoint str
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- propagation
GetGateway Plugin Opentelemetry Config Propagation 
- queue
GetGateway Plugin Opentelemetry Config Queue 
- read_timeout float
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- resource_attributes Mapping[str, str]
- sampling_rate float
- Tracing sampling rate for configuring the probability-based sampler. When set, this value supersedes the global tracing_sampling_ratesetting from kong.conf.
- send_timeout float
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- traces_endpoint str
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- batchFlush NumberDelay 
- The delay, in seconds, between two consecutive batches.
- batchSpan NumberCount 
- The number of spans to be sent in a single batch.
- connectTimeout Number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- headerType String
- headers Map<String>
- The custom headers to be added in the HTTP request sent to the OTLP server. This setting is useful for adding the authentication headers (token) for the APM backend.
- httpResponse StringHeader For Traceid 
- logsEndpoint String
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- propagation Property Map
- queue Property Map
- readTimeout Number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- resourceAttributes Map<String>
- samplingRate Number
- Tracing sampling rate for configuring the probability-based sampler. When set, this value supersedes the global tracing_sampling_ratesetting from kong.conf.
- sendTimeout Number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- tracesEndpoint String
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
GetGatewayPluginOpentelemetryConfigPropagation     
- Clears List<string>
- Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.
- DefaultFormat string
- The default header format to use when extractors did not match any format in the incoming headers and injectis configured with the value:preserve. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included inextract.
- Extracts List<string>
- Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.
- Injects List<string>
- Header formats used to inject tracing context. The value preservewill use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.
- Clears []string
- Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.
- DefaultFormat string
- The default header format to use when extractors did not match any format in the incoming headers and injectis configured with the value:preserve. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included inextract.
- Extracts []string
- Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.
- Injects []string
- Header formats used to inject tracing context. The value preservewill use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.
- clears List<String>
- Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.
- defaultFormat String
- The default header format to use when extractors did not match any format in the incoming headers and injectis configured with the value:preserve. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included inextract.
- extracts List<String>
- Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.
- injects List<String>
- Header formats used to inject tracing context. The value preservewill use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.
- clears string[]
- Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.
- defaultFormat string
- The default header format to use when extractors did not match any format in the incoming headers and injectis configured with the value:preserve. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included inextract.
- extracts string[]
- Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.
- injects string[]
- Header formats used to inject tracing context. The value preservewill use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.
- clears Sequence[str]
- Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.
- default_format str
- The default header format to use when extractors did not match any format in the incoming headers and injectis configured with the value:preserve. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included inextract.
- extracts Sequence[str]
- Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.
- injects Sequence[str]
- Header formats used to inject tracing context. The value preservewill use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.
- clears List<String>
- Header names to clear after context extraction. This allows to extract the context from a certain header and then remove it from the request, useful when extraction and injection are performed on different header formats and the original header should not be sent to the upstream. If left empty, no headers are cleared.
- defaultFormat String
- The default header format to use when extractors did not match any format in the incoming headers and injectis configured with the value:preserve. This can happen when no tracing header was found in the request, or the incoming tracing header formats were not included inextract.
- extracts List<String>
- Header formats used to extract tracing context from incoming requests. If multiple values are specified, the first one found will be used for extraction. If left empty, Kong will not extract any tracing context information from incoming requests and generate a trace with no parent and a new trace ID.
- injects List<String>
- Header formats used to inject tracing context. The value preservewill use the same header format as the incoming request. If multiple values are specified, all of them will be used during injection. If left empty, Kong will not inject any tracing context information in outgoing requests.
GetGatewayPluginOpentelemetryConfigQueue     
- ConcurrencyLimit double
- The number of of queue delivery timers. -1 indicates unlimited.
- InitialRetry doubleDelay 
- Time in seconds before the initial retry is made for a failing batch.
- MaxBatch doubleSize 
- Maximum number of entries that can be processed at a time.
- MaxBytes double
- Maximum number of bytes that can be waiting on a queue, requires string content.
- MaxCoalescing doubleDelay 
- Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
- MaxEntries double
- Maximum number of entries that can be waiting on the queue.
- MaxRetry doubleDelay 
- Maximum time in seconds between retries, caps exponential backoff.
- MaxRetry doubleTime 
- Time in seconds before the queue gives up calling a failed handler for a batch.
- ConcurrencyLimit float64
- The number of of queue delivery timers. -1 indicates unlimited.
- InitialRetry float64Delay 
- Time in seconds before the initial retry is made for a failing batch.
- MaxBatch float64Size 
- Maximum number of entries that can be processed at a time.
- MaxBytes float64
- Maximum number of bytes that can be waiting on a queue, requires string content.
- MaxCoalescing float64Delay 
- Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
- MaxEntries float64
- Maximum number of entries that can be waiting on the queue.
- MaxRetry float64Delay 
- Maximum time in seconds between retries, caps exponential backoff.
- MaxRetry float64Time 
- Time in seconds before the queue gives up calling a failed handler for a batch.
- concurrencyLimit Double
- The number of of queue delivery timers. -1 indicates unlimited.
- initialRetry DoubleDelay 
- Time in seconds before the initial retry is made for a failing batch.
- maxBatch DoubleSize 
- Maximum number of entries that can be processed at a time.
- maxBytes Double
- Maximum number of bytes that can be waiting on a queue, requires string content.
- maxCoalescing DoubleDelay 
- Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
- maxEntries Double
- Maximum number of entries that can be waiting on the queue.
- maxRetry DoubleDelay 
- Maximum time in seconds between retries, caps exponential backoff.
- maxRetry DoubleTime 
- Time in seconds before the queue gives up calling a failed handler for a batch.
- concurrencyLimit number
- The number of of queue delivery timers. -1 indicates unlimited.
- initialRetry numberDelay 
- Time in seconds before the initial retry is made for a failing batch.
- maxBatch numberSize 
- Maximum number of entries that can be processed at a time.
- maxBytes number
- Maximum number of bytes that can be waiting on a queue, requires string content.
- maxCoalescing numberDelay 
- Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
- maxEntries number
- Maximum number of entries that can be waiting on the queue.
- maxRetry numberDelay 
- Maximum time in seconds between retries, caps exponential backoff.
- maxRetry numberTime 
- Time in seconds before the queue gives up calling a failed handler for a batch.
- concurrency_limit float
- The number of of queue delivery timers. -1 indicates unlimited.
- initial_retry_ floatdelay 
- Time in seconds before the initial retry is made for a failing batch.
- max_batch_ floatsize 
- Maximum number of entries that can be processed at a time.
- max_bytes float
- Maximum number of bytes that can be waiting on a queue, requires string content.
- max_coalescing_ floatdelay 
- Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
- max_entries float
- Maximum number of entries that can be waiting on the queue.
- max_retry_ floatdelay 
- Maximum time in seconds between retries, caps exponential backoff.
- max_retry_ floattime 
- Time in seconds before the queue gives up calling a failed handler for a batch.
- concurrencyLimit Number
- The number of of queue delivery timers. -1 indicates unlimited.
- initialRetry NumberDelay 
- Time in seconds before the initial retry is made for a failing batch.
- maxBatch NumberSize 
- Maximum number of entries that can be processed at a time.
- maxBytes Number
- Maximum number of bytes that can be waiting on a queue, requires string content.
- maxCoalescing NumberDelay 
- Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
- maxEntries Number
- Maximum number of entries that can be waiting on the queue.
- maxRetry NumberDelay 
- Maximum time in seconds between retries, caps exponential backoff.
- maxRetry NumberTime 
- Time in seconds before the queue gives up calling a failed handler for a batch.
GetGatewayPluginOpentelemetryConsumer    
- Id string
- Id string
- id String
- id string
- id str
- id String
GetGatewayPluginOpentelemetryOrdering    
GetGatewayPluginOpentelemetryOrderingAfter     
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GetGatewayPluginOpentelemetryOrderingBefore     
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GetGatewayPluginOpentelemetryRoute    
- Id string
- Id string
- id String
- id string
- id str
- id String
GetGatewayPluginOpentelemetryService    
- Id string
- Id string
- id String
- id string
- id str
- id String
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the konnectTerraform Provider.