アプリケーションのモニタリング
コード例: events
Ktorは、イベントを使用してサーバーアプリケーションをモニタリングする機能を提供します。 アプリケーションのライフサイクルに関連する定義済みのイベント（アプリケーションの開始、停止など）を処理したり、特定のケースを処理するためにカスタムイベントを使用したりできます。また、MonitoringEventフックを使用して、カスタムプラグインのイベントを処理することもできます。
イベント定義
各イベントは、EventDefinitionクラスのインスタンスによって表されます。このクラスには、イベントに渡される値の型を指定する T 型パラメータがあります。この値には、イベントハンドラー内でラムダの引数としてアクセスできます。例えば、ほとんどの定義済みのイベントは、パラメータとして Application を受け取るため、イベントハンドラー内でアプリケーションのプロパティにアクセスできます。
カスタムイベントでは、そのイベントに必要な型パラメータを渡すことができます。 以下のコードスニペットは、ApplicationCall インスタンスを受け取るカスタムの NotFoundEvent を作成する方法を示しています。
val NotFoundEvent: EventDefinition<ApplicationCall> = EventDefinition()カスタムイベントのセクションでは、サーバーがリソースに対して 404 Not Found ステータスコードを返したときに、カスタムプラグイン内でこのイベントを発生させる方法について説明します。
定義済みのアプリケーションイベント
Ktorは、アプリケーションのライフサイクルに関連する以下の定義済みイベントを提供しています：
- ApplicationStarting
- ApplicationStarted
- ServerReady
- ApplicationStopPreparing
- ApplicationStopping
- ApplicationStopped
例えば、アプリケーションのリソースを解放するために ApplicationStopped イベントをサブスクライブできます。
アプリケーションでのイベント処理
指定された Application インスタンスのイベントを処理するには、monitor プロパティを使用します。 このプロパティは、アプリケーションイベントを処理するための以下の関数を公開する Events インスタンスへのアクセスを提供します：
subscribe: EventDefinition で指定されたイベントをサブスクライブします。unsubscribe: EventDefinition で指定されたイベントのサブスクライブを解除します。raise: 指定された値を使用して、 EventDefinition で指定されたイベントを発生させます。カスタムイベントセクションでは、カスタムイベントを発生させる方法について説明します。
subscribe / unsubscribe 関数は、T 型の値をラムダ引数として受け取る EventDefinition インスタンスを引数に取ります。 以下の例は、ApplicationStarted イベントをサブスクライブし、イベントハンドラーでメッセージをログに記録する方法を示しています：
fun Application.module() {
monitor.subscribe(ApplicationStarted) { application ->
application.environment.log.info("Server is started")
}
}この例では、ApplicationStopped イベントを処理する方法を確認できます：
fun Application.module() {
monitor.subscribe(ApplicationStopped) { application ->
application.environment.log.info("Server is stopped")
// リソースを解放し、イベントの購読を解除する
monitor.unsubscribe(ApplicationStarted) {}
monitor.unsubscribe(ApplicationStopped) {}
}
}完全な例については、eventsを参照してください。
カスタムプラグインでのイベント処理
MonitoringEvent フックを使用して、カスタムプラグイン内でイベントを処理できます。 以下の例は、ApplicationMonitoringPlugin プラグインを作成し、ApplicationStarted と ApplicationStopped イベントを処理する方法を示しています：
import io.ktor.events.EventDefinition
import io.ktor.http.*
import io.ktor.server.application.*
import io.ktor.server.application.hooks.*
val ApplicationMonitoringPlugin = createApplicationPlugin(name = "ApplicationMonitoringPlugin") {
on(MonitoringEvent(ApplicationStarted)) { application ->
application.log.info("Server is started")
}
on(MonitoringEvent(ApplicationStopped)) { application ->
application.log.info("Server is stopped")
// リソースを解放し、イベントの購読を解除する
application.monitor.unsubscribe(ApplicationStarted) {}
application.monitor.unsubscribe(ApplicationStopped) {}
}
}完全な例はこちらにあります。
カスタムイベント
このセクションでは、サーバーがリソースに対して 404 Not Found ステータスコードを返したときに発生するカスタムイベントを作成する方法を見ていきます。
まず、イベント定義を作成する必要があります。 以下のコードスニペットは、
ApplicationCallをパラメータとして受け取るカスタムのNotFoundEventイベントを作成する方法を示しています。kotlinval NotFoundEvent: EventDefinition<ApplicationCall> = EventDefinition()イベントを発生させるには、
Events.raise関数を呼び出します。以下のサンプルは、コールのステータスコードが404の場合に、新しく作成されたイベントを発生させるためにResponseSentフックを処理する方法を示しています。kotlinimport io.ktor.events.EventDefinition import io.ktor.http.* import io.ktor.server.application.* import io.ktor.server.application.hooks.* val ApplicationMonitoringPlugin = createApplicationPlugin(name = "ApplicationMonitoringPlugin") { on(ResponseSent) { call -> if (call.response.status() == HttpStatusCode.NotFound) { this@createApplicationPlugin.application.monitor.raise(NotFoundEvent, call) } } }アプリケーションで作成したイベントを処理するには、プラグインをインストールします：
kotlinfun Application.module() { install(ApplicationMonitoringPlugin) }次に、
Events.subscribeを使用してイベントをサブスクライブします：kotlinfun Application.module() { install(ApplicationMonitoringPlugin) monitor.subscribe(NotFoundEvent) { call -> log.info("No page was found for the URI: ${call.request.uri}") } }
完全な例については、eventsを参照してください。