Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginZipkin
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.getGatewayPluginZipkin

Explore with Pulumi AI

konnect logo
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

    Using getGatewayPluginZipkin

    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 getGatewayPluginZipkin(args: GetGatewayPluginZipkinArgs, opts?: InvokeOptions): Promise<GetGatewayPluginZipkinResult>
function getGatewayPluginZipkinOutput(args: GetGatewayPluginZipkinOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginZipkinResult>
    def get_gateway_plugin_zipkin(control_plane_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetGatewayPluginZipkinResult
def get_gateway_plugin_zipkin_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginZipkinResult]
    func LookupGatewayPluginZipkin(ctx *Context, args *LookupGatewayPluginZipkinArgs, opts ...InvokeOption) (*LookupGatewayPluginZipkinResult, error)
func LookupGatewayPluginZipkinOutput(ctx *Context, args *LookupGatewayPluginZipkinOutputArgs, opts ...InvokeOption) LookupGatewayPluginZipkinResultOutput

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

    public static class GetGatewayPluginZipkin 
{
    public static Task<GetGatewayPluginZipkinResult> InvokeAsync(GetGatewayPluginZipkinArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginZipkinResult> Invoke(GetGatewayPluginZipkinInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayPluginZipkinResult> getGatewayPluginZipkin(GetGatewayPluginZipkinArgs args, InvokeOptions options)
public static Output<GetGatewayPluginZipkinResult> getGatewayPluginZipkin(GetGatewayPluginZipkinArgs args, InvokeOptions options)

    fn::invoke:
  function: konnect:index/getGatewayPluginZipkin:getGatewayPluginZipkin
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getGatewayPluginZipkin Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginZipkinConfig

    ConnectTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    DefaultHeaderType string
    Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.
    DefaultServiceName string
    Set a default service name to override unknown-service-name in the Zipkin spans.
    HeaderType string
    All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests
    HttpEndpoint string
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    HttpResponseHeaderForTraceid string
    HttpSpanName string
    Specify whether to include the HTTP path in the span name.
    IncludeCredential bool
    Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
    LocalServiceName string
    The name of the service as displayed in Zipkin.
    PhaseDurationFlavor string
    Specify whether to include the duration of each phase as an annotation or a tag.
    Propagation GetGatewayPluginZipkinConfigPropagation
    Queue GetGatewayPluginZipkinConfigQueue
    ReadTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SampleRatio double
    How often to sample requests that do not contain trace IDs. Set to 0 to turn sampling off, or to 1 to sample all requests.
    SendTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    StaticTags List<GetGatewayPluginZipkinConfigStaticTag>
    The tags specified on this property will be added to the generated request traces.
    TagsHeader string
    The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.
    TraceidByteCount double
    The length in bytes of each request's Trace ID.
    ConnectTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    DefaultHeaderType string
    Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.
    DefaultServiceName string
    Set a default service name to override unknown-service-name in the Zipkin spans.
    HeaderType string
    All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests
    HttpEndpoint string
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    HttpResponseHeaderForTraceid string
    HttpSpanName string
    Specify whether to include the HTTP path in the span name.
    IncludeCredential bool
    Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
    LocalServiceName string
    The name of the service as displayed in Zipkin.
    PhaseDurationFlavor string
    Specify whether to include the duration of each phase as an annotation or a tag.
    Propagation GetGatewayPluginZipkinConfigPropagation
    Queue GetGatewayPluginZipkinConfigQueue
    ReadTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SampleRatio float64
    How often to sample requests that do not contain trace IDs. Set to 0 to turn sampling off, or to 1 to sample all requests.
    SendTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    StaticTags []GetGatewayPluginZipkinConfigStaticTag
    The tags specified on this property will be added to the generated request traces.
    TagsHeader string
    The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.
    TraceidByteCount float64
    The length in bytes of each request's Trace ID.
    connectTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    defaultHeaderType String
    Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.
    defaultServiceName String
    Set a default service name to override unknown-service-name in the Zipkin spans.
    headerType String
    All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests
    httpEndpoint String
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    httpResponseHeaderForTraceid String
    httpSpanName String
    Specify whether to include the HTTP path in the span name.
    includeCredential Boolean
    Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
    localServiceName String
    The name of the service as displayed in Zipkin.
    phaseDurationFlavor String
    Specify whether to include the duration of each phase as an annotation or a tag.
    propagation GetGatewayPluginZipkinConfigPropagation
    queue GetGatewayPluginZipkinConfigQueue
    readTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sampleRatio Double
    How often to sample requests that do not contain trace IDs. Set to 0 to turn sampling off, or to 1 to sample all requests.
    sendTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    staticTags List<GetGatewayPluginZipkinConfigStaticTag>
    The tags specified on this property will be added to the generated request traces.
    tagsHeader String
    The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.
    traceidByteCount Double
    The length in bytes of each request's Trace ID.
    connectTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    defaultHeaderType string
    Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.
    defaultServiceName string
    Set a default service name to override unknown-service-name in the Zipkin spans.
    headerType string
    All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests
    httpEndpoint string
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    httpResponseHeaderForTraceid string
    httpSpanName string
    Specify whether to include the HTTP path in the span name.
    includeCredential boolean
    Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
    localServiceName string
    The name of the service as displayed in Zipkin.
    phaseDurationFlavor string
    Specify whether to include the duration of each phase as an annotation or a tag.
    propagation GetGatewayPluginZipkinConfigPropagation
    queue GetGatewayPluginZipkinConfigQueue
    readTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sampleRatio number
    How often to sample requests that do not contain trace IDs. Set to 0 to turn sampling off, or to 1 to sample all requests.
    sendTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    staticTags GetGatewayPluginZipkinConfigStaticTag[]
    The tags specified on this property will be added to the generated request traces.
    tagsHeader string
    The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.
    traceidByteCount number
    The length in bytes of each request's Trace ID.
    connect_timeout float
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    default_header_type str
    Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.
    default_service_name str
    Set a default service name to override unknown-service-name in the Zipkin spans.
    header_type str
    All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests
    http_endpoint str
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    http_response_header_for_traceid str
    http_span_name str
    Specify whether to include the HTTP path in the span name.
    include_credential bool
    Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
    local_service_name str
    The name of the service as displayed in Zipkin.
    phase_duration_flavor str
    Specify whether to include the duration of each phase as an annotation or a tag.
    propagation GetGatewayPluginZipkinConfigPropagation
    queue GetGatewayPluginZipkinConfigQueue
    read_timeout float
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sample_ratio float
    How often to sample requests that do not contain trace IDs. Set to 0 to turn sampling off, or to 1 to sample all requests.
    send_timeout float
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    static_tags Sequence[GetGatewayPluginZipkinConfigStaticTag]
    The tags specified on this property will be added to the generated request traces.
    tags_header str
    The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.
    traceid_byte_count float
    The length in bytes of each request's Trace ID.
    connectTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    defaultHeaderType String
    Allows specifying the type of header to be added to requests with no pre-existing tracing headers and when config.header_type is set to "preserve". When header_type is set to any other value, default_header_type is ignored.
    defaultServiceName String
    Set a default service name to override unknown-service-name in the Zipkin spans.
    headerType String
    All HTTP requests going through the plugin are tagged with a tracing HTTP request. This property codifies what kind of tracing header the plugin expects on incoming requests
    httpEndpoint String
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    httpResponseHeaderForTraceid String
    httpSpanName String
    Specify whether to include the HTTP path in the span name.
    includeCredential Boolean
    Specify whether the credential of the currently authenticated consumer should be included in metadata sent to the Zipkin server.
    localServiceName String
    The name of the service as displayed in Zipkin.
    phaseDurationFlavor String
    Specify whether to include the duration of each phase as an annotation or a tag.
    propagation Property Map
    queue Property Map
    readTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sampleRatio Number
    How often to sample requests that do not contain trace IDs. Set to 0 to turn sampling off, or to 1 to sample all requests.
    sendTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    staticTags List<Property Map>
    The tags specified on this property will be added to the generated request traces.
    tagsHeader String
    The Zipkin plugin will add extra headers to the tags associated with any HTTP requests that come with a header named as configured by this property.
    traceidByteCount Number
    The length in bytes of each request's Trace ID.

    GetGatewayPluginZipkinConfigPropagation

    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 inject is 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 in extract.
    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 preserve will 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 inject is 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 in extract.
    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 preserve will 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 inject is 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 in extract.
    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 preserve will 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 inject is 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 in extract.
    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 preserve will 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 inject is 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 in extract.
    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 preserve will 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 inject is 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 in extract.
    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 preserve will 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.

    GetGatewayPluginZipkinConfigQueue

    ConcurrencyLimit double
    The number of of queue delivery timers. -1 indicates unlimited.
    InitialRetryDelay double
    Time in seconds before the initial retry is made for a failing batch.
    MaxBatchSize double
    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.
    MaxCoalescingDelay double
    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.
    MaxRetryDelay double
    Maximum time in seconds between retries, caps exponential backoff.
    MaxRetryTime double
    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.
    InitialRetryDelay float64
    Time in seconds before the initial retry is made for a failing batch.
    MaxBatchSize float64
    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.
    MaxCoalescingDelay float64
    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.
    MaxRetryDelay float64
    Maximum time in seconds between retries, caps exponential backoff.
    MaxRetryTime float64
    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.
    initialRetryDelay Double
    Time in seconds before the initial retry is made for a failing batch.
    maxBatchSize Double
    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.
    maxCoalescingDelay Double
    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.
    maxRetryDelay Double
    Maximum time in seconds between retries, caps exponential backoff.
    maxRetryTime Double
    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.
    initialRetryDelay number
    Time in seconds before the initial retry is made for a failing batch.
    maxBatchSize number
    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.
    maxCoalescingDelay number
    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.
    maxRetryDelay number
    Maximum time in seconds between retries, caps exponential backoff.
    maxRetryTime number
    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_delay float
    Time in seconds before the initial retry is made for a failing batch.
    max_batch_size float
    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_delay float
    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_delay float
    Maximum time in seconds between retries, caps exponential backoff.
    max_retry_time float
    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.
    initialRetryDelay Number
    Time in seconds before the initial retry is made for a failing batch.
    maxBatchSize Number
    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.
    maxCoalescingDelay Number
    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.
    maxRetryDelay Number
    Maximum time in seconds between retries, caps exponential backoff.
    maxRetryTime Number
    Time in seconds before the queue gives up calling a failed handler for a batch.

    GetGatewayPluginZipkinConfigStaticTag

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    GetGatewayPluginZipkinConsumer

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginZipkinOrdering

    GetGatewayPluginZipkinOrderingAfter

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginZipkinOrderingBefore

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginZipkinRoute

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginZipkinService

    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 konnect Terraform Provider.
    konnect logo
    konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
    kong/terraform-provider-konnect