config.io_helidon_webserver_observe_tracing_TracingObserver.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.webserver.observe.tracing.TracingObserver
:keywords: helidon, config, io.helidon.webserver.observe.tracing.TracingObserver
:basic-table-intro: The table below lists the configuration keys that configure io.helidon.webserver.observe.tracing.TracingObserver
include::{rootdir}/includes/attributes.adoc[]

= TracingObserver (webserver.observe.tracing) Configuration

// tag::config[]


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



This type provides the following service implementations:

- `io.helidon.webserver.observe.spi.ObserveProvider`


== Configuration options



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

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

|`env-config` |TracingConfig |`TracingConfig.ENABLED` |Use the provided configuration as a default for any request.

 @return default web server tracing configuration
|`path-configs` |PathTracingConfig[] |`new @java.util.ArrayList@(@[email protected](PathTracingConfig.builder()
                                  .path("/metrics/*")
                                  .tracingConfig(TracingConfig.DISABLED)
                                  .build(),                                   PathTracingConfig.builder()
                                  .path("/health/*")
                                  .tracingConfig(TracingConfig.DISABLED)
                                  .build(),                                  PathTracingConfig.builder()
                                  .path("/openapi/*")
                                  .tracingConfig(TracingConfig.DISABLED)
                                  .build()))` |Path specific configuration of tracing.

 @return configuration of tracing for specific paths
|`weight` |double |`900.0` |Weight of the feature registered with WebServer.
 Changing weight may cause tracing to be executed at a different time (such as after security, or even after
 all routes). Please understand feature weights before changing this order.

 @return weight of tracing feature

|===

// end::config[]