チュートリアル: Azure で実行される Java アプリ用の Logz.io を使用した監視とログ記録の概要

[アーティクル]
05/30/2023

このチュートリアルでは、インジェストと分析のために Logz.io サービスにログを送信するように、クラシック Java アプリケーションを構成する方法について説明します。 Logz.io により、Elasticsearch/Logstash/Kibana (ELK) および Grafana に基づく完全な監視ソリューションが提供されます。

このチュートリアルは、Log4J または Logback の使用を前提としています。これらのライブラリは、Java でのログ記録に最も広く使用されています。そのため、このチュートリアルは Azure で実行されるほとんどのアプリケーションに適用できます。既に Elastic スタックを使用して Java アプリケーションを監視している場合、このチュートリアルでは、Logz.io エンドポイントをターゲットにするように再構成する方法を示します。

このチュートリアルで学習する内容は次のとおりです。

既存の Java アプリケーションから Logz.io にログを送信する。
診断ログとメトリックを Azure サービスから Logz.io に送信する。

前提条件

Java Developer Kit バージョン 11 以上
Azure Marketplace からの Logz.io アカウント
Log4J または Logback を使用する既存の Java アプリケーション

Java アプリケーションログを Logz.io に送信する

まず、Logz.io アカウントへのアクセス権を付与するトークンを使用して Java アプリケーションを構成する方法について説明します。

Logz.io アクセストークンを取得する

トークンを取得するには、Logz.io アカウントにログインし、左下隅にある歯車アイコンを選択し、設定 [トークンの管理] を選択し、[データ配布トークン] タブを選択します。表示される既定のアクセストークンとリスナー URL をコピーして、後で使用できるようにします。 >

Log4J または Logback 用の Logz.io ライブラリをインストールして構成する

Logz.io Java ライブラリは Maven Central で入手できるため、依存関係としてアプリ構成に追加できます。 Maven Central でバージョン番号を確認し、次の構成設定で最新バージョンを使用します。

Maven を使用している場合は、pom.xml ファイルに次の依存関係を追加します。

Log4J:

<dependency>
    <groupId>io.logz.log4j2</groupId>
    <artifactId>logzio-log4j2-appender</artifactId>
    <version>2.0.0</version>
</dependency>

Logback:

<dependency>
    <groupId>io.logz.logback</groupId>
    <artifactId>logzio-logback-appender</artifactId>
    <version>2.0.0</version>
</dependency>

Gradle を使用している場合は、ビルドスクリプトに次の依存関係を追加します。

Log4J:

implementation 'io.logz.log4j:logzio-log4j-appender:2.0.0'

Logback:

implementation 'io.logz.logback:logzio-logback-appender:2.0.0'

次に、Log4J または Logback の構成ファイルを更新します。

Log4J:

<Appenders>
    <LogzioAppender name="Logzio">
        <logzioToken><your-logz-io-token></logzioToken>
        <logzioType>java</logzioType>
        <logzioUrl>https://<your-logz-io-listener-host>:8071</logzioUrl>
    </LogzioAppender>
</Appenders>

<Loggers>
    <Root level="info">
        <AppenderRef ref="Logzio"/>
    </Root>
</Loggers>

Logback:

<configuration>
    <!-- Use shutdownHook so that we can close gracefully and finish the log drain -->
    <shutdownHook class="ch.qos.logback.core.hook.DelayingShutdownHook"/>
    <appender name="LogzioLogbackAppender" class="io.logz.logback.LogzioLogbackAppender">
        <token><your-logz-io-token></token>
        <logzioUrl>https://<your-logz-io-listener-host>:8071</logzioUrl>
        <logzioType>java</logzioType>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
    </appender>

    <root level="debug">
        <appender-ref ref="LogzioLogbackAppender"/>
    </root>
</configuration>

