第4章 JSON ロギング形式の設定

コンソールログの出力形式を JSON に変更して、後で分析するためにログ情報を処理および保存しやすくすることができます。

JSON ロギング形式を設定するには、quarkus-logging-json エクステンションを Quarkus プロジェクトに追加する必要があります。コンソール設定の出力形式設定を quarkus-logging-json エクステンションに置き換えます。フォーマット文字列や色設定などのコンソール設定項目は無視されます。非同期ロギングやロギングレベルを制御するものなど、その他のコンソール設定項目は引き続き適用されます。

手順

  1. quarkus-logging-json エクステンションをアプリケーションの pom.xml ファイルに追加します。

    pom.xml

      <dependencies>
    <!-- ... your other dependencies are here ... -->
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-logging-json</artifactId>
    </dependency>
  </dependencies>

  2. (オプション) application.properties ファイルの JSON ロギング用のプロファイル固有の設定を行います。

    src/main/resources/application.properties

    %<profile>.<configuration_key>=<value>

    次の例は、開発プロファイルとテストプロファイルの JSON ロギングを無効にする方法を示しています。

    src/main/resources/application.properties

    %dev.quarkus.log.console.json=false
%test.quarkus.log.console.json=false

関連情報

4.1. JSON ロギング設定プロパティー

次の設定プロパティーを使用して、JSON ロギングエクステンションを設定できます。

表4.1 JSON 設定プロパティー

設定プロパティー説明型デフォルト

quarkus.log.console.json

JSON コンソールのフォーマットエクステンションを有効にします。

boolean

true

quarkus.log.console.json.pretty-print

JSON レコードのプリティープリントを有効にします。[a]

boolean

false

quarkus.log.console.json.date-format

日付の形式。default 文字列は、使用するデフォルトの形式を設定します。

string

default

quarkus.log.console.json.record-delimiter

特別な記録終了区切り文字。デフォルトでは、改行が区切り文字として使用されます。

string

 

quarkus.log.console.json.zone-id

ゾーンの ID。default の文字列は、使用されるデフォルトのゾーンを設定します。

string

default

quarkus.log.console.json.exception-output-type

例外の出力タイプ。

detailed, formatted, detailed-and-formatted

detailed

quarkus.log.console.json.print-details

ログの詳細な出力を有効にします。詳細には、ソースクラス名、ソースファイル名、ソースメソッド名、およびソース行番号が含まれます。[b]

boolean

false

[a] 一部のプロセッサーと JSON パーサーは、プリティープリントの出力を読み取れない場合があります。
[b] 値は呼び出し元から取得されるため、詳細の出力はリソースを多く使用する可能性があります。