Pinpoint Cloud を使用する

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

Pinpoint Cloudウェブコンソールを使用する方法と Pinpoint Agentを使用してアプリケーションを連携する方法を説明します。Pinpoint Cloudウェブコンソールでは、アプリケーションの性能をモニタリングできます。Pinpoint Cloudウェブコンソールは、オープンソースバージョンの Pinpointと同じ UIに構成されているため、既存のユーザーも簡単に適応できます。

Agentのインストールと管理

Pinpoint Cloudを使用するには、モニタリング対象アプリケーションに Pinpoint Agentをインストールする必要があります。
Pinpoint Agentは、モニタリング対象のアプリケーション(例) Tomcat)に接続した Java Agentで実行されます。Pinpoint Agentをモニタリング対象アプリケーションに接続するには、アプリケーションを実行する際に、-javaagent JVM argumentに $AGENT_PATH/pinpoint-bootstrap-$VERSION.jarを伝達する必要があります。

Agentのインストール

Pinpoint Agentをインストールするには、環境変数を設定してリンクを PCにダウンロードする必要があります。インストールする方法は、次の通りです。

1. NAVERクラウドプラットフォームコンソールで、 > Services > Management & Governance > Pinpoint Cloudメニューを順にクリックします。
2. リストから希望するリポジトリの [移動する] ボタンをクリックします。
3. ウェブコンソールにログインし、右上の をクリックして Installationメニューをクリックします。
4. Agentの環境変数を入力します。
   • Application Name: アプリケーショングループを区分するための IDを入力し、 [Check] ボタンをクリック
   • Agent ID: アプリケーションを区分するための固有 IDを入力し、 [Check] ボタンをクリック
5. 入力された情報で JVM argumentが構成されると、をクリックしてコードをコピーします。
   • 今後アプリケーションの実行オプションに当該コードを追加してください。
6. Download Linkにあるリンクをクリックして圧縮ファイルをダウンロードします。
7. ダウンロードした Agentファイルの圧縮を解凍し、モニタリング対象アプリケーションの実行オプション設定とライセンスキー設定を完了します。
   • モニタリング対象アプリケーションの実行オプション設定: 例) Tomcatの場合、Tomcatの起動スクリプトの $CATALINA_HOME/bin/catalina.shファイルを以下のように変更して保存します。

   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 License Key領域にマウスオーバーすると表示される をクリックしてライセンスキーをコピーし、$AGENT_PATH/pinpoint.licenseファイルに値を貼り付けて保存します。
8. アプリケーションを実行します。
   • インストールした Pinpoint Agentを通じて性能情報が収集されます。

Pinpointログレベルを調整

Pinpointの各コンポーネントのログレベルを調整するには、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 Cloudウェブコンソールの主な機能を簡単にご案内します。

Server Map

分散システムの構成を一目で確認でき、各ノードをクリックして構成要素の現在の状態やトランザクション数などを確認できます。

Call Stack

システムトランザクションをコードレベルに確認してボトルネックポイントと障害発生ポイントをスピーディーに識別し、アプリケーションのエラーと例外情報をすぐに確認できます。

Server Mapの分散図に記録されたトランザクションを選択すると、以下のように Call Stack画面が表示されます。

Application Inspector

アプリケーションのリソースデータ(stat: CPU、メモリ、TPS、Datasource Connection Count)を確認できます。

• チャートで特定領域をドラッグすると、選択された領域のみ拡大して確認できます。
• 拡大された状態で [Reset Zoom] ボタンをクリックすると、拡大を解除できます。

設定メニュー

Pinpoint Cloudウェブコンソールで をクリックして設定メニューを利用できます。利用可能な設定メニューは次の通りです。

ユーザー管理

作成されたリポジトリウェブコンソールのユーザーを管理できます。

ユーザーの追加

新しいユーザーを追加する方法は次の通りです。

1. Pinpoint Cloudウェブコンソールで > Usersメニューを順にクリックします。
2. ユーザーリスト上部の をクリックします。
3. ユーザー情報を入力し、 [保存] ボタンをクリックします。
   • ユーザーロールは、Roleメニューで設定できます。新しいロールを作成するには、ロール作成をご参照ください。

ユーザーの削除

ユーザーを削除する方法は、次の通りです。

