Skip to content
Server Plugin

Dropwizardメトリクス

必要な依存関係: io.ktor:ktor-server-metrics

コード例: dropwizard-metrics

ネイティブサーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✖️

DropwizardMetricsプラグインを使用すると、Metricsライブラリを設定して、サーバーや受信リクエストに関する有用な情報を取得できます。

依存関係の追加 ​

DropwizardMetricsを有効にするには、ビルドスクリプトに以下のアーティファクトを含める必要があります:

  • ktor-server-metrics依存関係を追加します:

    kotlin
    implementation(ktorLibs.server.metrics)
    上記のコードスニペットでは、Ktorの依存関係を指定するために Ktorバージョンカタログを使用しています。
    groovy
    implementation ktorLibs.server.metrics
    上記のコードスニペットでは、Ktorの依存関係を指定するために Ktorバージョンカタログを使用しています。
    xml
    <dependency>
        <groupId>io.ktor</groupId>
        <artifactId>ktor-server-metrics-jvm</artifactId>
        <version>${ktor_version}</version>
    </dependency>
  • 必要に応じて、特定のレポーターに必要な依存関係を追加します。以下の例は、JMX経由でメトリクスをレポートするために必要なアーティファクトを追加する方法を示しています:

    kotlin
    implementation("io.dropwizard.metrics:metrics-jmx:$dropwizard_version")
    groovy
    implementation "io.dropwizard.metrics:metrics-jmx:$dropwizard_version"
    xml
    <dependency>
        <groupId>io.dropwizard.metrics</groupId>
        <artifactId>metrics-jmx</artifactId>
        <version>${dropwizard_version}</version>
    </dependency>

    $dropwizard_versionは、必要なmetrics-jmxアーティファクトのバージョン(例: 4.2.40)に置き換えることができます。

DropwizardMetricsのインストール ​

DropwizardMetricsプラグインをアプリケーションにインストールするには、 指定したモジュールモジュールを使用すると、ルートをグループ化してアプリケーションを構造化できます。内のinstall関数に渡します。 以下の例は、DropwizardMetricsをインストールする方法を示しています:

  • embeddedServer()関数の呼び出し内。
  • Applicationクラスに明示的に定義されたmodule()拡張関数内。
kotlin
import io.ktor.server.engine.*
import io.ktor.server.netty.*
import io.ktor.server.application.*
import io.ktor.server.metrics.dropwizard.*

fun main() {
    embeddedServer(Netty, port = 8080) {
        install(DropwizardMetrics)
        // ...
    }.start(wait = true)
}
kotlin
import io.ktor.server.application.*
import io.ktor.server.metrics.dropwizard.*
// ...
fun Application.module() {
    install(DropwizardMetrics)
    // ...
}

DropwizardMetricsの設定 ​

DropwizardMetricsでは、registryプロパティを使用して、サポートされている任意のメトリクスレポーターを使用できます。SLF4JおよびJMXレポーターを設定する方法を見てみましょう。

SLF4Jレポーター ​

SLF4Jレポーターを使用すると、SLF4Jがサポートする任意の出力先に定期的にレポートを出力できます。 例えば、メトリクスを10秒ごとに出力するには、次のように記述します:

kotlin
install(DropwizardMetrics) {
    Slf4jReporter.forRegistry(registry)
        .outputTo(this@module.log)
        .convertRatesTo(TimeUnit.SECONDS)
        .convertDurationsTo(TimeUnit.MILLISECONDS)
        .build()
        .start(10, TimeUnit.SECONDS)
}

完全なサンプルコードはこちらで確認できます: dropwizard-metrics。

アプリケーションを実行してhttp://0.0.0.0:8080を開くと、出力は以下のようになります:

