From 945aa0e3796cf681fbafc3bae9b4992f3d61fa43 Mon Sep 17 00:00:00 2001 From: Anas KHABALI Date: Wed, 12 Sep 2018 13:44:02 +0100 Subject: [PATCH 1/2] add a full configuraiton file for geronimo opentracing --- .../src/main/jbake/content/opentracing.adoc | 103 ++++++++++++++++++ 1 file changed, 103 insertions(+) diff --git a/geronimo-microprofile-site/src/main/jbake/content/opentracing.adoc b/geronimo-microprofile-site/src/main/jbake/content/opentracing.adoc index c9c4801..859bdcf 100644 --- a/geronimo-microprofile-site/src/main/jbake/content/opentracing.adoc +++ b/geronimo-microprofile-site/src/main/jbake/content/opentracing.adoc @@ -59,3 +59,106 @@ It provides a way to track JAX-RS calls (client and server) in a distributed sys 1.0.1 ---- + +== Full configuration file +The configuration file `opentracing.properties` should be placed in `META-INF/geronimo/microprofile/` folder + +[source,properties] +---- +# Should OpenTracing be activated +# Default true +geronimo.opentracing.filter.active=true + +# Urls for which the tracking should be activated automatically. +# The urls are actually the requets uri minus the context path. +#geronimo.opentracing.filter.forcedTracing.urls= + +# Urls for which the tracking should be skipped. +#geronimo.opentracing.filter.skippedTracing.urls= + +# Type of matcher for the url. +# Default is prefix which means a startsWith is used on the url but you can also use regex which compiles the url as a Pattern prefix +geronimo.opentracing.filter.skippedTracing.matcherType=prefix + +# Type of matcher for the url, +# Default is prefix which means a startsWith is used on the url but you can also use regex which compiles the url as a Pattern prefix +geronimo.opentracing.filter.forcedTracing.matcherType=prefix + +# Should HTTP_METHOD, HTTP_URL not be added to tags. +# Default false +geronimo.opentracing.filter.forcedTracing.skipDefaultTags=false + +# Should server instrumentation be ignored. +# Default false +#geronimo.opentracing.server.filter.request.skip._= + +# Should server instrumentation be ignored (if previous is not set). +# Default false +geronimo.opentracing.server.filter.request.skip=false + +# Should HTTP_METHOD, HTTP_URL not be added to tags. +# Default false +geronimo.opentracing.server.filter.request.skipDefaultTags=false + +# Should the operationName use the @Path annotations instead of class names. +# Default false +geronimo.opentracing.server.filter.request.operationName.usePath=false + +# Should client instrumentation be ignored. +# Default false +geronimo.opentracing.client.filter.request.skip=false + +# Should HTTP_METHOD, HTTP_URL not be added to tags. +# Default false +geronimo.opentracing.client.filter.request.skipDefaultTags=false + +# Should PEER_HOSTNAME, PEER_PORT not be added to tags. +# Default false +geronimo.opentracing.client.filter.request.skipPeerTags=false + +# Name of the header used to host the parent spanId value +# X-B3-ParentSpanId +geronimo.opentracing.propagation.headers.parentSpanId=X-B3-ParentSpanId + +# Name of the header used to host the spanId value +# X-B3-SpanId +geronimo.opentracing.propagation.headers.spanId=X-B3-SpanId + +# Name of the header used to host the traceId value +# X-B3-TraceId +geronimo.opentracing.propagation.headers.traceId=X-B3-TraceId + +# Prefix of headers used to host the baggage values baggage +#geronimo.opentracing.propagation.headers.baggagePrefix= + +# Name (as CDI names of the beans) of executor services which will get an interceptor propagating the current scope (span) +#geronimo.opentracing.cdi.executorServices.wrappedNames= + +# counter (to generate longs), uuid (to generate random uuids) or hex (to use the hexa representation of the uuid generator). +# Specifies which kind of trace and span id are in use. +# Default counter +geronimo.opentracing.id.generator=counter + +# For hex generator, a prefix to prepend to all ids +#geronimo.opentracing.id.generator.hex.prefix= + +# Should spans converted to a zipkin representation. +# True until there is a standard opentracing format. +# Default true +geronimo.opentracing.span.converter.zipkin.active=true + +# The local serviceName. +# Default hostname-jvmid +#geronimo.opentracing.span.converter.zipkin.serviceName= + +# Should a logger named org.apache.geronimo.opentracing.zipkin log each span as a Zipkin JSON. +# This allows to use a logger implementation to push the spans to any backend (like log4j2 kafka appender). +# It uses JUL as a facade. +# Default true +geronimo.opentracing.span.converter.zipkin.logger.active=true + +# Should zipkin JSON be logged wrapped in a list. +# Default true +geronimo.opentracing.span.converter.zipkin.logger.wrapAsList=true +---- + From d340933d8ae6b74785ff296fe72d2c49b6eb2e75 Mon Sep 17 00:00:00 2001 From: Anas KHABALI Date: Wed, 12 Sep 2018 13:56:33 +0100 Subject: [PATCH 2/2] add a description to the configuraiton file --- .../src/main/jbake/content/opentracing.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/geronimo-microprofile-site/src/main/jbake/content/opentracing.adoc b/geronimo-microprofile-site/src/main/jbake/content/opentracing.adoc index 859bdcf..e56f263 100644 --- a/geronimo-microprofile-site/src/main/jbake/content/opentracing.adoc +++ b/geronimo-microprofile-site/src/main/jbake/content/opentracing.adoc @@ -61,7 +61,8 @@ It provides a way to track JAX-RS calls (client and server) in a distributed sys ---- == Full configuration file -The configuration file `opentracing.properties` should be placed in `META-INF/geronimo/microprofile/` folder + +This is a full configuration file example for geronimo opentracing impl [source,properties] ---- @@ -161,4 +162,3 @@ geronimo.opentracing.span.converter.zipkin.logger.active=true # Default true geronimo.opentracing.span.converter.zipkin.logger.wrapAsList=true ---- -