- 印刷する
- PDF
Pinpoint Cloud を使用する
- 印刷する
- PDF
Classic/VPC環境で利用できます。
Pinpoint Cloudウェブコンソールを使用する方法とPinpoint Agentを使用してアプリケーションを連携する方法を説明します。 Pinpoint Cloudウェブコンソールでは、アプリケーションの性能をモニタリングできます。 Pinpoint Cloudウェブコンソールは、オープンソースバージョンのPinpointと同じUIに構成されているため、既存のPinpointユーザーも簡単に適応できます。
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にダウンロードする必要があります。 インストールする方法は以下のとおりです。
- NAVERクラウドプラットフォームコンソールで、Services > Management & Governance > Pinpoint Cloudメニューを順にクリックします。
- リストで希望するリポジトリの [移動する] ボタンをクリックします。
- ウェブコンソールにログインし、右上のをクリックしてInstallationメニューをクリックします。
- Agentの環境変数を入力します。
- Application Name:アプリケーショングループを区分するためのIDを入力し、 [Check] ボタンをクリック
- Agent ID:アプリケーションを区分するための固有IDを入力し、 [Check] ボタンをクリック
- 入力された情報でJVM argumentが構成されると、をクリックしてコードをコピーします。
- 今後アプリケーションの実行オプションに当該コードを追加してください。
- Download Linkにあるリンクをクリックして圧縮ファイルをダウンロードします。
- ダウンロードした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
ファイルに値を貼り付けて保存します。
- モニタリング対象アプリケーションの実行オプション設定:<例> Tomcatの場合、Tomcatの起動スクリプトの
- アプリケーションを実行します。
- インストールした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ウェブコンソールの主な機能を簡単に説明します。
Pinpoint Cloudウェブコンソールは、オープンソースバージョンのPinpointと同じUIに構成されているため、使用方法に対する詳しい内容はPinpointの公式サイトをご参照ください。
Server Map
分散システムの構成を一目で確認でき、各ノードをクリックして構成要素の現在の状態やトランザクション数などを確認できます。
領域 | 説明 |
---|---|
① サーバトポロジー | アプリケーションサーバのアーキテクチャ |
② Active Request | モニタリング中のアプリケーション内部の有効スレッド数をリアルタイムで表示 |
③ チャート | 選択されたノードの詳細情報を分散図と棒グラフで表示 |
Call Stack
システムトランザクションをコードレベルに確認してボトルネックポイントと障害発生ポイントをスピーディーに識別し、アプリケーションのエラーと例外情報をすぐに確認できます。
Server Mapの分散図に記録されたトランザクションを選択すると、以下のようにCall Stack画面が表示されます。
領域 | 説明 |
---|---|
① トランザクションリスト | 選択されたトランザクションリスト |
② Call Tree | トランザクションを行って実行されたメソッドリスト |
Application Inspector
アプリケーションのリソースデータ(stat:CPU、メモリ、TPS、Datasource Connection Count)を確認できます。
- チャートで特定領域をドラッグすると、選択された領域のみ拡大して確認できます。
- 拡大された状態で [Reset Zoom] ボタンをクリックすると、拡大を解除できます。
設定メニュー
Pinpoint Cloudウェブコンソールで、をクリックして設定メニューを利用できます。 利用可能な設定メニューは以下のとおりです。
このガイドは、管理者アカウントを基準に表示されるメニューを説明します。 実際アクセスする際にアカウントによっては、一部メニューが表示されない場合があります。
メニュー | 説明 |
---|---|
Administration | リポジトリのウェブコンソールユーザーとAgentデータ管理 |
Setting | リポジトリ別のウェブコンソール使用設定 |
User Group | ユーザーグループの追加と管理(ユーザーグループ管理を参考) |
Authentication & Alarm | ユーザーグループ別アプリケーションの使用権限と通知設定(アプリケーションの使用権限と通知設定を参考) |
Installation | Agentインストールの環境変数設定とダウンロード(Agentインストールを参考) |
ユーザー管理
作成されたリポジトリウェブコンソールのユーザーを管理できます。
ユーザーの追加
新しいユーザーを追加する方法は以下のとおりです。
- Pinpoint Cloudウェブコンソールで > Usersメニューを順にクリックします。
- ユーザーリスト上段のをクリックします。
- ユーザー情報を入力し、 [保存] ボタンをクリックします。
- ユーザーのロールは、Roleメニューで設定できます。 新しいロールを作成するには、ロールの作成をご参照ください。
登録されたユーザー情報を修正するには、リストでユーザーをクリックしてから入力欄に情報を新しく入力し、 [保存] ボタンをクリックします。
ユーザーの削除
ユーザーを削除する方法は、以下のとおりです。
- Pinpoint Cloudウェブコンソールで > Usersメニューを順にクリックします。
- ユーザーリストで削除するユーザーのをクリックします。
- [削除] ボタンをクリックします。
ロールの管理
リポジトリウェブコンソールユーザーのロールと使用権限を管理できます。
ロールの作成
新しいロールの作成方法は以下のとおりです。
- Pinpoint Cloudウェブコンソールで > Roleメニューを順にクリックします。
- ロールリスト上段のをクリックします。
- ロール名を入力し、付与する使用権限を選択した後、 [保存] ボタンをクリックします。
登録されたロール情報を修正するには、リストでロールをクリックしてから使用権限を選択し、 [保存] ボタンをクリックします。
ロールの削除
ロールを削除する方法は以下のとおりです。
ロールを削除すると、当該ロールに指定されたユーザーの使用権限が一緒に削除されます。
- Pinpoint Cloudウェブコンソールで > Roleメニューを順にクリックします。
- ロールリストで削除するロールのをクリックします。
- [削除] ボタンをクリックします。
ユーザーグループ管理
登録されたユーザーをグループ化して使用できるアプリケーションを指定し、アラーム対象者として一括設定できます。
ユーザーグループの照会
ユーザーグループのリストとグループ別に設定された詳細情報を照会できます。 ユーザーグループを照会する方法は、以下のとおりです。
- Pinpoint Cloudウェブコンソールで > User Groupメニューを順にクリックします。
- User Group画面でグループ情報を確認します。
- User Group:作成されたユーザーグループリスト
- リスト内の項目をクリックすると、当該グループに属したメンバーリストがGroup Memberに表示されます。
- をクリックして新しいユーザーグループを作成できます。
- をクリックしてユーザーグループを削除できます。
- Group Member:選択されたグループに属するメンバーリスト
- > をクリックしてメンバーをグループから削除できます。
- Pinpoint User:Pinpoint Cloudウェブコンソールに登録されたすべてのユーザーリスト
- グループが選択された状態でユーザー名の前にあるチェックボックスをクリックして選択すると、当該ユーザーがグループメンバーに追加されます。
- ユーザー名をクリックすると、プロフィールの詳細情報が確認できます。
- Application Authentication & Alarm:選択されたグループに指定されたアプリケーションリスト
- Detail項目のをクリックしてアプリケーションの使用権限を確認できます。
- More項目のをクリックしてAuthentication & Alarmメニューに移動できます。
- User Group:作成されたユーザーグループリスト
ユーザーグループの作成
新しいユーザーグループを作成してメンバーを追加する方法は以下のとおりです。
- Pinpoint Cloudウェブコンソールで > User Groupメニューを順にクリックします。
- User Groupリスト上段のをクリックします。
- ユーザーグループ名を入力し、 [OK] ボタンをクリックします。
- 作成されたユーザーグループをクリックし、Pinpoint Userリストでメンバーとして追加するユーザーのチェックボックスをクリックして選択します。
- 選択されたユーザーがGroup Memberリストに追加されます。
アプリケーションの使用権限と通知設定
Pinpoint Cloudウェブコンソールに登録されたアプリケーションの使用権限をユーザーグループに付与し、イベントの発生時に送る通知を設定できます。
使用権限の設定
アプリケーションの使用権限を設定してユーザーグループに付与する方法は、以下のとおりです。
- Pinpoint Cloudウェブコンソールで > Authentication & Alarmメニューを順にクリックします。
- Applicationリストで使用権限を付与するアプリケーションをクリックします。
- Authenticationリスト上段のをクリックします。
- 使用権限を付与するユーザーグループIDとポジションを選択してからデータの表示有無を設定し、 [OK] ボタンをクリックします。
- 権限設定内容がリストに追加されます。
- をクリックしてユーザーグループに設定されたデータの表示有無を確認できます。
- をクリックしてポジションとデータの表示有無を変更できます。
- > をクリックして設定内容を削除できます。
- 権限設定内容がリストに追加されます。
アラーム設定
指標の基準を超えると、SMS/メールにアラームを送るように設定できます。 アラーム設定が可能な指標項目は、以下のとおりです。
項目 | 説明 |
---|---|
SLOW COUNT | 外部からアプリケーションを呼び出したリクエストの中で、外部サーバに遅れてレスポンスしたリクエストの数がしきい値を超えた場合、アラーム送信 |
SLOW RATE | 外部からアプリケーションを呼び出したリクエストの中で、外部サーバに遅れてレスポンスしたリクエストの比率(%)がしきい値を超えた場合、アラーム送信 |
ERROR COUNT | 外部からアプリケーションを呼び出したリクエストの中で、エラーが発生したリクエストの数がしきい値を超えた場合、アラーム送信 |
ERROR RATE | 外部からアプリケーションを呼び出したリクエストの中で、エラーが発生したリクエストの比率(%)がしきい値を超えた場合、アラーム送信 |
TOTAL COUNT | 外部からアプリケーションを呼び出したリクエストの数がしきい値を超えた場合、アラーム送信 |
SLOW COUNT TO CALLEE | アプリケーション内で外部サーバを呼び出したリクエストの中で、遅れてレスポンスした呼び出しの数がしきい値を超えた場合、アラーム送信 メモ項目に外部サーバのドメインやアドレス(IP、ポート)を入力する必要がある<例> naver.com, 127.0.0.1:8080) |
SLOW RATE TO CALLEE | アプリケーション内で外部サーバを呼び出したリクエストの中で、遅れてレスポンスした呼び出しの比率(%)がしきい値を超えた場合、アラーム送信 メモ項目に外部サーバのドメインやアドレス(IP、ポート)を入力する必要がある<例> naver.com, 127.0.0.1:8080) |
ERROR COUNT TO CALLEE | アプリケーション内で外部サーバを呼び出したリクエストの中で、エラーが発生した呼び出しの数がしきい値を超えた場合、アラーム送信 メモ項目に外部サーバのドメインやアドレス(IP、ポート)を入力する必要がある<例> naver.com, 127.0.0.1:8080) |
ERROR RATE TO CALLEE | アプリケーション内で外部サーバを呼び出したリクエストの中で、エラーが発生した呼び出しの比率(%)がしきい値を超えた場合、アラーム送信 メモ項目に外部サーバのドメインやアドレス(IP、ポート)を入力する必要がある<例> naver.com, 127.0.0.1:8080) |
TOTAL COUNT TO CALLEE | アプリケーション内で外部サーバを呼び出したリクエストの数がしきい値を超えた場合、アラーム送信 メモ項目に外部サーバのドメインやアドレス(IP、ポート)を入力する必要がある<例> naver.com, 127.0.0.1:8080) |
HEAP USAGE RATE | heapの使用率がしきい値を超えた場合、アラーム送信 |
JVM CPU USAGE RATE | アプリケーションのCPUの使用率がしきい値を超えた場合、アラーム送信 |
SYSTEM CPU USAGE RATE | サーバのCPUの使用率がしきい値を超えた場合、アラーム送信 |
DATASOURCE CONNECTION USAGE RATE | アプリケーションdatasource内のconnection使用率がしきい値を超えた場合、アラーム送信 |
DEADLOCK OCCURRENCE | アプリケーションでデッドロックを検知すると、アラーム送信 |
FILE DESCRIPTOR COUNT | 開いているfile descriptorの数がしきい値を超えた場合、アラーム送信 |
イベント発生時、ユーザーグループに送る通知を設定する方法は、以下のとおりです。
- Pinpoint Cloudウェブコンソールで > Authentication & Alarmメニューを順にクリックします。
- Alarmリスト上段のをクリックします。
- アラーム項目としきい値を設定してからアラームを受けるユーザーグループIDとアラーム形式を選択し、 [OK] ボタンをクリックします。
- アラーム内容がリストに追加されます。
- をクリックしてアラーム内容を変更できます。
- > をクリックしてアラーム内容を削除できます。
- アラーム内容がリストに追加されます。