ロガー (loggers)

loggers エンドポイントは、アプリケーションのロガーおよびそのレベルの構成へのアクセスを提供します。

すべてのロガーの取得

アプリケーションのロガーを取得するには、次の curl ベースの例に示すように、GET リクエストを /actuator/loggers に作成します。

$ curl 'http://localhost:8080/actuator/loggers' -i -X GET

結果のレスポンスは次のようになります。

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 791

{
  "levels" : [ "OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ],
  "loggers" : {
    "ROOT" : {
      "configuredLevel" : "INFO",
      "effectiveLevel" : "INFO"
    },
    "com.example" : {
      "configuredLevel" : "DEBUG",
      "effectiveLevel" : "DEBUG"
    }
  },
  "groups" : {
    "test" : {
      "configuredLevel" : "INFO",
      "members" : [ "test.member1", "test.member2" ]
    },
    "web" : {
      "members" : [ "org.springframework.core.codec", "org.springframework.http", "org.springframework.web", "org.springframework.boot.actuate.endpoint.web", "org.springframework.boot.web.servlet.ServletContextInitializerBeans" ]
    },
    "sql" : {
      "members" : [ "org.springframework.jdbc.core", "org.hibernate.SQL", "org.jooq.tools.LoggerListener" ]
    }
  }
}

レスポンス構造

レスポンスには、アプリケーションのロガーの詳細が含まれます。次の表に、レスポンスの構造を示します。

パス タイプ 説明

levels

Array

ロギングシステムによるレベルのサポート。

loggers

Object

名前をキーとするロガー。

groups

Object

名前をキーとするロガーグループ

loggers.*.configuredLevel

String

ロガーの構成レベル（ある場合）。

loggers.*.effectiveLevel

String

ロガーの有効レベル。

groups.*.configuredLevel

String

ロガーグループの設定レベル（ある場合）。

groups.*.members

Array

このグループの一部であるロガー

単一のロガーの取得

単一のロガーを取得するには、次の curl ベースの例に示すように、GET リクエストを /actuator/loggers/{logger.name} に作成します。

$ curl 'http://localhost:8080/actuator/loggers/com.example' -i -X GET

上記の例では、com.example というロガーに関する情報を取得します。結果のレスポンスは次のようになります。

HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 61

{
  "configuredLevel" : "INFO",
  "effectiveLevel" : "INFO"
}

レスポンス構造

レスポンスには、リクエストされたロガーの詳細が含まれます。次の表に、レスポンスの構造を示します。

パス タイプ 説明

configuredLevel

String

ロガーの構成レベル（ある場合）。

effectiveLevel

String

ロガーの有効レベル。

単一グループの取得

単一のグループを取得するには、次の curl ベースの例に示すように、GET リクエストを /actuator/loggers/{group.name} に作成します。

$ curl 'http://localhost:8080/actuator/loggers/test' -i -X GET

上記の例は、test という名前のロガーグループに関する情報を取得します。結果のレスポンスは次のようになります。

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 82

{
  "configuredLevel" : "INFO",
  "members" : [ "test.member1", "test.member2" ]
}

レスポンス構造

レスポンスには、リクエストされたグループの詳細が含まれます。次の表に、レスポンスの構造を示します。

パス タイプ 説明

configuredLevel

String

ロガーグループの設定レベル（ある場合）。

members

Array

このグループの一部であるロガー

ログレベルの設定

ロガーのレベルを設定するには、次の curl ベースの例に示すように、ロガーに設定されたレベルを指定する JSON 本文を使用して、POST を /actuator/loggers/{logger.name} にリクエストします。

$ curl 'http://localhost:8080/actuator/loggers/com.example' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"configuredLevel":"debug"}'

上記の例では、com.example ロガーの configuredLevel を DEBUG に設定します。

リクエスト構造

リクエストは、ロガーの望ましいレベルを指定します。次の表に、リクエストの構造を示します。

パス タイプ 説明

configuredLevel

String

ロガーのレベル。レベルをクリアするために省略できます。

グループのログレベルの設定

ロガーのレベルを設定するには、次の curl ベースの例に示すように、ロガーグループに設定されたレベルを指定する JSON ボディを使用して、POST を /actuator/loggers/{group.name} にリクエストします。

$ curl 'http://localhost:8080/actuator/loggers/test' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"configuredLevel":"debug"}'

上記の例では、test ロガーグループの configuredLevel を DEBUG に設定します。

リクエスト構造

リクエストは、ロガーグループの目的のレベルを指定します。次の表に、リクエストの構造を示します。

パス タイプ 説明

configuredLevel

String

ロガーのレベル。レベルをクリアするために省略できます。

ログレベルのクリア

ロガーのレベルをクリアするには、次の curl ベースの例に示すように、空のオブジェクトを含む JSON ボディを使用して POST を /actuator/loggers/{logger.name} にリクエストします。

$ curl 'http://localhost:8080/actuator/loggers/com.example' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{}'

上記の例は、com.example ロガーの構成済みレベルをクリアします。