------------------------------------------------------------------------------------ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: MIT-0 ------------------------------------------------------------------------------------ # Lab2：アプリケーションログをリアルタイムで可視化 「Lab1：はじめの準備」で構築したEC2のログデータをリアルタイムで可視化するために、 EC2 で出力されるログを OSS の Fluentd を使ってストリームで Amazon OpenSearch Service（以降、OpenSearch Service）に送信し、 OpenSearch Service に付属している OpenSearch Dashboards を使って、可視化を行います。 2分おきに10件前後、10分おきに300件出力され続けるログを、 Fluentd を使って OpenSearch Service に転送し、 OpenSearch Dashboards で可視化します。 ## Section1：OpenSearch Service の設定 ### Step1：OpenSearch Service の起動 1. AWS マネージメントコンソールのサービス一覧から **OpenSearch Service** を選択し、 **[ドメインの作成]** をクリックします。 2. **"名前"** の項目において、 **"ドメイン名"** に「 **handson-minilake**（任意）」と入力しします。 3. **"デプロイタイプ"** の項目において、 **"デプロイタイプ"** で **[開発およびテスト]** を選択します。 バージョンは変更せず、そのまま次へ進みます。 **Note：** 今回の手順はバージョン1.0で確認しました。 4. **"データノード"** の項目において、 **"インスタンスタイプ"** に **[t3.small.search]** を選択します。その他の設定は変更せず、そのまま次へ進みます。 5. **"ネットワーク"** の項目において、 **"ネットワーク"** にある **[パブリックアクセス]** にチェックを入れます。 6. **"きめ細かなアクセスコントロール"** 項目にて **[きめ細かなアクセスコントロールを有効化]** にチェックが入っていることを確認し、 **[マスターユーザーの作成]** にチェックを入れ、 **"マスターユーザー名"** と **"マスターパスワード"** を以下の通り設定します。 - マスターユーザー名：**aesadmin**（任意） - マスターユーザーのパスワード：**MyPassword&1**（任意） 7. 次に、アクセスポリシーの項目を設定します。 **"ドメインアクセスポリシー"** において **[ドメインレベルのアクセスポリシーの設定]** を選択します。 - タイプに **[IPv4 アドレス]** を選択、プリンシパルに「 **[ご自身のIPアドレス](http://checkip.amazonaws.com/)** 」を入力、アクションに **[許可]** を選択 - **[要素を追加]** をクリックし、タイプに **[IPv4 アドレス]** を選択、プリンシパルに「 **Lab1で作成したインスタンスのパブリックIP** 」を入力、アクションに **[許可]** を選択 - **[要素を追加]** をクリックし、タイプに **[IAM ARN]** を選択、プリンシパルに「 **ご自身のAWSアカウントID** 」を入力、アクションに **[許可]** を選択 8. 上記の設定以外は全てデフォルトのままで、画面の一番下にある **[作成]** をクリックしドメインを作成します。 **Note：** OpenSearch Service の作成が始まります。構築完了には 15 分ほどかかりますが完了を待たずに次の手順を進めてください。 ## Section2：EC2, Fluentd, OpenSearch Service の設定 ### Step1：IAM ロールの設定 作成済の「 **handson-minilake-role**（任意）」の IAM ロールに以下のようにポリシーを追加します。 1. AWS マネジメントコンソールのサービス一覧から **IAM** を選択し、 **[Identity and Access Management (IAM)]** 画面の左ペインから **[ロール]** を選択し、「 **handson-minilake-role**（任意）」のロール名をクリックします。 2. **[許可]** タブを選択し、 **[許可を追加]** をクリックし、 **[ポリシーをアタッチ]** をクリックします。 3. 検索窓で「 **amazones** 」と入れ検索し、 **[AmazonESFullAccess]** にチェックを入れ、 **[ポリシーのアタッチ]** をクリックします。 4. 変更実施したロール名を再びクリックし、 **[許可]** タブを選択し、 **[AmazonESFullAccess]** がアタッチされたことを確認します。 ### Step2：Fluentd の設定 Fluentd から OpenSearch Service にログデータを送信するための設定を行います。 1. AWS マネジメントコンソールのサービス一覧から **OpenSearch Service** を選択し、 **[Amazon OpenSearch Service ダッシュボード]** 画面から作成したドメイン名「 **handson-minilake**（任意）」をクリックし、 **[ドメインエンドポイント]** にある **URL の文字列** を **https://を含めない形** でパソコンのメモ帳などにメモしておきます。 2. EC2 にログインし、 OpenSearch のプラグインのインストール状況を確認します。 **Asset** 資料：[2-cmd.txt](asset/ap-northeast-1/2-cmd.txt) ``` # td-agent-gem list | grep plugin-elasticsearch ``` **[実行結果例]** ``` fluent-plugin-elasticsearch (2.6.0, 2.4.0) ``` 5. 「 **/etc/td-agent/td-agent.conf** 」の設定を **Lab2** 向けに変更するために、あらかじめ用意しておいた **asset** に 以下の cp コマンドを用いて置き換えます。その際、ファイルを上書きするかの確認が入る為、 **yes** と入力します。 ``` # cp -p /root/asset/2-td-agent.conf /etc/td-agent/td-agent.conf ``` 6. 置き換えたあと、内容を **vi** などのエディタを使用し、一部修正します。 **<エンドポイント>** の値を手順1でコピーしておいたエンドポイントの値と置き換え、保存します。 **Note：** **eshost** の値として、 **https://** は含めません。 ``` # vi /etc/td-agent/td-agent.conf ``` **[変更前]** ``` host <エンドポイント> ``` **[変更後の例]** ``` host search-handson-minilake-ikop2vbusshbf3pgnuqzlxxxxx.ap-northeast-1.es.amazonaws.com ``` 8. 上記に続き **<マスターユーザー名>** と **<マスターパスワード>** についても、 **[Step1：OpenSearch Service の起動のセクション6]** で作成した、 **"マスターユーザー名":** ```aesadmin（任意）``` と **"マスターパスワード":** ```MyPassword&1（任意）``` に置き換える形で修正します。 **[変更前]** ``` user <マスターユーザー名> password <マスターパスワード> ``` **[変更後の例]** ``` user aesadmin password MyPassword&1 ``` 9. td-agent のプロセスを起動します。 **Asset** 資料：[2-cmd.txt](asset/ap-northeast-1/2-cmd.txt) ``` # /etc/init.d/td-agent restart ``` 10. Fluentd のログを確認します。 **Asset** 資料：[2-cmd.txt](asset/ap-northeast-1/2-cmd.txt) ``` # tail -f /var/log/td-agent/td-agent.log ``` 　 **Note：** ログの中にエラーが出続けることがないかを確認します。起動に成功した場合、以下の文言が出力されます。 ``` [info]: #0 Connection opened to OpenSearch cluster => {..... ``` ログ出力まで少し時間がかかる場合があります。 ### Step3：OpenSearch Service の設定 1. AWS マネジメントコンソールのサービス一覧から **OpenSearch Service** を選択します。 2. 左ペインにある **[ドメイン]** を選択します。作成した「 **handson-minilake**（任意）」ドメインの **[ドメインのステータス]** が **[アクティブ]** で、 **[検索可能なドキュメント]** の件数が1件以上になっていることを確認し、「 **handson-minilake**（任意）」ドメインをクリックします。 3. **[OpenSearch Dashboards の URL]** のをクリックします。 4. **[Open Distro for OpenSearch]** 画面が表示されるため、 **[Step1：OpenSearch Service の起動のセクション6]** で作成した、 **"マスターユーザー名"** と **"マスターパスワード"** を入力します。 5. **[Welcome to OpenSearch]** 画面が表示されるため、 **[Explore on my own]** を選択します。 6. **[Select your tenant]** のポップアップが表示されるため、 **[Private]]** を選択し、 **[Confirm]]** をクリックし、 **OpenSearch Dashboards** の画面を開きます。 #### OpenSearch Dashboards での操作 7. **OpenSearch Dashboards** の画面左にある![kibana_pain](images/kibana_pain2.png)アイコンをクリックし、 **[Dashboad]** をクリックします。 8. **[Create index pattern]** をクリックし、 **[Create index pattern]** 画面において、 **[Index pattern name]** に「 ___testappec2log-*___ 」を入力し、右側の **[Next step]** をクリックします。 9. **[Time field]** において、 **[@timestamp]** を選択し、画面右下の **[Create index pattern]** をクリックします。 10. **OpenSearch Dashboards** の画面の左ペインにある **[Saved Objects]** をクリックします。画面右上の **[Import]** をクリックします。 11. **[Import saved objects]** 画面において、 **[Import]** アイコンをクリックし、 **Asset** 資料の「 **2-visualization.json** 」を選択し、 **[Import]** をクリックします。続く画面において、 **[New index patten]** に対して、「 **testappec2log-\*** 」を選択し、 **[Confirm all changes]** をクリックし、インポートを完了します。問題なくインポートが完了したら、 **[Done]** をクリックすると、元の画面に戻ります。 **Asset** 資料：[2-visualization.json](asset/ap-northeast-1/2-visualization.json) 12. 続いて、再度 **[Saved Objects]** 画面において、 **[Import]** アイコンをクリックし、 **Asset** 資料の「 **2-dashboard.json** 」を選択し、 **[Import]** をクリックし、インポートします。問題なくインポートが完了したら、 **[Done]** をクリックすると、元の画面に戻ります。 **Asset** 資料：[2-dashboard.json](asset/ap-northeast-1/2-dashboard.json) 13. **OpenSearch Dashboards** の画面左にある![kibana_pain](images/kibana_pain2.png)アイコンをクリックし、ペインからインポートした「 **test1-dashboard** 」をクリックし、以下のように値が表示されていれば完了です。 14. **OpenSearch Dashboards** の画面にて、右上でタイムレンジが選べるため、期間を **[Last 1 hour]** にしてみます。グラフ表示が1時間の間の取得値に変化していることが確認できます。 15. **OpenSearch Dashboards** の画面左にある![kibana_pain](images/kibana_pain2.png)アイコンをクリックし、**[Discover]** をクリックします。 16. **"Available fields"** において、 **[alarmlevel]** の右の **[プラスボタン]** をクリックします。同じように **[user]** の右側の **[プラスボタン]** をクリックすると、対象のカラム（Time, alarmlevel, user）だけが表示されます。 **Note：** **[プラスボタン]** はカーソルがある時にだけ表示されます。 17. 検索窓に「 **user:"imai"** 」と入力し、Enterを押すと、「 **imai** 」というユーザーでフィルタリングされます。 ## Section3：まとめ EC2 からのログをストリームで OpenSearch Service に送り、 OpenSearch Dashboards で可視化してエラーログなどを探しやすくなりました。大量の EC2 がある場合、ログを探すのは大変なのでさらに高い効果が見込めます。 Lab2 は以上です。選択されているパターンに合わせて次の手順を実施ください。 （1） ニアリアルタイムデータ分析環境（スピードレイヤ）の構築：[Lab1](../lab1/README.md) → [Lab2](../lab2/README.md) → [Lab3](../lab3/README.md) （2） 長期間のデータをバッチ分析する環境（バッチレイヤ）の構築と、パフォーマンスとコストの最適化：[Lab1](../lab1/README.md) → [Lab4](../lab4/README.md) or [Lab5](../lab5/README.md) → [Lab6](../lab6/README.md) （3） すべて実施：[Lab1](../lab1/README.md) → [Lab2](../lab2/README.md) → [Lab3](../lab3/README.md) → [Lab4](../lab4/README.md) → [Lab5](../lab5/README.md) → [Lab6](../lab6/README.md) 環境を削除される際は、[こちら](../clean-up/README.md)の手順をご覧ください。