第13章 Red Hat Decision Manager の Prometheus メトリクスのモニターリング

手順

1. KIE Server インスタンスで、org.kie.prometheus.server.ext.disabled システムプロパティーを false に設定して、Prometheus 拡張機能を有効にします。このプロパティーは、KIE Server の起動時、または Red Hat Decision Manager ディストリビューションの standalone.xml または standalone-full.xml ファイルで定義できます。

2. Spring Boot で Red Hat Decision Manager を実行する場合は、application.properties システムプロパティーで必要なキーを設定します。

   Red Hat Decision Manager および Prometheus の Spring Boot application.properties キー

   kieserver.drools.enabled=true
   kieserver.dmn.enabled=true
   kieserver.prometheus.enabled=true

   Copy to Clipboard Toggle word wrap

3. Prometheus ディストリビューションの prometheus.yaml ファイルで、scrape_configs セクションに以下の設定を追加して、Prometheus が KIE Server からメトリクスを収集 (scrape) するように設定します。

   prometheus.yaml ファイルの Scrape 設定

   scrape_configs:
     - job_name: 'kie-server'
       metrics_path: /SERVER_PATH/services/rest/metrics
       basicAuth:
         username: USER_NAME
         password: PASSWORD
       static_configs:
         - targets: ["HOST:PORT"]

   Copy to Clipboard Toggle word wrap

   Spring Boot の prometheus.yaml ファイルでの Scrape 設定 (該当する場合)

   scrape_configs:
     - job_name: 'kie'
       metrics_path: /rest/metrics
       static_configs:
         - targets: ["HOST:PORT"]

   Copy to Clipboard Toggle word wrap

   KIE Server の場所と設定に合わせて、値を置き換えます。

4. KIE Server インスタンスを起動します。

   Red Hat JBoss EAP での Red Hat Decision Manager の起動コマンド例

   $ cd ~/EAP_HOME/bin
   $ ./standalone.sh --c standalone-full.xml

   Copy to Clipboard Toggle word wrap

   設定済みの KIE Server インスタンスを起動すると、Prometheus はメトリクスの収集を開始し、KIE Server はメトリクスを REST API エンドポイント http://HOST:PORT/SERVER/services/rest/metrics (または Spring Boot では http://HOST:PORT/rest/metrics) に公開します。

5. REST クライアントまたは curl ユーティリティーで、以下のコンポーネントを含む REST API 要求を送信し、KIE Server がメトリクスを公開していることを確認します。

   REST クライアントの場合:

   • Authentication: kie-server ロールを持つ KIE Server ユーザーのユーザー名とパスワードを入力します。

   • HTTP Headers: 以下のヘッダーを設定します。

     • Accept: application/json
   • HTTP method: GET に設定します。
   • URL: KIE Server REST API ベース URL とメトリクスエンドポイントを入力します。たとえば、http://localhost:8080/kie-server/services/rest/metrics (または Spring Boot では http://localhost:8080/rest/metrics) となります。

   curl ユーティリティーの場合:

   • -u: kie-server ロールを持つ KIE Server ユーザーのユーザー名とパスワードを入力します。

   • -H: 以下のヘッダーを設定します。

     • accept: application/json
   • -X: GET に設定します。
   • URL: KIE Server REST API ベース URL とメトリクスエンドポイントを入力します。たとえば、http://localhost:8080/kie-server/services/rest/metrics (または Spring Boot では http://localhost:8080/rest/metrics) となります。

   Red Hat JBoss EAP での Red Hat Decision Manager の curl コマンド例

   curl -u 'baAdmin:password@1' -X GET "http://localhost:8080/kie-server/services/rest/metrics"

   Copy to Clipboard Toggle word wrap

   Spring Boot での Red Hat Decision Manager の curl コマンド例

   curl -u 'baAdmin:password@1' -X GET "http://localhost:8080/rest/metrics"

   Copy to Clipboard Toggle word wrap

   サーバーの応答例

   # HELP kie_server_container_started_total Kie Server Started Containers
   # TYPE kie_server_container_started_total counter
   kie_server_container_started_total{container_id="task-assignment-kjar-1.0",} 1.0
   # HELP solvers_running Number of solvers currently running
   # TYPE solvers_running gauge
   solvers_running 0.0
   # HELP dmn_evaluate_decision_nanosecond DMN Evaluation Time
   # TYPE dmn_evaluate_decision_nanosecond histogram
   # HELP solver_duration_seconds Time in seconds it took solver to solve the constraint problem
   # TYPE solver_duration_seconds summary
   solver_duration_seconds_count{solver_id="100tasks-5employees.xml",} 1.0
   solver_duration_seconds_sum{solver_id="100tasks-5employees.xml",} 179.828255925
   solver_duration_seconds_count{solver_id="24tasks-8employees.xml",} 1.0
   solver_duration_seconds_sum{solver_id="24tasks-8employees.xml",} 179.995759653
   # HELP drl_match_fired_nanosecond Drools Firing Time
   # TYPE drl_match_fired_nanosecond histogram
   # HELP dmn_evaluate_failed_count DMN Evaluation Failed
   # TYPE dmn_evaluate_failed_count counter
   # HELP kie_server_start_time Kie Server Start Time
   # TYPE kie_server_start_time gauge
   kie_server_start_time{name="myapp-kieserver",server_id="myapp-kieserver",location="http://myapp-kieserver-demo-monitoring.127.0.0.1.nip.io:80/services/rest/server",version="7.4.0.redhat-20190428",} 1.557221271502E12
   # HELP kie_server_container_running_total Kie Server Running Containers
   # TYPE kie_server_container_running_total gauge
   kie_server_container_running_total{container_id="task-assignment-kjar-1.0",} 1.0
   # HELP solver_score_calculation_speed Number of moves per second for a particular solver solving the constraint problem
   # TYPE solver_score_calculation_speed summary
   solver_score_calculation_speed_count{solver_id="100tasks-5employees.xml",} 1.0
   solver_score_calculation_speed_sum{solver_id="100tasks-5employees.xml",} 6997.0
   solver_score_calculation_speed_count{solver_id="24tasks-8employees.xml",} 1.0
   solver_score_calculation_speed_sum{solver_id="24tasks-8employees.xml",} 19772.0

   Copy to Clipboard Toggle word wrap

   KIE Server でメトリクスが利用できない場合は、このセクションで説明されている KIE Server および Prometheus の設定を確認します。

   また、http://HOST:PORT/graph の Prometheus の expression browser で収集したメトリクスと対話したり、Prometheus データソースを Grafana などのデータグラフ作成ツールと統合したりすることもできます。

   図13.1 Prometheus expression browser と KIE Server メトリクス

   

   図13.2 Prometheus expression browser と KIE Server ターゲット

   

   図13.3 Grafana ダッシュボードと DMN モデルの KIE Server メトリクス

   

   図13.4 Grafana ダッシュボードとソルバーの KIE Server メトリクス