Using Pinpoint

Article Summary

Share feedback

Thanks for sharing your feedback!

Available in Classic and VPC

Pinpoint user interface

This section briefly introduces the Pinpoint service's main features and Dashboard. (Pinpoint demo)

ng)

Pinpoint Main Dashboard

This mainly consists of three components below.

① Server Map
② Realtime Active Thread Chart
③ Request/Response Scatter Chart

Pinpoint CallStack

You can gain code-level visibility to every transaction as shown in the image below.

Pinpoint Inspector

You can view additional details about the application such as CPU usage, Memory/Garbage Collection, etc.

Pinpoint Cheat Sheet (use and operation)

This section provides you helpful tips and troubleshooting guide for using and operating the Pinpoint service. Information in this section will continue to be updated.

Install and configure Pinpoint Agent

You should install and configure Pinpoint Agent yourself. (configuration example of Tomcat application) You should install and configure Pinpoint Agent yourself. (configuration example of Tomcat application)

Download and install the Pinpoint Agent binary files. (Go to Pinpoint Releases).
You need to choose an Agent installation directory and save files.
Execute lines below to install an agent in Tomcat application service and edit the configuration file. Edit and save the $CATALINA_HOME/bin/catalina.sh file.

$AGENT_PATH={PINPOINT_AGENT_INSTALLATION_DIRECTORY}
CATALINA_OPTS="$CATALINA_OPTS -javaagent:$AGENT_PATH/pinpoint-bootstrap-$VERSION.jar"
CATALINA_OPTS="$CATALINA_OPTS -Dpinpoint.agentId=$AGENT_ID"
CATALINA_OPTS="$CATALINA_OPTS -Dpinpoint.applicationName=$APPLICATION_NAME"

Variables for each configuration item are as follows:

$AGENT_PATH: A directory where Pinpoint Agent is installed
pinpoint-bootstrap-$VERSION.jar: Final release version (version 1.7.3 as of August 5, 2018)
$AGENT_ID: A unique ID to identify applications in Pinpoint Web Dashboard
$APPLICATION_NAME: An ID to identify application groups in Pinpoint Web Dashboard

Enter the Pinpoint Collector server address in profiler.collector.ip=xxx.xxx.xxx.xxx from the ${AGENT_PATH}/pinpoint.config file.
Execute $CATALINA_HOME/bin/startup.sh. Then, Pinpoint Collector (port: 9994) will collect values and send them to Pinpoint Agent.

Verify that configurations are correctly done and the application is running. You can find that application ID/name are added in Pinpoint Web.

Pinpoint Agent Supported Modules (last updated 2018/04/01)

The following is a list of applications and versions that support collecting performance data in Pinpoint Agent.
The list below will continue to be updated.

JDK 6+
Tomcat 6/7/8, Jetty 8/9, JBoss EAP 6, Resin 4, Websphere 6/7/8, Vertx 3.3/3.4/3.5
Spring, Spring Boot (Embedded Tomcat, Jetty)
Apache HTTP Client 3.x/4.x, JDK HttpConnector, GoogleHttpClient, OkHttpClient, NingAsyncHttpClient
Thrift Client, Thrift Service, DUBBO PROVIDER, DUBBO CONSUMER
ActiveMQ, RabbitMQ
MySQL, Oracle, MSSQL, CUBRID,POSTGRESQL, MARIA
Arcus, Memcached, Redis, CASSANDRA
iBATIS, MyBatis
DBCP, DBCP2, HIKARICP
gson, Jackson, JSON Lib
log4j, Logback

Adjust Pinpoint Components Log Level

Edit the `log4j.xml' file to adjust the log level of Pinpoint's each component.

Pinpoint Collector : $PINPOINT_HOME/pinpoint-collector/webapps/pinpoint-collector-1.7.3/WEB-INF/classes/log4j.xml
Pinpoint Web : $PINPOINT_HOME/pinpoint-web/webapps/pinpoint-web-1.7.3/WEB-INF/classes/log4j.xml

   (...omitted)
   <logger name="com.navercorp.pinpoint" additivity="false">
       <level value="WARN"/>
       <appender-ref ref="console"/>
   </logger>

   <logger name="com.navercorp.pinpoint.web.filter" additivity="false">
       <level value="WARN"/>
       <appender-ref ref="console"/>
   </logger>

   <logger name="com.navercorp.pinpoint.web.controller" additivity="false">
       <level value="WARN"/>
       <appender-ref ref="console"/>
   </logger>

   <logger name="com.navercorp.pinpoint.web.applicationmap" additivity="false">
       <level value="WARN"/>
       <appender-ref ref="console"/>
   </logger>

   <logger name="com.navercorp.pinpoint.web.calltree.server" additivity="false">
       <level value="WARN"/>
       <appender-ref ref="console"/>
   </logger>

   <logger name="com.navercorp.pinpoint.web.mapper" additivity="false">
       <level value="WARN"/>
       <appender-ref ref="console"/>
   </logger>

   <logger name="com.navercorp.pinpoint.web.service" additivity="false">
       <level value="WARN"/>
       <appender-ref ref="console"/>
   </logger>
   (...omitted)

Set Pinpoint Web Session Timeout

The default is 30 minutes.
Edit the ${PINPOINT_HOME}/pinpoint-web/conf/web.xml file as shown below and restart the Pinpoint Web service.

   (...omitted)
   <session-config>
       <session-timeout>30</session-timeout>
   </session-config>
   (...omitted)

Initialize Pinpoint Components Log File

The log of Pinpoint's each component is saved in the `catalina.out' file of Tomcat, and Online Initialization is available as shown below. The following example initializes the log of the Pinpoint Web component.

shell> cat /dev/null > $PINPOINT_HOME/pinpoint-web/logs/catalina.out

Monitor details of the Pinpoint VM server

Use the monitoring tool provided by NAVER CLOUD PLATFORM to perform VM monitoring where the Pinpoint service is installed.

How to Use Detailed Monitoring

Install and operate HBase

The HBase component uses version 1.2.6.1 binary files of the Apache HBase project without any modification. You can find the guide by clicking the link below.

Apache HBase Project

Delete Pinpoint Web application information

Enter the command line below to delete information about applications or agents which are not used in Pinpoint Web.
For F$PASSWORD, refer to admin.password=xxxx in the $PINPOINT_HOME/pinpoint-web/webapps/pinpoint-web-1.7.3/WEB-INF/classes/pinpoint-web.properties file.

Delete application name

/admin/removeApplicationName.pinpoint?applicationName=$APPLICATION_NAME&password=$PASSWORD

Delete agent ID

/admin/removeAgentId.pinpoint?applicationName=$APPLICATION_NAME&agentId=$AGENT_ID&password=$PASSWORD

Pinpoint FAQ

You can find more information about Pinpoint besides User Guide provided by NAVER CLOUD PLATFORM by clicking the link which takes you to the official FAQ site.