Fix out-of-sync suppressing-instrumentation.md
ADD
buildscripts/check-suppressing-instrumentation-docs.sh
+#!/usr/bin/env bash
+
+# this script reports some false positives, but is helpful in comparing the keys listed
+# in suppressing-instrumentation.md with the keys listed in the source files
+
+set -e -u -o pipefail
+
+comm -3 \
+ <(
+ sed -n '/----------------------/,${p;/^$/q}' \
+ docs/suppressing-instrumentation.md \
+ | sed '1d;$d' \
+ | cut -d '|' -f 3 \
+ | tr -d ' ' \
+ | sort -u
+ ) \
+ <(
+ git ls-files '*Module.java' \
+ | xargs grep super \
+ | grep -oP '(?<=super\(")[^"]+' \
+ | sort -u
+ )

MODIFY
docs/suppressing-instrumentation.md
docs/suppressing-instrumentation.md
@@ -11,7 +11,7 @@ variable `OTEL_INSTRUMENTATION_[NAME]_ENABLED`) where `name` (`NAME`) is the
corresponding instrumentation `name`:
| Library/Framework | Instrumentation name |
-|-------------------|----------------------|
+|--------------------------------------------------|---------------------------|
| Additional methods tracing | methods |
| Additional tracing annotations | external-annotations |
| Akka Actor | akka-actor |
@@ -43,7 +43,6 @@ corresponding instrumentation `name`:
| Eclipse Jetty HTTP Client | jetty-httpclient |
| Eclipse Metro | metro |
| Eclipse Mojarra | mojarra |
-| Eclipse OSGi | eclipse-osgi |
| Eclipse Vert.x | vertx |
| Elasticsearch client | elasticsearch-transport |
| Elasticsearch REST client | elasticsearch-rest |
@@ -60,6 +59,7 @@ corresponding instrumentation `name`:
| Java RMI | rmi |
| Java Servlet | servlet |
| java.util.concurrent | executor |
+| java.util.logging | java-util-logging |
| JAX-RS (Client) | jaxrs-client |
| JAX-RS (Server) | jaxrs |
| JAX-WS | jaxws |
@@ -67,8 +67,12 @@ corresponding instrumentation `name`:
| JSP | jsp |
| K8s Client | kubernetes-client |
| kotlinx.coroutines | kotlinx-coroutines |
-| Log4j | log4j|
-| Logback | logback|
+| Log4j Appender | log4j-appender |
+| Log4j MDC (1.x) | log4j-mdc |
+| Log4j Context Data (2.x) | log4j-context-data |
+| Logback Appender | logback-appender |
+| Logback MDC | logback-mdc |
+| Micrometer | micrometer |
| MongoDB | mongo |
| Netflix Hystrix | hystrix |
| Netty | netty |
@@ -88,6 +92,8 @@ corresponding instrumentation `name`:
| Redis Jedis | jedis |
| Redis Lettuce | lettuce |
| Rediscala | rediscala |
+| Redisson | redisson |
+| Restlet | restlet |
| Scala ForkJoinPool | scala-fork-join |
| Spark Web Framework | spark |
| Spring Batch | spring-batch |
@@ -96,6 +102,7 @@ corresponding instrumentation `name`:
| Spring Integration | spring-integration |
| Spring Kafka | spring-kafka |
| Spring RabbitMQ | spring-rabbit |
+| Spring RMI | spring-rmi |
| Spring Scheduling | spring-scheduling |
| Spring Web | spring-web |
| Spring WebFlux | spring-webflux |

Fix out-of-sync suppressing-instrumentation.md (#5472)