<your-logz-io-token> プレースホルダーを実際のアクセストークンに、<your-logz-io-listener-host> プレースホルダーを自分の地域のリスナーホスト (listener.logz.io など) に置き換えます。アカウントのリージョンを検索する方法の詳細については、「アカウントリージョン」を参照してください。

logzioType 要素は、異なるドキュメントを相互に分離するために使用される Elasticsearch の論理フィールドを参照します。 Logz.io を最大限に活用するには、このパラメーターを適切に構成することが不可欠です。

Logz.io の "Type" は、ログの形式 (例: Apache、NGinx、MySQL) であり、ソース (例: server1、server2、server3) ではありません。このチュートリアルでは、Java アプリケーションを構成しているため java 型を呼び出しています。これらのアプリケーションはすべて同じ形式であると想定されています。

高度な使用方法として、Java アプリケーションをさまざまな型にグループ化することができます。各グループは独自のログ形式 (Log4J と Logback で構成可能) を持ちます。たとえば、"spring-boot-monolith" という型と "spring-boot-microservice" という型を使用できます。

Logz.io で構成とログ分析をテストする

Logz.io ライブラリの構成が完了すると、アプリケーションはログを直接送信するようになります。すべてが正常に動作することをテストするには、Logz.io コンソールに移動し、[ログライブテール] タブを選択してから、[実行] を選択します。> 接続が機能していることを示す次のようなメッセージが表示されます。

Requesting Live Tail access...
Access granted. Opening connection...
Connected. Tailing...

次に、アプリケーションを起動するか、ログを生成するために使用します。ログが画面に直接表示されます。たとえば、Spring Boot アプリケーションの最初の起動メッセージは次のようになります。

2019-09-19 12:54:40.685Z Starting JavaApp on javaapp-default-9-5cfcb8797f-dfp46 with PID 1 (/workspace/BOOT-INF/classes started by cnb in /workspace)
2019-09-19 12:54:40.686Z The following profiles are active: prod
2019-09-19 12:54:42.052Z Bootstrapping Spring Data repositories in DEFAULT mode.
2019-09-19 12:54:42.169Z Finished Spring Data repository scanning in 103ms. Found 6 repository interfaces.
2019-09-19 12:54:43.426Z Bean 'spring.task.execution-org.springframework.boot.autoconfigure.task.TaskExecutionProperties' of type [org.springframework.boot.autoconfigure.task.TaskExecutionProperties] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)

ログが Logz.io によって処理されたので、プラットフォームのすべてのサービスを活用できます。

Azure サービスのデータを Logz.io に送信する

次に、Azure リソースから Logz.io にログとメトリックを送信する方法について説明します。

テンプレートのデプロイ

最初の手順では、Logz.io と Azure の統合テンプレートをデプロイします。統合は、既製の Azure デプロイテンプレートに基づいており、パイプラインのすべての必要な構成要素を設定します。このテンプレートは、イベントハブ名前空間、イベントハブ、2 つのストレージ BLOB、および必要なすべての適切なアクセス許可と接続を作成します。自動化されたデプロイによって設定されたリソースは、1 つの Azure リージョンのデータを収集し、そのデータを Logz.io に送信できます。

リポジトリの readme の最初の手順に表示されている [Deploy to Azure] ボタンを見つけます。

[Deploy to Azure] を選択すると、Azure portal の [カスタムデプロイ] ページに、入力済みのフィールドの一覧が表示されます。

ほとんどのフィールドはそのままにしておくことができますが、次の設定を入力してください。

[リソースグループ]: 既存のグループを選択するか、新しく作成します。
[Logzio Logs/Metrics Host]\(Logzio ログ/メトリックホスト\): Logz.io リスナーの URL を入力します。この URL がわからない場合は、ログイン URL を確認してください。それが app.logz.io の場合、listener.logz.io (既定の設定) を使用します。 app-eu.logz.io の場合は listener-eu.logz.io を使用します。
[Logzio Logs/Metrics Token]\(Logzio ログ/メトリックトークン\): Azure のログまたはメトリックを送付する Logz.io アカウントのトークンを入力します。このトークンは、Logz.io UI のアカウントページで見つけることができます。