Bash
[DefaultDispatcher-worker-1] INFO  Application - Responding at http://0.0.0.0:8080
... type=COUNTER, name=ktor.calls.active, count=0
... type=METER, name=ktor.calls./(method:GET).200, count=6, m1_rate=1.2, m5_rate=1.2, m15_rate=1.2, mean_rate=0.98655785084844, rate_unit=events/second
... type=METER, name=ktor.calls./(method:GET).meter, count=6, m1_rate=1.2, m5_rate=1.2, m15_rate=1.2, mean_rate=0.9841134429134598, rate_unit=events/second
... type=METER, name=ktor.calls.exceptions, count=0, m1_rate=0.0, m5_rate=0.0, m15_rate=0.0, mean_rate=0.0, rate_unit=events/second
... type=METER, name=ktor.calls.status.200, count=6, m1_rate=1.2, m5_rate=1.2, m15_rate=1.2, mean_rate=0.9866015088545449, rate_unit=events/second
... type=TIMER, name=ktor.calls./(method:GET).timer, count=6, min=0.359683, max=14.213046, mean=2.691307542732234, stddev=5.099546889849414, p50=0.400967, p75=0.618972, p95=14.213046, p98=14.213046, p99=14.213046, p999=14.213046, m1_rate=1.2, m5_rate=1.2, m15_rate=1.2, mean_rate=0.9830677128229028, rate_unit=events/second, duration_unit=milliseconds
... type=TIMER, name=ktor.calls.duration, count=6, min=0.732149, max=33.735719, mean=6.238046092985701, stddev=12.169258340009847, p50=0.778864, p75=1.050454, p95=33.735719, p98=33.735719, p99=33.735719, p999=33.735719, m1_rate=0.2, m5_rate=0.2, m15_rate=0.2, mean_rate=0.6040311229887146, rate_unit=events/second, duration_unit=milliseconds

JMXレポーター ​

JMXレポーターを使用すると、すべてのメトリクスをJMXに公開し、jconsoleを使用してそれらのメトリクスを確認できるようになります。

kotlin
install(DropwizardMetrics) {
    JmxReporter.forRegistry(registry)
        .convertRatesTo(TimeUnit.SECONDS)
        .convertDurationsTo(TimeUnit.MILLISECONDS)
        .build()
        .start()
}

完全なサンプルコードはこちらで確認できます: dropwizard-metrics。

アプリケーションを実行し、JConsoleを使用してそのプロセスに接続すると、メトリクスは以下のようになります:

Ktor Metrics: JMX

公開されるメトリクス ​

DropwizardMetricsは以下のメトリクスを公開します:

グローバルメトリクス ​

グローバルメトリクスには、以下のKtor固有のメトリクスが含まれます:

  • ktor.calls.active:Count - 未完了のアクティブなリクエストの数。
  • ktor.calls.duration - コールの所要時間に関する情報。
  • ktor.calls.exceptions - 例外の数に関する情報。
  • ktor.calls.status.NNN - 特定のHTTPステータスコードNNNが発生した回数に関する情報。

メトリクス名はktor.callsプレフィックスで始まる点に注意してください。これはbaseNameプロパティを使用してカスタマイズできます:

kotlin
install(DropwizardMetrics) {
    baseName = "my.prefix"
}

エンドポイントごとのメトリクス ​

  • "/uri(method:VERB).NNN" - このパスおよびHTTPメソッド(動詞)に対して、特定のHTTPステータスコードNNNが発生した回数に関する情報。
  • "/uri(method:VERB).meter" - このパスおよびHTTPメソッドに対するコール数に関する情報。
  • "/uri(method:VERB).timer" - このエンドポイントの所要時間に関する情報。

JVMメトリクス ​

HTTPメトリクスに加えて、KtorはJVMを監視するための一連のメトリクスを公開します。これらのメトリクスはregisterJvmMetricSetsプロパティを使用して無効化できます:

kotlin
install(DropwizardMetrics) {
    registerJvmMetricSets = false
}

完全なサンプルコードはこちらで確認できます: dropwizard-metrics。