Pinpoint is comprised of 3 main components (Collector, Web, Agent), and uses HBase as its storage. Collector and Web are packaged as simple WAR files, and the Agent is packaged so that it may be attached to applications as a java agent.
Pinpoint QuickStart provides a sample TestApp for the Agent to attach itself to, and launches all three components using Tomcat Maven Plugin.
In order to build Pinpoint, the following requirements must be met:
- JDK 6 installed
- JDK 7+ installed
- Maven 3.2.x+ installed
- JAVA_6_HOME environment variable set to JDK 6 home directory.
- JAVA_7_HOME environment variable set to JDK 7+ home directory.
JDK 7+ and JAVA_7_HOME environment variable are required to build profiler-optional. For more information about the optional package, please take a look here.
QuickStart supports Linux, and OSX.
Download Pinpoint with git clone https://github.com/naver/pinpoint.git
or download the project as a zip file and unzip.
Install Pinpoint with maven by cd pinpoint
and running mvn install -Dmaven.test.skip=true
The following script downloads HBase standalone from Apache download site.
Download & Start - Run quickstart/bin/start-hbase.sh
Initialize Tables - Run quickstart/bin/init-hbase.sh
Collector - Run quickstart/bin/start-collector.sh
Web UI - Run quickstart/bin/start-web.sh
TestApp - Run quickstart/bin/start-testapp.sh
Once the startup scripts are completed, the last 10 lines of the Tomcat log are tailed to the console:
Once HBase and the 3 daemons are running, you may visit the following addresses to test out your very own Pinpoint instance.
- Web UI - http://localhost:28080
- TestApp - http://localhost:28081
You can feed trace data to Pinpoint using the TestApp UI, and check them using Pinpoint Web UI. TestApp registers itself as test-agent under TESTAPP.
HBase - Run quickstart/bin/stop-hbase.sh
Collector - Run quickstart/bin/stop-collector.sh
Web UI - Run quickstart/bin/stop-web.sh
TestApp - Run quickstart/bin/stop-testapp.sh