includes.tracing.tracer-zipkin.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) 2019, 2024 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}/../..]
:imagesdir: {rootdir}/images
:feature-name: Zipkin Tracing

Helidon is integrated with the Zipkin tracer.

The Zipkin builder is loaded through `ServiceLoader` and configured. You could
also use the Zipkin builder directly, though this would create a source-code dependency
on the Zipkin tracer.

include::{rootdir}/includes/dependencies.adoc[]

// tag::zipkin-dependency[]
[source,xml]
----

    io.helidon.tracing.providers
    helidon-tracing-providers-zipkin

----
// end::zipkin-dependency[]

// tag::zipkin-configuration[]

== Configuring Zipkin

include::{rootdir}/config/io_helidon_tracing_providers_zipkin_ZipkinTracerBuilder.adoc[tag=config,levelOffset=+1]

The following is an example of a Zipkin configuration, specified in the YAML format.
[source,yaml]
----
tracing:
  zipkin:
    service: "helidon-service"
    protocol: "https"
    host: "zipkin"
    port: 9987
    api-version: 1
    # this is the default path for API version 2
    path: "/api/v2/spans"
    tags:
      tag1: "tag1-value"
      tag2: "tag2-value"
    boolean-tags:
      tag3: true
      tag4: false
    int-tags:
      tag5: 145
      tag6: 741
----

Example of Zipkin trace:

image::webserver/zipkin.png[Zipkin example, align="center"]

// end::zipkin-configuration[]