- 印刷する
- PDF
Pinpointサーバの構築ガイド
- 印刷する
- PDF
Classic/VPC環境で利用できます。
ご利用の前に
Q. Pinpointとは、何ですか?
- Javaの分散サービス及びシステムの継続的な性能分析を提供し、エラー発生の可能性に対する診断と追跡をサポートするプラットフォームサービスです。
- “N”階層のSOA(Service Oriented Architecture)及びMicro-Serviceで構成されたアーキテクチャサービスの追跡/分析機能を提供します。
- 分散アプリケーションのトランザクション分析、Topology Detection、Bytecode Instrumentationを活用した診断機能を提供します。
- "Pinpoint"は、'NAVER株式会社'で開発して公開したオープンソースであるPinpointを利用しています。
Q. Pinpointを利用すると、どのようなメリットがありますか?
- サービスコードを修正することなく、Java Applicationの性能を診断し、エラーを追跡することができます。
- 様々なJava Agent Plug-in機能に対応しており、継続的に拡張可能な機能を提供します。
- 複雑なサービスの分散環境を1つのトランザクションで追跡し、Root Cause分析に重要なデータを提供します。
Q. Pinpointサーバの構築方法は?
- コンソール>Compute>ServerメニューからPinpointのサーバイメージを選択して作ることができます。
- 所望のスペックのサーバを立ち上げ、必要に応じてストレージを追加します。
- 月額料金制と時間料金制とで請求され、サーバを構築した後、接続環境を設定して利用することができます。
- PinpointのWebサービスを利用するために、グローバルIPアドレスを申し込み、ACGの設定において
10090
ポートを追加する必要があります。 - コンソールに接続した後、次の段階を経てサーバを構築することができます。
Q. Pinpoint Webに接続することができません。
- PinpointのWebサービスを利用するためには、グローバルIPアドレスを申し込み、サーバに割り当てなければならず、ACGに
10090
ポートが追加されている必要があります("接続環境を設定する"を参照)。 - グローバルIPアドレスとACGを確認した後も接続ができない場合は、Pinpointのプロセスが停止されている状態になっている可能性があるため、ターミナルで再起動のコマンドを実行してプロセスを再起動してください("Pinpointプロセスの管理"を参照)。
Q. Pinpointは、どのディレクトリにインストールされますか?
/root/pinpoint
ディレクトリにインストールされます。- Pinpointのインストールパスには、pinpoint-collector、pinpoint-web、hbase-1.2.6.1などが一緒にインストールされます。
- データロスを防止するために、インストールパスをバックアップしておくことをお勧めいたします。
Q. Pinpoint AdminのPasswordを初期化する方法は?
- Pinpoint AdminのPasswordを初期化する方法は、次の通りです。
- サーバに接続
- [Pinpoint Webのインストールパス]/webapps/pinpoint-web-1.7.3/WEB-INF/web.xmlを修正
- Pinpoint Webの初期インストールパス:/root/pinpoint/pinpoint-web
LoginCheck
filter項目の<init-param>
のうち、username
、password
値を修正<param-name>username</param-name>
,<param-name>password</param-name>
- Pinpoint Webサービスの再起動
$ /root/pinpoint/pinpoint-web/bin/shutdown.sh
$ /root/pinpoint/pinpoint-web/bin/startup.sh
Q. PinpointのWebサービスを利用する上で注意すべきことはありますか?
- Pinpoint Webサービスは、基本的に
HTTP
プロトコルベースに設定されています。 - Pinpoint Webサービスをより安定的で、強化されたセキュリティの基で利用したい場合は、
HTTPS
プロトコルでご利用ください。 - SSL証明書及びWeb Service Domainを作成した後、ご利用ください。
Pinpointのご紹介
Pinpointは、分散サービス及びシステムの性能分析/診断/追跡プラットフォームサービスとして、“N”階層のSOA(Service Oriented Architecture)及びMicro-Serviceで構成されたアーキテクチャサービスの追跡及び分析機能を提供し、分散アプリケーションのトランザクション分析、Topology Detection、Bytecode Instrumentationを活用した診断機能を提供します。
Pinpointサーバを作る
Pinpointサーバの作り方は、以下の通りです。
Step 1. コンソールへの接続
コンソールに接続し、メニューからCompute > Serverを選択します。
① サーバを作るためには、[サーバを作る] をクリックします。
Step 2. サーバイメージの選択
Pinpointのサーバイメージを選択してサーバを立ち上げます。
① Pinpointのイメージを選択します。
② ポップアップウィンドウの案内(Pinpointの利用のためのグローバルIPアドレス、ACGのお申し込み、初期Passwordの確認)を確認します。
③ [確認] をクリックすると、ポップアップウィンドウが閉じられてサーバ情報の入力画面に移動します。
Step 3. サーバの設定
ストレージの種類、サーバタイプ、料金プラン、Zoneを選択し、サーバ名を入力します。
① Zoneを選択します。
- Pinpointサービスは、全てのRegionに対応しています。
② ブートストレージとして使用するストレージの種類を選択します。
③ 希望するサーバタイプを選択します。
- 一部のサーバスペックは、ブートディスクタイプによって対応しないことがあります。
- 利用量に応じてサーバタイプのいずれか1つを選択してください。
④ 料金プランは、月額料金制又は時間料金制の中から選択することができます。
⑤ サーバ名を入力します。
- お客様がサーバを区別するための名称として、重複して使うことができません。
⑥ [次へ] をクリックします。
Step 4. 認証キーの設定
保有する認証キーがある場合、保有する認証キーを利用するを選択し、ない場合には、以下の手順で新しい認証キーを作ります。
① 新しい認証キーを作るを選択します。
② 認証キー名を入力します。
③ 認証キーの作成及び保存をクリックし、ローカルPCに認証キーファイルを保存します。
- 新しい認証キーを発行します。
- 保存した後、認証キーはお客様のPCの安全な位置に保管してください。
- 認証キーは、最初の管理者パスワードをインポートする際に利用されます。
④ [次へ] をクリックします。
Step 5. ACGの設定
保有するACGを利用するか、新規のACGを生成してファイアウォールを設定することができます。
保有するACGの利用
保有するACGを利用し、ファイアウォールを設定する方法は、次の通りです。
① ACGは必須で選択する必要があり、基本で提供する‘ncloud-default-acg’を含んで保有するACGの中から1つを選択します。
- 保有するACGは、最大で5つまで選択することができます。
- [次へ] ボタンが有効になって設定を行うためには、必ずACGを選択しなければなりません。
② 保有するACGの他に、新規のACGを生成して設定したい場合には、新規のACGを生成するを選択します。
③ [次へ] をクリックします。
新しくACGの生成
新しくACGを生成してファイアウォールを設定する方法は、次の通りです。
① 新規のACGの生成から [ACGを生成する] をクリックします。
② ACG名を入力します。
③ ACGの設定において、プロトコル、アクセスソース、許容ポートを入力して生成します。
- プロトコル:TCP、UDP、ICMPの中から選択
- アクセスソース:IPアドレス又はACG名を入力
- 許容ポート:単一ポート又は範囲を制定
- ターミナル接続のためには、接続しようとするサーバのACGにSSH 'TCP/22'に対するルールが設定されている必要があり、Pinpointの利用のためには、以下のようなルールが追加で設定されている必要があります。ルールを追加するには、プロトコル、アクセスソース、許容ポートを記載し、[追加する] をクリックします。
区分 | IP帯域 | Port | Description |
---|---|---|---|
TCP | (必要なIP帯域) | 22 | Pinpoint Server SSH |
TCP | (必要なIP帯域) | 10090 | Pinpoint Web Port |
TCP | (必要なIP帯域) | 8090 | Pinpoint Collector Web Port |
TCP | (必要なIP帯域) | 9994 | Pinpoint Collector TCP |
TCP | (必要なIP帯域) | 9995 | Pinpoint Collector Status TCP |
TCP | (必要なIP帯域) | 9996 | Pinpoint Collector Span TCP |
UDP | (必要なIP帯域) | 9994 | Pinpoint Collector UDP |
UDP | (必要なIP帯域) | 9995 | Pinpoint Collector Status UDP |
UDP | (必要なIP帯域) | 9996 | Pinpoint Collector Span UDP |
- Pinpoint ACGのルール追加例
④ 上記のサービスポートが全て追加された場合、[生成する] をクリックします。
Step 6. 最終確認
設定した内容を最終確認します。
① サーバイメージ、サーバ、認証キー、ACGが正常に設定されているか確認します。
② 最終確認の後は、[サーバを構築する] をクリックします。
- サーバが構築されるまで数分から数十分かかります。
サーバリストから確認
作られたサーバをリストから確認します。
① 構築したサーバがリストに表示されます。
② サーバが構築され、Pinpointパッケージがインストール完了し、サーバステータスが運用中になるまで待ちます。
接続環境を設定する
グローバルIPアドレスの利用お申し込み
Pinpointを利用するためには、必ずグローバルIPアドレスを利用して接続する必要があり、グローバルIPアドレスの利用に対する料金が別途請求されます。
① 左メニューからPUBLIC IPメニューを選択します。グローバルIPアドレスを割り当てられるためには、[グローバルIPを申し込む] をクリックします。
② 適用するサーバを選択するからグローバルIPアドレスを割り当てるPinpointサーバを選択します。
③ [確認] をクリックします。 適用するサーバ名を確認し、もう一度 [確認] をクリックします。
ポートフォワーディングの設定
ターミナルプログラム(PuTTYなど)でサーバに接続するには、ポートフォワーディングを設定しなければなりません。
① 左メニューからServerメニューを選択します。サーバに接続するためには、[ポートフォワーディングを設定する] をクリックします。
② ポートフォワーディングの設定画面で外部ポート番号を設定します。外部ポート番号の入力範囲は、1024~65,534であり、サーバの接続のための機能の他にサービス用途として利用することができません。(内部ポート番号は、22に定められています。)
③ [追加する] をクリックすると、設定内容が下段に追加され、[修正する]、[削除する] をクリックし、設定内容を修正、削除することができます。
④ [適用する] をクリックすると、設定した外部ポートとしてターミナルプログラムを利用してSSH接続を行うことができます。
ACGの設定
ACGにターミナル接続SSH('TCP/22')及びPinpointサービス('TCP/UDP'の設定)ルールを追加します。
サーバを作る際、ルールを既に追加した場合には、この段階のACGの設定作業を行う必要がありません。
① 左メニューからACGメニューを選択します。
② サーバを作る際、選択したACGを選択し、上段の [ACGを生成する] をクリックします。
③ ACG名を入力します。
④ 設定が完了すると、[生成する] をクリックします。
- Pinpoint ACGルールが、以下のように追加されていれば、追加の作業を行う必要はありません。
① 生成したACGを選択します。
② 上段の [ACGを設定する] をクリックします。
③ ACGルールの設定において、プロトコル、アクセスソース、許容ポートを入力して生成します。
- プロトコル:TCP、UDP、ICMPの中から選択
- アクセスソース:IPアドレス又はACG名を入力
- 許容ポート:単一ポート又は範囲を制定
- ターミナル接続のためには、接続しようとするサーバのACGにSSH 'TCP/22'に対するルールが設定されている必要があります。
- ルールを追加するには、プロトコル、アクセスソース、許容ポートを記載し、[追加する] をクリックします。
④ 設定が完了すると、[適用する] をクリックします。
サーバの管理者パスワードの確認
ターミナルプログラム(PuTTYなど)でサーバに接続するためには、管理者パスワードを知る必要があります。
① 左メニューからServerメニューを選択します。
② 当該サーバを選択し、サーバ管理及び設定の修正から管理者パスワードを確認するを選択します。
③ [Drop files here or click to upload] をクリックし、サーバの構築の際にPCに保存した認証キーファイル(.pem)を添付します。
④ 添付の後、[Passwordを確認する] をクリックすると、ターミナルプログラムで最初にサーバに接続する際に利用するPasswordを獲得することができます。
- サーバに接続した後、管理者が記憶できるPasswordに変更して利用することをお勧めします。
ターミナルに接続する
ターミナルプログラム(PuTTYなど)でサーバに接続し、Pinpointプロセスを管理することができます。
ターミナルプログラムでサーバに接続
① ターミナルプログラム(PuTTYなど)を実行します。
② サーバリスト又は内容閲覧から確認した'サーバ接続用のグローバルIP'と'外部ポート'の値を入力し、[Open] をクリックすると、サーバに接続されます。
- サーバ接続用のグローバルIPの確認:コンソールのServer > Serverメニューからサーバを選択した後、詳細情報からポートフォワーディング情報のサーバ接続用のグローバルIP値の確認
- 外部ポート番号の確認:コンソールのServer > Serverメニューからサーバを選択した後、詳細情報からポートフォワーディング情報の外部ポート値の確認
③ ユーザー情報及びPasswordを入力してログインします。
- login as:root
- password:上記で確認した管理者パスワード
④ ログインの後、rootアカウントのPasswordを記憶できるPasswordに変更することをお勧めいたします。
passwd root
コマンドを入力した後、新しいPasswordを入力します。
Pinpoint Serverを素早く起動/中止する
Pinpointサーバを構築する際に、提供されるpinpoint-init.sh
ファイルの実行でPinpoint Componentsを簡単に起動することができます。
pinpoint-init.sh
ファイル位置の確認shell> PINPOINT_HOME=/root/pinpoint shell> ls -al $PINPOINT_HOME
素早く起動する:
pinpoint-init.sh
の実行及び確認shell> PINPOINT_HOME=/root/pinpoint shell> $PINPOINT_HOME/pinpoint-init.sh
素早く中止する:
pinpoint-stop.sh
の実行及び確認shell> PINPOINT_HOME=/root/pinpoint shell> $PINPOINT_HOME/pinpoint-stop.sh
Pinpointを再起動する:
pinpoint-restart.sh
の実行及び確認
Pinpoint Componentを停止してから起動します。shell> PINPOINT_HOME=/root/pinpoint shell> $PINPOINT_HOME/pinpoint-restart.sh
Pinpointを起動する:
pinpoint-start.sh
の実行及び確認
Pinpoint Componentを起動します。shell> PINPOINT_HOME=/root/pinpoint shell> $PINPOINT_HOME/pinpoint-start.sh
Pinpointのステータスを確認する:
pinpoint-status.sh
の実行及び確認
Pinpoint Componentのステータスを確認します。shell> PINPOINT_HOME=/root/pinpoint shell> $PINPOINT_HOME/pinpoint-status.sh
注意Pinpoint Components Statusが
STOP
の際、pinpoint-stop.sh
又はpinpoint-restart.sh
を実行する場合 < 以下のようなTomcatエラーメッセージが表示されることがあります。shell> PINPOINT_HOME=/root/pinpoint shell> $PINPOINT_HOME/pinpoint-status.sh shell> $PINPOINT_HOME/pinpoint-stop.sh
Pinpointプロセスの管理
次のようなコマンドでPinpointプロセスを管理することができます。Pinpointは、以下のような3つのコンポーネントで構成されています。
HBaseプロセスの起動/中止/プロセスを確認
shell> $PINPOINT_HOME/hbase-1.2.6.1/bin/start-hbase.sh shell> $PINPOINT_HOME/hbase-1.2.6.1/bin/stop-hbase.sh shell> ps -ef | grep hbase
Pinpoint Webの起動/中止/プロセスを確認
shell> $PINPOINT_HOME/pinpoint-web/bin/startup.sh shell> $PINPOINT_HOME/pinpoint-web/bin/shutdown.sh shell> ps -ef | grep pinpoint-web
Pinpoint Collectorの起動/中止/プロセスを確認
shell> $PINPOINT_HOME/pinpoint-collector/bin/startup.sh shell> $PINPOINT_HOME/pinpoint-collector/bin/shutdown.sh shell> ps -ef | grep pinpoint-collector
Pinpoint Agentのインストール及び適用
Pinpoint Agentは、各ユーザーが当該サービスに直接インストールして設定する必要があります。Tomcat Application Serviceにインストールして設定する方法は、次の通りです。
Pinpoint Agentのバイナリーをダウンロード及びインストールします。(Pinpoint Releasesへ)。
Agentのインストールディレクトリは、ユーザーが直接選択し、インストール及び保存します。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のダッシュボードから各Applicationを区分するためのUnique IDを設定します。$APPLICATION_NAME
: Pinpoint Webのダッシュボードから各Application Groupを区分するためのIDを設定します。
${AGENT_PATH}/pinpoint.config
のファイルでprofiler.collector.ip=xxx.xxx.xxx.xxx
にPinpoint Collectorのサーバアドレスを入力します。$CATALINA_HOME/bin/startup.sh
を実行すると、Pinpoint Agentから値を収集し、Pinpoint Collector(Port:9994)に転送します。
上記のように、設定の完了及び正常にApplicationが実行された場合、Pinpoint WebでApplication ID/Nameとして追加されたAgent情報を確認することができます。
Pinpoint Webへの接続
Pinpoint Componentsのインストール及び起動が完了すると、以下のような方法で接続及び利用が可能になります。
- Pinpoint Webへの接続:
http://{Public IP}:10090
- ログイン:最初のログインのID/Passwordである
ppadmin/{Hostname}
で接続が可能であり、上記のPinpoint AdminのPasswordを初期化する方法は?
を参考にし、接続アカウント及びPasswordを必ず変更してください。
① Pinpoint Web IDとPasswordとを入力します。
② [Login] をクリックし、正常にログインができれば、Pinpoint Mainのダッシュボードを利用することができます。