Pinpointのご利用開始ガイド

Classic/VPC環境で利用できます。

Pinpointの主要画面のご紹介

Pinpointサービスの主要な機能及びダッシュボードをご紹介し、機能について概略にご説明します(Pinpointのご紹介映像).

Pinpoint Mainのダッシュボード

以下のように、大きく3つの要素で構成されています。

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

Pinpoint CallStack

以下のように、コードレベルのトランザクション単位情報を確認することができます。

Pinpoint Inspector

以下のように、CPU Usage、Memory/Garbage Collectionのような付加情報に関するChartを確認することができます。

Pinpoint Cheat Sheet(利用及び運用)

Pinpointサービスの利用及び運用の際のポイントとTrouble shooting guideを概略に説明し、引き続きアップデートしていく予定です。

Pinpoint Agentのインストール及び適用

Pinpoint Agentは、各ユーザーが当該サービスに直接インストールして設定する必要があります。Tomcat Application Serviceにインストールして設定する方法は、次の通りです。

1. Pinpoint Agentのバイナリーをダウンロード及びインストールします(Pinpoint Releasesへ)。
   Agentのインストールディレクトリは、ユーザーが直接選択し、インストール及び保存します。

2. Tomcat Application ServiceにAgentをインストールし、 $CATALINA_HOME/bin/catalina.sh ファイルを次のように修正して保存します。

$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"

各設定項目に対する変数は、以下の通りです。

• $AGENT_PATH: Pinpoint Agentのインストールされたディレクトリを指定します。
• pinpoint-bootstrap-$VERSION.jar: 2018年8月5日現在、1.7.3バージョンが最終リリースバージョンです。
• $AGENT_ID: Pinpoint Web Dashboardから各Applicationを区分するためのUnique IDを設定します。
• $APPLICATION_NAME: Pinpoint Web Dashboardから各Application Groupを区分するためのIDを設定します。

3. ${AGENT_PATH}/pinpoint.configのファイルでprofiler.collector.ip=xxx.xxx.xxx.xxxにPinpoint Collectorのサーバアドレスを入力します。

4. $CATALINA_HOME/bin/startup.shを実行すると、Pinpoint Agentから値を収集し、Pinpoint Collector(Port：9994)に転送します。

上記のように、設定の完了及び正常にApplicationが実行された場合、Pinpoint WebでApplication ID/Nameとして追加されたAgent情報を確認することができます。

Pinpoint Agent Supported Modules(最終アップデート：2018年04月01日)

Pinpoint Agentで性能の収集をサポートするApplication及びVersion情報は、以下の通りです。
以下のリストは、引き続きアップデートしていく予定です。

• 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

Pinpoint Components Log Levelの調整

Pinpointの各コンポーネントのログレベルを調整するためには、log4j.xmlファイルを修正する必要があります。

• 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

   (...中略)
   <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>
   (...中略)

Pinpoint Web Session Timeoutの設定方法

Pinpoint Web Session Timeoutの時間は、現在30分に設定されています。
以下のように、${PINPOINT_HOME}/pinpoint-web/conf/web.xmlファイルの値を修正した後、Pinpoint Webサービスを再起動すると適用されます。

   (...中略)
   <session-config>
       <session-timeout>30</session-timeout>
   </session-config>
   (...中略)

Pinpoint Components Log Fileの初期化方法

Pinpointの各コンポーネントのログは、Tomcatのcatalina.outファイルに保存され、以下のように、Online Initializationができます。次は、Pinpoint Webコンポーネントのログを初期化する例です。

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

Pinpoint VMサーバの詳細モニタリングガイド

PinpointサービスがインストールされたVMサーバに対するモニタリングは、NAVERクラウドプラットフォームのサービスを利用して確認することができます。

• 詳細Monitoringのご利用ガイド

HBaseのインストール及び運用ガイド

HBaseのコンポーネントは、Apache HBaseプロジェクトの1.2.6.1 Binaryバージョンを修正することなく利用しており、当該ガイドは以下のリンクで確認することができます。

• Apache HBase Project

Pinpoint Web Application情報の削除

Pinpoint Webで利用していないApplication及びAgent情報を以下のような方法で削除することができます。
$PASSWORDの場合、$PINPOINT_HOME/pinpoint-web/webapps/pinpoint-web-1.7.3/WEB-INF/classes/pinpoint-web.propertiesファイルのadmin.password=xxxxを参照します。

• Application Nameを削除する

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

• Agent IDを削除する

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

Pinpoint FAQ

NAVERクラウドプラットフォームのPinpointのユーザーガイドの他に、より多くの情報を確認するためには、以下のような公式サイトのFAQをご参照いただけます。

• Pinpoint FAQ

Pinpointのオープンソースガイドへ

Pinpointのオープンソースバージョンに対するRepository、Technology、その他の役に立つ情報に対するリンクをご提供します。

• Pinpoint Official Github
  

• Pinpoint Official Web Site
  

• Pinpoint Stable Version Release
  

• Pinpoint Installation Guide
  

• Pinpoint Quick Start Guide
  

• Pinpoint Plugin Developer Guide
  

• Pinpoint Inspector Guide
  

• Pinpoint Installation with Docker
  

• Pinpoint Technology Details