1. Pinpoint Cloudウェブコンソールで > Usersメニューを順にクリックします。
2. ユーザーリストで削除するユーザーの をクリックします。
3. [削除] ボタンをクリックします。

ロール管理

リポジトリウェブコンソールユーザーのロールと使用権限を管理できます。

ロール作成

新しいロールの作成方法は次の通りです。

1. Pinpoint Cloudウェブコンソールで > Roleメニューを順にクリックします。
2. ロールリスト上部の をクリックします。
3. ロール名を入力し、付与する使用権限を選択した後、 [保存] ボタンをクリックします。

ロール削除

ロールを削除する方法は、次の通りです。

1. Pinpoint Cloudウェブコンソールで > Roleメニューを順にクリックします。
2. ロールリストで削除するロールの をクリックします。
3. [削除] ボタンをクリックします。

ユーザーグループ管理

登録されたユーザーをグループ化して使用できるアプリケーションを指定し、通知対象者として一括設定できます。

ユーザーグループの照会

ユーザーグループのリストとグループ別に設定された詳細情報を照会できます。ユーザーグループを照会する方法は、次の通りです。

1. Pinpoint Cloudウェブコンソールで > User Groupメニューを順にクリックします。
2. User Group画面でグループ情報を確認します。
   
   • User Group: 作成されたユーザーグループリスト
     • リスト内の項目をクリックすると、当該グループに属したメンバーリストが Group Memberに表示されます。
     • をクリックして新しいユーザーグループを作成できます。
     • をクリックしてユーザーグループを削除できます。
   • Group Member: 選択されたグループに属するメンバーリスト
     • > をクリックしてメンバーをグループから削除できます。
   • Pinpoint User: Pinpoint Cloudウェブコンソールに登録されているすべてのユーザーリスト
     • グループが選択された状態でユーザー名の前にあるチェックボックスをクリックして選択すると、当該ユーザーがグループメンバーに追加されます。
     • ユーザー名をクリックすると、プロファイルの詳細情報が確認できます。
   • Application Authentication & Alarm: 選択されたグループに指定されたアプリケーションリスト
     • Detail項目の をクリックしてアプリケーションの使用権限を確認できます。
     • More項目の をクリックして Authentication & Alarmメニューに移動できます。

ユーザーグループの作成

新しいユーザーグループを作成してメンバーを追加する方法は次の通りです。

1. Pinpoint Cloudウェブコンソールで > User Groupメニューを順にクリックします。
2. User Groupリスト上部の をクリックします。
3. ユーザーグループ名を入力し、 [OK] ボタンをクリックします。
4. 作成されたユーザーグループをクリックし、Pinpoint Userリストでメンバーとして追加するユーザーのチェックボックスをクリックして選択します。
   • 選択されたユーザーが Group Memberリストに追加されます。

アプリケーションの使用権限と通知設定

Pinpoint Cloudウェブコンソールに登録されたアプリケーションの使用権限をユーザーグループに付与し、イベントの発生時に送る通知を設定できます。

使用権限設定

アプリケーションの使用権限を設定してユーザーグループに付与する方法は、次の通りです。

1. Pinpoint Cloudウェブコンソールで > Authentication & Alarmメニューを順にクリックします。
2. Applicationリストで使用権限を付与するアプリケーションをクリックします。
3. Authenticationリスト上部の をクリックします。
4. 使用権限を付与するユーザーグループ IDとポジションを選択してからデータの表示有無を設定し、 [OK] ボタンをクリックします。
   • 権限設定内容がリストに追加されます。
     • をクリックしてユーザーグループに設定されたデータの表示有無を確認できます。
     • をクリックしてポジションとデータの表示有無を変更できます。
     • > をクリックして権限設定内容を削除できます。

通知設定

指標の基準を超えると、SMS/メールに通知を送るように設定できます。通知設定が可能な指標項目は、次の通りです。

イベント発生時、ユーザーグループに送る通知を設定する方法は、次の通りです。

1. Pinpoint Cloudウェブコンソールで > Authentication & Alarmメニューを順にクリックします。
2. Alarmリスト上部の をクリックします。
3. 通知項目としきい値を設定してから通知を受けるユーザーグループ IDと通知形式を選択し、 [OK] ボタンをクリックします。
   • 通知内容がリストに追加されます。
     • をクリックして通知内容を変更できます。
     • > をクリックして通知内容を削除できます。