Skip to content

Commit b4784c8

Browse files
laurittrask
laurit
and
trask
authored
Update supported frameworks and suppressing instrumentation docs (#4818)
* Update supported frameworks and suppressing instrumentation docs * Update docs/suppressing-instrumentation.md Co-authored-by: Trask Stalnaker <[email protected]> Co-authored-by: Trask Stalnaker <[email protected]>
1 parent 01dec8a commit b4784c8

File tree

2 files changed

+28
-21
lines changed

2 files changed

+28
-21
lines changed

‎docs/supported-libraries.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ These are the supported libraries and frameworks:
2929
| [Apache Dubbo](https://github.com/apache/dubbo/) | 2.7+ (not including 3.x yet) |
3030
| [Apache HttpAsyncClient](https://hc.apache.org/index.html) | 4.1+ |
3131
| [Apache HttpClient](https://hc.apache.org/index.html) | 2.0+ |
32+
| [Apache Kafka](https://kafka.apache.org/20/javadoc/overview-summary.html) | 0.11+ |
33+
| [Apache MyFaces](https://myfaces.apache.org/) | 1.2+ (not including 3.x yet) |
3234
| [Apache RocketMQ](https://rocketmq.apache.org/) | 4.8+ |
35+
| [Apache Struts 2](https://github.com/apache/struts) | 2.3+ |
3336
| [Apache Tapestry](https://tapestry.apache.org/) | 5.4+ |
3437
| [Apache Wicket](https://wicket.apache.org/) | 8.0+ |
3538
| [Armeria](https://armeria.dev) | 1.3+ |
@@ -39,13 +42,17 @@ These are the supported libraries and frameworks:
3942
| [Cassandra Driver](https://github.com/datastax/java-driver) | 3.0+ |
4043
| [Couchbase Client](https://github.com/couchbase/couchbase-java-client) | 2.0+ and 3.1+ |
4144
| [Dropwizard Views](https://www.dropwizard.io/en/latest/manual/views.html) | 0.7+ |
45+
| [Eclipse Grizzly](https://javaee.github.io/grizzly/httpserverframework.html) | 2.0+ (disabled by default) |
46+
| [Eclipse Jersey](https://eclipse-ee4j.github.io/jersey/) | 2.0+ (not including 3.x yet) |
47+
| [Eclipse Jetty HTTP Client](https://www.eclipse.org/jetty/javadoc/jetty-9/org/eclipse/jetty/client/HttpClient.html) | 9.2+ (not including 10+ yet) |
48+
| [Eclipse Metro](https://projects.eclipse.org/projects/ee4j.metro) | 2.2+ (not including 3.x yet) |
49+
| [Eclipse Mojarra](https://projects.eclipse.org/projects/ee4j.mojarra) | 1.2+ (not including 3.x yet) |
4250
| [Elasticsearch API](https://www.elastic.co/guide/en/elasticsearch/client/java-api/current/index.html) | 5.0+ |
4351
| [Elasticsearch REST Client](https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/index.html) | 5.0+ |
4452
| [Finatra](https://github.com/twitter/finatra) | 2.9+ |
4553
| [Geode Client](https://geode.apache.org/) | 1.4+ |
4654
| [Google HTTP Client](https://github.com/googleapis/google-http-java-client) | 1.19+ |
4755
| [Grails](https://grails.org/) | 3.0+ |
48-
| [Grizzly](https://javaee.github.io/grizzly/httpserverframework.html) | 2.0+ (disabled by default) |
4956
| [gRPC](https://github.com/grpc/grpc-java) | 1.6+ |
5057
| [GWT](http://www.gwtproject.org/) | 2.0+ |
5158
| [Hibernate](https://github.com/hibernate/hibernate-orm) | 3.3+ |
@@ -58,20 +65,14 @@ These are the supported libraries and frameworks:
5865
| [Java Http Client](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/package-summary.html) | Java 11+ |
5966
| [JDBC](https://docs.oracle.com/en/java/javase/11/docs/api/java.sql/java/sql/package-summary.html) | Java 8+ |
6067
| [Jedis](https://github.com/xetorthio/jedis) | 1.4+ |
61-
| [Jersey](https://eclipse-ee4j.github.io/jersey/) | 2.0+ (not including 3.x yet) |
62-
| [Jetty HTTP Client](https://www.eclipse.org/jetty/javadoc/jetty-9/org/eclipse/jetty/client/HttpClient.html) | 9.2+ (not including 10+ yet) |
6368
| [JMS](https://javaee.github.io/javaee-spec/javadocs/javax/jms/package-summary.html) | 1.1+ |
6469
| [JSP](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/jsp/package-summary.html) | 2.3+ |
65-
| [Kafka](https://kafka.apache.org/20/javadoc/overview-summary.html) | 0.11+ |
6670
| [Kubernetes Client](https://github.com/kubernetes-client/java) | 7.0+ |
6771
| [Lettuce](https://github.com/lettuce-io/lettuce-core) | 4.0+ |
6872
| [Log4j 1](https://logging.apache.org/log4j/1.2/) | 1.2+ |
6973
| [Log4j 2](https://logging.apache.org/log4j/2.x/) | 2.7+ |
7074
| [Logback](http://logback.qos.ch/) | 1.0+ |
71-
| [Metro](https://projects.eclipse.org/projects/ee4j.metro) | 2.2+ (not including 3.x yet) |
72-
| [Mojarra](https://projects.eclipse.org/projects/ee4j.mojarra) | 1.2+ (not including 3.x yet) |
7375
| [MongoDB Driver](https://mongodb.github.io/mongo-java-driver/) | 3.1+ |
74-
| [MyFaces](https://myfaces.apache.org/) | 1.2+ (not including 3.x yet) |
7576
| [Netty](https://github.com/netty/netty) | 3.8+ |
7677
| [OkHttp](https://github.com/square/okhttp/) | 3.0+ |
7778
| [Play](https://github.com/playframework/playframework) | 2.4+ (not including 2.8.x yet) |
@@ -92,13 +93,12 @@ These are the supported libraries and frameworks:
9293
| [Spring Data](https://spring.io/projects/spring-data) | 1.8+ |
9394
| [Spring Integration](https://spring.io/projects/spring-integration) | 4.1+ |
9495
| [Spring Kafka](https://spring.io/projects/spring-kafka) | 2.7+ |
95-
| [Spring Rabbit](https://spring.io/projects/spring-amqp) | 1.0+ |
96+
| [Spring RabbitMQ](https://spring.io/projects/spring-amqp) | 1.0+ |
9697
| [Spring Scheduling](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/scheduling/package-summary.html) | 3.1+ |
9798
| [Spring Web MVC](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/servlet/mvc/package-summary.html) | 3.1+ |
9899
| [Spring Web Services](https://spring.io/projects/spring-ws) | 2.0+ |
99-
| [Spring Webflux](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/reactive/package-summary.html) | 5.0+ |
100+
| [Spring WebFlux](https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/reactive/package-summary.html) | 5.0+ |
100101
| [Spymemcached](https://github.com/couchbase/spymemcached) | 2.12+ |
101-
| [Struts2](https://github.com/apache/struts) | 2.3+ |
102102
| [Twilio](https://github.com/twilio/twilio-java) | 6.6+ (not including 8.x yet) |
103103
| [Undertow](https://undertow.io/) | 1.4+ |
104104
| [Vaadin](https://vaadin.com/) | 14.2+ |

‎docs/suppressing-instrumentation.md‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ corresponding instrumentation `name`:
2525
| Apache HttpAsyncClient | apache-httpasyncclient|
2626
| Apache HttpClient | apache-httpclient|
2727
| Apache Kafka | kafka |
28+
| Apache MyFaces | myfaces|
2829
| Apache RocketMQ | rocketmq-client|
30+
| Apache Struts 2 | struts|
2931
| Apache Tapestry | tapestry|
3032
| Apache Tomcat | tomcat|
3133
| Apache Wicket | wicket|
@@ -35,7 +37,14 @@ corresponding instrumentation `name`:
3537
| AWS SDK | aws-sdk|
3638
| Couchbase | couchbase|
3739
| Dropwizard Views | dropwizard-views |
40+
| Eclipse Grizzly | grizzly|
41+
| Eclipse Jersey | jersey|
42+
| Eclipse Jetty | jetty|
43+
| Eclipse Jetty HTTP Client | jetty-httpclient|
44+
| Eclipse Metro | metro|
45+
| Eclipse Mojarra | mojarra|
3846
| Eclipse OSGi | eclipse-osgi |
47+
| Eclipse Vert.x | vertx |
3948
| Elasticsearch client | elasticsearch-transport|
4049
| Elasticsearch REST client | elasticsearch-rest|
4150
| Google Guava | guava|
@@ -44,7 +53,6 @@ corresponding instrumentation `name`:
4453
| Grails | grails|
4554
| GRPC | grpc|
4655
| Hibernate | hibernate|
47-
| Java EE Grizzly | grizzly|
4856
| Java HTTP Client | java-http-client |
4957
| Java `HttpURLConnection` | http-url-connection |
5058
| Java JDBC | jdbc |
@@ -55,14 +63,9 @@ corresponding instrumentation `name`:
5563
| JAX-RS (Client) | jaxrs-client|
5664
| JAX-RS (Server) | jaxrs|
5765
| JAX-WS | jaxws|
58-
| JAX-WS Metro | metro|
59-
| Jetty | jetty|
6066
| JMS | jms|
61-
| JSF Mojarra | mojarra|
62-
| JSF MyFaces | myfaces|
6367
| JSP | jsp |
6468
| K8s Client | kubernetes-client|
65-
| Kotlin HTTP (kHttp) | khttp |
6669
| kotlinx.coroutines | kotlinx-coroutines |
6770
| Log4j | log4j|
6871
| Logback | logback|
@@ -72,9 +75,11 @@ corresponding instrumentation `name`:
7275
| OkHttp | okhttp|
7376
| OpenLiberty | liberty |
7477
| OpenTelemetry Trace annotations | opentelemetry-annotations |
78+
| OpenTelemetry API | opentelemetry-api |
7579
| OSHI (Operating System and Hardware Information) | oshi |
7680
| Play Framework | play|
7781
| Play WS HTTP Client | play-ws|
82+
| Quartz | quartz|
7883
| RabbitMQ Client | rabbitmq|
7984
| Ratpack | ratpack|
8085
| ReactiveX RxJava | rxjava2, rxjava3 |
@@ -85,20 +90,22 @@ corresponding instrumentation `name`:
8590
| Rediscala | rediscala|
8691
| Scala executors | scala-executors |
8792
| Spark Web Framework | spark|
93+
| Spring Batch | spring-batch|
8894
| Spring Core | spring-core|
8995
| Spring Data | spring-data|
9096
| Spring Integration | spring-integration|
97+
| Spring Kafka | spring-kafka|
98+
| Spring RabbitMQ | spring-rabbit|
9199
| Spring Scheduling | spring-scheduling|
92-
| Spring Webflux | spring-webflux|
93-
| Spring WebMVC | spring-webmvc|
94-
| Spring WS | spring-ws|
100+
| Spring Web | spring-web|
101+
| Spring WebFlux | spring-webflux|
102+
| Spring Web MVC | spring-webmvc|
103+
| Spring Web Services | spring-ws|
95104
| Spymemcached | spymemcached|
96-
| Struts | struts|
97105
| Twilio SDK | twilio|
98106
| Twitter Finatra | finatra|
99107
| Undertow | undertow|
100108
| Vaadin | vaadin|
101-
| Vert.x RxJava2 | vertx |
102109

103110
**Note:** When using environment variables, dashes (`-`) should be converted to
104111
underscores (`_`). For example, to suppress traces from `akka-actor` library, set

0 commit comments

Comments
 (0)