config.io_helidon_tracing_providers_jaeger_JaegerTracerBuilder.adoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-docs
There is a newer version: 4.1.4
///////////////////////////////////////////////////////////////////////////////

    Copyright (c) 2023 Oracle and/or its affiliates.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

///////////////////////////////////////////////////////////////////////////////

ifndef::rootdir[:rootdir: {docdir}/..]
:description: Configuration of io.helidon.tracing.Tracer
:keywords: helidon, config, io.helidon.tracing.Tracer
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.tracing.Tracer
include::{rootdir}/includes/attributes.adoc[]

= Tracer (tracing) Configuration

// tag::config[]

Jaeger tracer configuration.


Type: link:{javadoc-base-url}/io.helidon.tracing/io/helidon/tracing/Tracer.html[io.helidon.tracing.Tracer]


This is a standalone configuration type, prefix from configuration root: `tracing`



== Configuration options



.Optional configuration options
[cols="3,3a,2,5a"]

|===
|key |type |default value |description

|`client-cert-pem` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Certificate of client in PEM format.
|`exporter-timeout` |Duration |`PT10S` |Timeout of exporter requests.
|`max-export-batch-size` |int |`512` |Maximum Export Batch Size of exporter requests.
|`max-queue-size` |int |`2048` |Maximum Queue Size of exporter requests.
|`private-key-pem` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Private key in PEM format.
|`propagation` |PropagationFormat[] (B3, B3_SINGLE, JAEGER, W3C) |`JAEGER` |Add propagation format to use.
|`sampler-param` |Number |`1` |The sampler parameter (number).
|`sampler-type` |SamplerType (CONSTANT, RATIO) |`CONSTANT` |Sampler type.

 See Sampler types.
|`schedule-delay` |Duration |`PT5S` |Schedule Delay of exporter requests.
|`span-processor-type` |SpanProcessorType (SIMPLE, BATCH) |`batch` |Span Processor type used.
|`trusted-cert-pem` |xref:{rootdir}/config/io_helidon_common_configurable_Resource.adoc[Resource] |{nbsp} |Trusted certificates in PEM format.

|===

// end::config[]