コンテンツにスキップ

HikariCP

HikariCP 関連のメトリクスを収集

設定

DataKit コレクターによる収集

  • statsd コレクターを有効にする

DataKit インストールディレクトリ内の conf.d/samples に移動し、statsd.conf.sample を statsd.conf にコピーします。

mkdir -p ../statsd
cp statsd.conf.sample ../statsd/statsd.conf

statsd.conf で protocol = "udp" と service_address = ":8125" が設定されていることを確認し、parse_data_dog_tags = true を有効にして、コネクションプールの pool タグを保持します。

  • アプリケーションのトレースも収集する場合は、ddtrace コレクターを有効にする

DataKit インストールディレクトリ内の conf.d/ddtrace に移動し、ddtrace.conf.sample を ddtrace.conf にコピーします。

cp ddtrace.conf.sample ddtrace.conf

  • コレクターの設定を変更したら、次のコマンドを実行して DataKit を再起動する
datakit service -R

クライアントの設定

データソースの種類に応じて MBean を有効にし、JMXFetch と起動オプションを設定します。

Spring Boot の単一データソース

Spring Boot の単一データソースでは、register-mbeans=true を使用します。

spring.datasource.url=jdbc:mysql://xx.xxx.xx.xxx:3306/test?useSSL=false&useLegacyDatetimeCode=false&allowPublicKeyRetrieval=true
spring.datasource.username=***
spring.datasource.password=*****
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.maximum-pool-size=10
spring.datasource.hikari.minimum-idle=5
spring.datasource.hikari.idle-timeout=300000
spring.datasource.hikari.max-lifetime=1800000
spring.datasource.hikari.connection-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.register-mbeans=true

dynamic-datasource による複数データソース

dynamic-datasource(この例では 4.3.1)を使用する場合は、次のフィールドを既存の設定に追加し、データソース名を実際の設定に合わせて置き換えます。

spring:
  datasource:
    dynamic:
      datasource:
        master:
          hikari:
            is-register-mbeans: true
        slave:
          hikari:
            is-register-mbeans: true

spring.datasource.dynamic.hikari.is-register-mbeans=true をグローバルに設定することもできます。各データソースの個別設定が優先されます。

パラメーター名は is-register-mbeans です。変更後はアプリケーションを再起動してください。カスタムの pool-name はデータソースの url と同じ階層に配置し、プール名はそれぞれ一意にする必要があります。

JMXFetch の設定

  • dd-java-agent をダウンロードする

SDK

  • 次の内容で hikaricp.yaml ファイルを作成する
init_config:

instances:
  - jvm_direct: true
    name: hikari-slick-monitoring
    collect_default_jvm_metrics: false
    collect_default_metrics: false
    refresh_beans: 60
    conf:
      - include:
          bean_regex: "com.zaxxer.hikari:type=Pool \\((.*)\\)"
          tags:
            pool: $1
          attribute:
            ActiveConnections:
              metric_type: gauge
              alias: hikaricp.connections.active
            IdleConnections:
              metric_type: gauge
              alias: hikaricp.connections.idle
            TotalConnections:
              metric_type: gauge
              alias: hikaricp.connections.total
            ThreadsAwaitingConnection:
              metric_type: gauge
              alias: hikaricp.connections.pending
      - include:
          bean_regex: "com.zaxxer.hikari:type=PoolConfig \\((.*)\\)"
          tags:
            pool: $1
          attribute:
            MaximumPoolSize:
              metric_type: gauge
              alias: hikaricp.pool.size.max
            IdleTimeout:
              metric_type: gauge
              alias: hikaricp.idle.timeout
            MaxLifetime:
              metric_type: gauge
              alias: hikaricp.max.lifetime
            MinimumIdle:
              metric_type: gauge
              alias: hikaricp.min.idle
            ConnectionTimeout:
              metric_type: gauge
              alias: hikaricp.connections.timeout
            ValidationTimeout:
              metric_type: gauge
              alias: hikaricp.validation.timeout
            LeakDetectionThreshold:
              metric_type: gauge
              alias: hikaricp.leak.detection.threshold

起動オプションの設定

次のコマンドは、アプリケーションと DataKit が同じホストで実行されている場合の例です。

java \
-javaagent:/xxx/dd-java-agent.jar \
-Ddd.agent.port=9529 \
-Ddd.service=demo \
-Ddd.jmxfetch.check-period=1000 \
-Ddd.jmxfetch.enabled=true \
-Ddd.jmxfetch.config.dir=/xxx/ \
-Ddd.jmxfetch.config=hikaricp.yaml \
-Ddd.jmxfetch.statsd.host=127.0.0.1 \
-Ddd.jmxfetch.statsd.port=8125 \
-jar xxxx.jar

config.dir は、アプリケーションプロセスが読み取れる JMX 設定ディレクトリです。ファイル名は config パラメーターと一致させてください。すべての -D オプションは -jar の前に配置します。

アプリケーションと DataKit が異なる Pod で実行される場合は、statsd.host を実際の Service アドレス(例:datakit-service.datakit.svc.cluster.local)に変更し、UDP ポート 8125 に到達できることを確認します。

収集結果の確認

起動後、各プールの Hikari MBean が登録され、DataKit StatsD の受信件数が継続的に増加していることを確認します。その後、Guance の hikaricp メジャーメントでデータをクエリし、pool タグでコネクションプールを区別します。

メトリクス

hikaricp メジャーメント

HikariCP のメトリクスは hikaricp メジャーメントに格納されます。次の表で各メトリクスについて説明します。

Metrics 説明 用途 単位
connections_active 現在アクティブなデータベース接続数 アプリケーションが現在使用している接続の数を示します count
connections_idle 現在アイドル状態のデータベース接続数 使用されておらず、アイドル状態にある接続の数を示します count
connections_pending 現在接続の取得を待機しているリクエスト数 値が高い場合、現在の同時実行の需要に対してコネクションプールのサイズが不足している可能性があります count
connections_total 現在のコネクションプール内のデータベース接続総数 アクティブ接続とアイドル接続の両方を含みます count
idle_timeout 接続がアイドル状態で存続できる最大時間 設定項目。接続のアイドル時間がこの値を超えると、プールはその接続を閉じます ms
leak_detection_threshold 接続リークの検出しきい値 設定項目。接続の使用時間がこのしきい値を超えると、プールは接続リークの可能性があると判断し、警告を出します ms
max_lifetime 接続の最大存続時間 設定項目。接続の作成から終了までの総存続時間は、この値を超えることができません ms
min_idle プール内のアイドル接続の最小数 設定項目。新しいリクエストに迅速に応答できるよう、プールは少なくともこの数のアイドル接続を維持します count
pool_size_max プール内で許可される最大接続数 設定項目。プールサイズを制限し、過剰な接続によるリソースの過剰消費を防ぎます count
validation_timeout 接続検証のタイムアウト時間 設定項目。プールから接続を取得する際に接続の有効性を検証し、検証時間がこの値を超えると失敗と判断します ms
connections_timeout 接続タイムアウト時間 設定項目。接続を確立するまでの最大待機時間です ms

フィードバック

このページは役に立ちましたか?