konnect.GatewayPluginZipkin

Coming soon!

Coming soon!

Coming soon!

resource_name This property is required. str

The unique name of the resource.

args This property is required. GatewayPluginZipkinArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name This property is required. string

The unique name of the resource.

args This property is required. GatewayPluginZipkinArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name This property is required. string

The unique name of the resource.

args This property is required. GatewayPluginZipkinArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name This property is required. String

The unique name of the resource.

args This property is required. GatewayPluginZipkinArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

ControlPlaneId This property is required. string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Config GatewayPluginZipkinConfig

Consumer GatewayPluginZipkinConsumer

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.

CreatedAt double

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginZipkinId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginZipkinOrdering

Protocols List<string>

A set of strings representing protocols.

Route GatewayPluginZipkinRoute

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.

Service GatewayPluginZipkinService

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.

Tags List<string>

An optional set of strings associated with the Plugin for grouping and filtering.

UpdatedAt double

Unix epoch when the resource was last updated.

ControlPlaneId This property is required. string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Config GatewayPluginZipkinConfigArgs

Consumer GatewayPluginZipkinConsumerArgs

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.

CreatedAt float64

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginZipkinId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginZipkinOrderingArgs

Protocols []string

A set of strings representing protocols.

Route GatewayPluginZipkinRouteArgs

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.

Service GatewayPluginZipkinServiceArgs

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.

Tags []string

An optional set of strings associated with the Plugin for grouping and filtering.

UpdatedAt float64

Unix epoch when the resource was last updated.

controlPlaneId This property is required. String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

config GatewayPluginZipkinConfig

consumer GatewayPluginZipkinConsumer

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.

createdAt Double

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginZipkinId String

The ID of this resource.

instanceName String

ordering GatewayPluginZipkinOrdering

protocols List<String>

A set of strings representing protocols.

route GatewayPluginZipkinRoute

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.

service GatewayPluginZipkinService

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.

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

updatedAt Double

Unix epoch when the resource was last updated.

control_plane_id This property is required. str

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

config GatewayPluginZipkinConfigArgs

consumer GatewayPluginZipkinConsumerArgs

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.

created_at float

Unix epoch when the resource was created.

enabled bool

Whether the plugin is applied.

gateway_plugin_zipkin_id str

The ID of this resource.

instance_name str

ordering GatewayPluginZipkinOrderingArgs

protocols Sequence[str]

A set of strings representing protocols.

route GatewayPluginZipkinRouteArgs

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.

service GatewayPluginZipkinServiceArgs

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.

tags Sequence[str]

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at float

Unix epoch when the resource was last updated.

controlPlaneId This property is required. String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

config Property Map

consumer Property Map

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.

createdAt Number

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginZipkinId String

The ID of this resource.

instanceName String

ordering Property Map

protocols List<String>

A set of strings representing protocols.

route Property Map

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.

service Property Map

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.

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

updatedAt Number

Unix epoch when the resource was last updated.

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

resource_name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "ignore", "jaeger", "ot", "preserve", "w3c"]

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. must be one of ["method", "method_path"]

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. must be one of ["annotations", "tags"]

Propagation GatewayPluginZipkinConfigPropagation

Queue GatewayPluginZipkinConfigQueue

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<GatewayPluginZipkinConfigStaticTag>

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. must be one of ["8", "16"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "ignore", "jaeger", "ot", "preserve", "w3c"]

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. must be one of ["method", "method_path"]

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. must be one of ["annotations", "tags"]

Propagation GatewayPluginZipkinConfigPropagation

Queue GatewayPluginZipkinConfigQueue

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 []GatewayPluginZipkinConfigStaticTag

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. must be one of ["8", "16"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "ignore", "jaeger", "ot", "preserve", "w3c"]

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. must be one of ["method", "method_path"]

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. must be one of ["annotations", "tags"]

propagation GatewayPluginZipkinConfigPropagation

queue GatewayPluginZipkinConfigQueue

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<GatewayPluginZipkinConfigStaticTag>

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. must be one of ["8", "16"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "ignore", "jaeger", "ot", "preserve", "w3c"]

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. must be one of ["method", "method_path"]

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. must be one of ["annotations", "tags"]

propagation GatewayPluginZipkinConfigPropagation

queue GatewayPluginZipkinConfigQueue

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[GatewayPluginZipkinConfigStaticTag]

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. must be one of ["8", "16"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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. must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "ignore", "jaeger", "ot", "preserve", "w3c"]

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. must be one of ["method", "method_path"]

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. must be one of ["annotations", "tags"]

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. must be one of ["8", "16"]

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. Not Null; must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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. Not Null; must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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. Not Null; must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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 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. Not Null; must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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. Not Null; must be one of ["aws", "b3", "b3-single", "datadog", "gcp", "jaeger", "ot", "w3c"]

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.

ConcurrencyLimit double

The number of of queue delivery timers. -1 indicates unlimited. must be one of ["-1", "1"]

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. must be one of ["-1", "1"]

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. must be one of ["-1", "1"]

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.