pinpoint README

The project's README from github.com/pinpoint-apm/pinpoint. As one markdown file: README.md.

Pinpoint

Maven codecov

Latest Release (2026/05/21)

We're happy to announce the release of Pinpoint v3.1.0. Please check the release note at (https://github.com/pinpoint-apm/pinpoint/releases/tag/v3.1.0).

The current stable version is v3.1.0.

Live Demo

Take a quick look at Pinpoint with our demo!

PHP, PYTHON

Pinpoint also supports application written in PHP, Python. Check-out our agent repository.

About Pinpoint

Pinpoint is an APM (Application Performance Management) tool for large-scale distributed systems written in Java / PHP/PYTHON. Inspired by Dapper, Pinpoint provides a solution to help analyze the overall structure of the system and how components within them are interconnected by tracing transactions across distributed applications.

You should definitely check Pinpoint out If you want to

Getting Started

Deploying Pinpoint to Kubernetes

Overview

Services nowadays often consist of many different components, communicating amongst themselves as well as making API calls to external services. How each and every transaction gets executed is often left as a blackbox. Pinpoint traces transaction flows between these components and provides a clear view to identify problem areas and potential bottlenecks.
For a more intimate guide, please check out our Introduction to Pinpoint video clip.

Supported Modules

The supported version range of each module is listed in Agent Plugins.

Compatibility

Java version required to run Pinpoint:

Pinpoint Version Agent Collector Web Batch
2.0.x 6-13 8 8 8
2.1.x 6-14 8 8 8
2.2.x 7-14 8 8 8
2.3.x 7-17 8 8 8
2.4.x 7-18 11 11 11
2.5.x 8-19 11 11 11
3.0.x 8-21 17 17 17
3.1.x 8-25 17 17 17

HBase compatibility table:

Pinpoint Version HBase 1.x HBase 2.x
2.0.x - 2.2.x yes optional
2.3.x - 2.5.x yes hbase2-module
3.0.x no yes
3.1.x no yes

Agent - Collector compatibility table:

Agent Version Collector 2.x.x Collector 3.0.x Collector 3.1.x
2.x.x yes yes yes
3.0.x no yes yes
3.1.x no no yes

Pinot compatibility table:

Pinpoint Version Pinot 0.11.0 Pinot 0.12.0 Pinot 1.0.0 Pinot 1.2.0 Pinot 1.3.0
2.5.x yes yes yes yes yes
3.0.x no no yes yes yes
3.1.x no no no no yes

Community

Github issues
Gitter

We have Chinese community now, welcome to join!

👆 click me
QQ Group1: 897594820 QQ Group2: 812507584 QQ Group3: 882020485 DING Group : 21981598
QQ Group1 QQ Group2 QQ Group3 DING Group

License

Pinpoint is licensed under the Apache License, Version 2.0. See LICENSE for full license text.

Copyright 2018 NAVER Corp.

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.

pinpoint (pinpoint-apm/pinpoint)

Searching Database…

13.9K ·GitHub
What is this?Pinpoint is an APM (Application Performance Management) tool for large-scale distributed systems, mainly written for Java (with PHP and Python agent support), inspired by Google's Dapper paper.
Is it a single agent or a full platform with a server?It is a full platform: a Collector that receives trace data, a Web UI for visualizing it, and Agents installed on each application to send traces to the Collector.
How do I get it running?Follow the Quick-start guide for a simple test run, or the full Installation guide for a production setup; Pinpoint can also be deployed to Kubernetes using the separate pinpoint-kubernetes project.
What Java version and database do I need?You need JDK 8+ for the agent (newer collector/web/batch components require JDK 11 or 17 depending on version), plus HBase as the storage backend (HBase 2.x required from v3.0.x onward).
Does adding Pinpoint slow down my application?Pinpoint is designed to have minimal performance impact, adding roughly a 3% increase in resource usage according to the project.
Does it only work with Java apps?No, while the core agent and server are Java-based, Pinpoint also provides separate agents for PHP and Python applications.
What does the ServerMap feature actually show me?It visualizes the topology of your distributed system, letting you click on a node to see its current status and transaction count.
Can I see what is happening inside my app right now, not just historical data?Yes, the Realtime Active Thread Chart monitors active threads inside applications in real time, and the Request/Response Scatter Chart lets you drag over live traffic patterns to inspect individual transactions.
Which frameworks and libraries does Pinpoint instrument out of the box?It supports a huge range of modules including Tomcat/Jetty/Spring/Spring Boot, Apache HttpClient/OkHttp, Thrift/gRPC/Dubbo, Kafka/RabbitMQ/RocketMQ, MySQL/Oracle/PostgreSQL/MongoDB/Redis, and connection pools like HikariCP and Druid.
Is there a way to try Pinpoint without installing it?Yes, the project offers a live demo so you can explore the UI before setting anything up.
What are similar projects?zipkin, cat, skywalking, emqx, signoz, conductor, jaeger, GoNavi
Size
271.7 MB
Stars
13.9K
Age
11y
Commits · 90 Days