> For the complete documentation index, see [llms.txt](https://pinpoint-apm.gitbook.io/pinpoint/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pinpoint-apm.gitbook.io/pinpoint/v2.3.1/main.md). # What's New ## What's New in v2.3.1 ### Notice We have moved our documentation to Gitbook. \
### Experimental Features How to enable the experimental function ![8c272f00-4175-11ec-8c2b-488815d51670](https://user-images.githubusercontent.com/10057874/141051187-7cb6fba8-c28e-4d24-aa27-c96630c1065e.gif)
#### ServerMap realtime mode (#6980) ![servermap](https://user-images.githubusercontent.com/10057874/141051235-e31c3221-568c-4ac3-b0f8-26744ee17257.gif)
#### Scatter chart heatmap mode (#8218) with data sampling, better memory usage, better performance, and more intuitive visualization ![heatmap](https://user-images.githubusercontent.com/10057874/141051277-0571fcc5-54ff-4c4f-a5d8-9bcbab506126.png) \
### Key Features #### New Timeline (#7664) To provide more features via appling perfetto(). ![timeline](https://user-images.githubusercontent.com/10057874/141051729-a8483a09-3dae-4bc0-8a14-b4dffbde63d3.jpeg)
#### Support webhook menus (#8132) Please refer to pinpoint [gitbook](https://pinpoint-apm.gitbook.io/pinpoint/documents/alarm) ![webhook2](https://user-images.githubusercontent.com/10057874/141051986-102d90cd-a6f3-4f3f-863b-757e4b0d59fb.gif)
#### Support percent sampler (#6617) (Thank you @yjqg6666 for your contribution) * pinpoint.config ``` # support 2 types, COUNTING(default) and PERCENT. # If this value set to COUNTING(default), sampling rate is 1/n. # If this value set to PERCENT, sampling rate is n%. profiler.sampling.type=PERCENT # if it's PERCENT, then first x transactions out of y transactions will be sampled. # Support from 100% to 0.01% # eg. 100: 100% 50: 50% 0.01: 0.01% profiler.sampling.percent.sampling-rate=100 ```
#### Support TLS (#8128) Support TLS Connection for agent and collector
#### Add user proxy plugin(#8122) ![user-proxy](https://user-images.githubusercontent.com/10057874/141052463-adb9b129-2571-4185-9730-d3b99d3304b0.png) \
### Release Notes #### Plugins * [Plugins issues](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+is%3Aclosed+label%3Amodule%3Aplugin+milestone%3A2.3.1) #### Enhancements * [Agent](https://github.com/naver/pinpoint/issues?q=is%3Aissue+label%3Aenhancement+milestone%3A2.3.1+is%3Aclosed+label%3Amodule%3Aagent) * [Plugin](https://github.com/naver/pinpoint/issues?q=is%3Aissue+label%3Aenhancement+milestone%3A2.3.1+is%3Aclosed+label%3Amodule%3Aplugin) * [Collector](https://github.com/naver/pinpoint/issues?q=is%3Aissue+label%3Aenhancement+milestone%3A2.3.1+is%3Aclosed+label%3Amodule%3Acollector) * [Web](https://github.com/naver/pinpoint/issues?q=is%3Aissue+label%3Aenhancement+milestone%3A2.3.1+is%3Aclosed+label%3Amodule%3Aweb) * [Batch](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Aenhancement+label%3Amodule%3Abatch) * [Flink](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Aenhancement+label%3Amodule%3Aflink) * [Common](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Aenhancement+label%3Amodule%3Aproject-common) * [Test](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Aenhancement+label%3Amodule%3Atest) #### Bugs * [Agent](https://github.com/naver/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Abug+label%3Amodule%3Aagent) * [Plugin](https://github.com/naver/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Abug+label%3Amodule%3Aplugin) * [Collector](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Abug+label%3Amodule%3Acollector) * [Web](https://github.com/naver/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+label%3Abug+is%3Aclosed+label%3Amodule%3Aweb) * [Test](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Abug+label%3Amodule%3Atest) #### Configuration * [Agent](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Aconfiguration+label%3Amodule%3Aagent) * [Collector](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Aconfiguration+label%3Amodule%3Acollector) * [Web](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Aconfiguration+label%3Amodule%3Aweb) * [Common](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Aconfiguration+label%3Amodule%3Aproject-common) #### Cleanup * [Agent](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Acleanup+label%3Amodule%3Aagent) #### Dependency * [All](https://github.com/pinpoint-apm/pinpoint/issues?q=is%3Aissue+milestone%3A2.3.1+is%3Aclosed+label%3Adependencies) \
### Notice for Downloadfile pinpoint-hbase2-collector-boot-2.3.1-p1.jar in download file is the version with the a887052e6599657ed93fdd8932a5e16056fa82ff feature. \
### Thank You to whom provided or suggested valuable features whom fixed or reported bugs whom showed interest in Pinpoint and shared it to others. Thank you all. If there is someone who was inadvertently excluded, please let me know. @aalinyu @Duytq7 @mariusssi @yjqg6666 ### Upgrade consideration HBase compatibility table: | Pinpoint Version | HBase 1.0.x | HBase 1.2.x | HBase 1.4.x | HBase 2.0.x | | ---------------- | ----------- | ----------- | ----------- | --------------------------------------------------------------------------------------------------------------------- | | 1.7.x | not tested | yes | yes | no | | 1.8.x | not tested | yes | yes | no | | 2.0.x | not tested | yes | yes | [optional](https://pinpoint-apm.gitbook.io/pinpoint/documents/hbase-upgrade#do-you-like-to-use-hbase-2x-for-pinpoint) | | 2.1.x | not tested | yes | yes | [optional](https://pinpoint-apm.gitbook.io/pinpoint/documents/hbase-upgrade#do-you-like-to-use-hbase-2x-for-pinpoint) | | 2.2.x | not tested | yes | yes | [optional](https://pinpoint-apm.gitbook.io/pinpoint/documents/hbase-upgrade#do-you-like-to-use-hbase-2x-for-pinpoint) | | 2.3.x | not tested | yes | yes | [hbase2-module](https://github.com/pinpoint-apm/pinpoint/tree/master/hbase2-module) | Agent compatibility to Collector table: | Agent Version | Collector 1.7.x | Collector 1.8.x | Collector 2.0.x | Collector 2.1.x | Collector 2.2.x | Collector 2.3.x | | ------------- | --------------- | --------------- | --------------- | --------------- | --------------- | --------------- | | 1.7.x | yes | yes | yes | yes | yes | yes | | 1.8.x | no | yes | yes | yes | yes | yes | | 2.0.x | no | no | yes | yes | yes | yes | | 2.1.x | no | no | no | yes | yes | yes | | 2.2.x | no | no | no | no | yes | yes | | 2.3.x | no | no | no | no | no | yes | Additionally, the required Java version to run each Pinpoint component is given below: | Pinpoint Version | Agent | Collector | Web | | ---------------- | ----- | --------- | --- | | 1.7.x | 6-8 | 8 | 8 | | 1.8.0 | 6-10 | 8 | 8 | | 1.8.1+ | 6-11 | 8 | 8 | | 2.0.x | 6-13 | 8 | 8 | | 2.1.x | 6-14 | 8 | 8 | | 2.2.x | 7-14 | 8 | 8 | | 2.3.x | 7-17 | 8 | 8 | ### Supported Modules * JDK 6+ * Supported versions of the \* indicated library may differ from the actual version. | Title | Instrumented Library | Min | Max | Comment | | | ------------------------------------------------------------------------------------------------- | ------------------------------------ | -------- | --------- | ------- | - | | [Tomcat](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/tomcat) | | 6.x | 9.x | | | | [Jetty](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/jetty) | | 8.x | 9.x | | | | [JBoss](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/jboss) | | 6.x | 7.x | | | | [Resin](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/resin) | | 4.x | 4.x | | | | [Websphere](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/websphere) | | 6.x | 8.x | | | | [Vertx](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/vertx) | | 3.3 | 3.5 | | | | [Weblogic](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/weblogic) | | 10.x | 12.x | | | | [Undertow](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/undertow) | | | | | | | [Undertow Servlet](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/undertow-servlet) | | | | | | | Jasper | | | | | | | | | | | | | | Java Async Thread | | | | | | | | | | | | | | OpenWhisk | whisk.core | | | | | | | | | | | | | SpringMVC Framework | spring-webmvc | 3.0.7 | 5.3.6 | | | | Spring Web | spring-web | 4.1.2 | 4.3.30 | | | | Spring RabbitMQ | spring-rabbit | 1.3.3 | 2.2.16 | | | | Spring IBatis | spring-ibatis | 2.0.7 | 2.0.8 | | | | Spring MyBatis | mybatis-spring | 1.1.0 | 1.3.3 | | | | \*[Spring Boot](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/spring-boot) | spring-boot-autoconfigure | | | | | | \*[Spring Webflux](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/spring-webflux) | spring-webflux | | | | | | | | | | | | | MyBatis | mybatis | 3.0.3 | 3.3.1 | | | | [Hystrix](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/hystrix) | hystrix-core | 1.4.0 | 1.5.18 | | | | | | | | | | | JDKHTTP | | | | | | | Httpclient3 | commons-httpclient | 3.0 | 3.1 | | | | Httpclient4 | httpclient | 4.0 | 4.5.4 | | | | Thrift | libthrift | 0.9.1 | 0.14.1 | | | | Google HTTP Client | google-http-client | 1.19.0 | 1.39.2 | | | | AsyncHttpClient | async-http-client | 1.7.24 | 1.8.17 | | | | OkHttp | okhttp | 2.0.0 | 3.3.1 | | | | Apache HttpAsyncClient | httpasyncclient | 4.0 | 4.1.3 | | | | \*Akka HTTP | akka-http\_2.12 | 10.1.0 | 10.1.x | | | | \*[Kafka](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/kafka) | kafka-clients | 0.11.0.1 | | | | | GRPC | grpc-stub | 1.8.0 | 1.37.0 | | | | \*[Reactor](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/reactor) | reactor-core | 3.3.0 | 3.3.1 | | | | \*[Reactor Netty](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/reactor-netty) | reactor-netty | 0.8.0 | 0.9.2 | | | | | | | | | | | Log4j | log4j | 1.2.16 | 1.2.17 | | | | Logback | logback-classic | 1.0.13 | 1.2.3 | | | | Log4j2 | log4j-core | 2.0 | 2.12.1 | | | | | | | | | | | \*Arcus | arcus-java-client | 1.7.0 | 1.11.4 | | | | \*MsSQL (jTDS) | jtds | 1.2.8 | | | | | \*MsSQL | mssql-jdbc | | | | | | HikariCP | HikariCP-java6 | 2.3.0 | 2.3.13 | | | | Jackson-mapper-asl | jackson-mapper-asl | 1.0.1 | 1.8.11 | | | | Jackson Databind | jackson-databind | 2.0.6 | 2.12.3 | | | | MariaDB Connector/J | mariadb-java-client | 1.3.0 | 2.7.2 | | | | MongoDB Java Driver | mongodb-driver | 3.0.0 | 3.12.8 | | | | [Elasticsearch](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/elasticsearch-bboss) | bboss-elasticsearch-rest-jdbc | 5.6.9 | 5.8.2 | | | | Elasticsearch | elasticsearch-rest-high-level-client | 6.0.0 | 6.8.15 | | | | Datastax Java Driver | cassandra-driver-core | 2.0.10 | 3.11.0 | | | | Druid | druid | 1.0.0 | 1.2.6 | | | | \*Cubrid | cubrid-jdbc-driver | 8.4.1 | 10.0.0 | | | | \*Commons DBCP | commons-dbcp | 1.0 | 1.4 | | | | \*Commons DBCP2 | commons-dbcp2 | 2.0 | 2.5.0 | | | | \*HBase | hbase-client | 1.2.6.1 | 1.2.6.1 | | | | \*MySQL | mysql-connector-java | 5.0 | 8.x | | | | \*Oracle JDBC Driver | ojdbc | | | | | | \*PostgreSQL JDBC Driver | postgresql | | | | | | \*[Redis](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/redis) | jedis | 2.4.2 | | | | | \*[Redis](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/redis-lettuce) | lettuce-core | 5.0.0 | 5.1.2 | | | | \*[Redis](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/redis-redisson) | redisson | 3.10.0 | 3.10.4 | | | | | | | | | | | Apache CXF | cxf-rt-rs-client | 3.0.0 | 3.4.3 | | | | Netty | netty-all | 4.1.0 | 4.1.63 | | | | ActiveMQ | activemq-all | 5.1.0 | 5.16.1 | | | | [RxJAVA](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/rxjava) | rxjava | 1.0.0 | 1.3.8 | | | | [RabbitMQ](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/rabbitmq) | amqp-client | 2.7.0 | 5.12.0 | | | | [Paho MQTT](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/paho-mqtt) | org.eclipse.paho.client.mqttv3 | 1.0.2 | 1.2.5 | | | | [Paho MQTT](https://github.com/pinpoint-apm/pinpoint/tree/master/plugins/paho-mqtt) | org.eclipse.paho.mqttv5.client | 1.2.5 | 1.2.5 | | | | | | | | | | | Gson | gson | 1.1 | 2.8.3 | | | | Json | json-lib | 1.0 | 2.2.2 | | | | FastJson | fastjson | 1.2.10 | 1.2.76 | | | | Dubbo | dubbo | 2.5.1 | 2.6.9 | | | | kafka-clients | kafka-clients | 0.11.0.0 | 2.6.1 | | | | postgresql | postgresql | 9.4.1208 | 42.2.19 | | | | ojdbc8 | ojdbc8 | 12.2.0.1 | 21.1.0.0 | | | | ojdbc10 | ojdbc10 | 19.3.0.0 | 19.10.0.0 | | | | | | | | | | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://pinpoint-apm.gitbook.io/pinpoint/v2.3.1/main.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.