ページの下部にある条項に同意し、[Purchase]\(購入\) を選択します。その後、Azure によってテンプレートがデプロイされます。これには 1 - 2 分かかる場合があります。最終的には、ポータルの上部に "デプロイに成功しました" というメッセージが表示されます。

定義されたリソースグループにアクセスして、デプロイされたリソースを確認できます。

Azure Blob Storage にデータをバックアップするように logzio-azure-serverless を構成する方法については、「Ship Azure activity logs」を参照してください。

Azure のログとメトリックを Logz.io にストリーム配信する

統合テンプレートをデプロイしたので、デプロイしたイベントハブに診断データをストリーム配信するように Azure を構成する必要があります。データがイベントハブに送られると、関数アプリがそのデータを Logz.io に転送します。

検索バーに「診断」と入力し、[診断設定] を選択します。
リソースの一覧からリソースを選択し、[診断設定を追加する] を選択して、[診断設定] パネルを開きます。
診断設定の名前を付けます。
[イベントハブへのストリーム] を選択し、[構成] を選択して [イベントハブの選択] パネルを開きます。
イベントハブを選択します。
- [イベントハブの名前空間の選択]: Logzio で始まる名前空間 (LogzioNS6nvkqdcci10p など) を選択します。
- [イベントハブ名を選択する]: ログ用に insights-operational-logs を選択し、メトリック用に insights-operational-metrics を選択します。
- [イベントハブポリシー名の選択]: [LogzioSharedAccessKey] を選択します。
[OK] を選択して、[診断設定] パネルに戻ります。
[ログ] セクションで、ストリーム配信するデータを選択し、[保存] を選択します。

これで、選択したデータがイベントハブにストリーム配信されるようになります。

データを視覚化する

次に、少し時間をおいてデータをシステムから Logz.io に送信してから、Kibana を開きます。データ (種類 eventhub) がダッシュボードに表示されます。ダッシュボードを作成する方法の詳細については、「Kibana - ダッシュボードの作成」を参照してください。

そこから、[検出] タブで特定のデータを照会したり、Kibana オブジェクトを作成して [視覚化] タブでデータを視覚化したりできます。

リソースをクリーンアップする

このチュートリアルで作成した Azure リソースの使用が完了したら、次のコマンドを使用して削除できます。

az group delete --name <resource group>

次のステップ

このチュートリアルでは、Logz.io にログとメトリックを送信するように Java アプリケーションと Azure サービスを構成する方法について学習しました。

次に、イベントハブを使用してアプリケーションを監視する方法について詳しく説明します。

外部ツールで使用する Azure 監視データのイベントハブへのストリーム配信

チュートリアル: Azure で実行される Java アプリ用の Logz.io を使用した監視とログ記録の概要

前提条件

Java アプリケーションログを Logz.io に送信する

Logz.io アクセストークンを取得する

Log4J または Logback 用の Logz.io ライブラリをインストールして構成する

Logz.io で構成とログ分析をテストする

Azure サービスのデータを Logz.io に送信する

テンプレートのデプロイ

Azure のログとメトリックを Logz.io にストリーム配信する

データを視覚化する

リソースをクリーンアップする

次のステップ

フィードバック

フィードバック

その他のリソース

チュートリアル: Azure で実行される Java アプリ用の Logz.io を使用した監視とログ記録の概要

前提条件

Java アプリケーションログを Logz.io に送信する

Logz.io アクセス トークンを取得する

Log4J または Logback 用の Logz.io ライブラリをインストールして構成する

Logz.io で構成とログ分析をテストする

Azure サービスのデータを Logz.io に送信する

テンプレートのデプロイ

Azure のログとメトリックを Logz.io にストリーム配信する

データを視覚化する

リソースをクリーンアップする

次のステップ

フィードバック

フィードバック

その他のリソース

Logz.io アクセストークンを取得する