13.2. Red Hat OpenShift Container Platform の Decision Server の Prometheus メトリクスモニターリングの設定

Prometheus を使用して Red Hat Decision Manger で、ビジネスアセットアクティビティー関連のメトリクスを収集して保存するように、Red Hat OpenShift Container Platform 上の Decision Server デプロイメントを設定できます。Decision Server が Prometheus を使用して公開するメトリクスで、利用可能なものの一覧については、Red Hat カスタマーポータルから Red Hat Decision Manager 7.6.0 Source Distribution をダウンロードし、~/rhdm-7.6.0-sources/src/droolsjbpm-integration-$VERSION/kie-server-parent/kie-server-services/kie-server-services-prometheus/src/main/java/org/kie/server/services/prometheus に移動してください。

前提条件

Decision Server が、Red Hat OpenShift Container Platform にインストールおよびデプロイされている。OpenShift 上の Decision Server の詳細については、Red Hat Decision Manager 7.6 の製品ドキュメントで関連する OpenShift デプロイメントオプションを参照してください。
kie-server ユーザーロールで Decision Server にアクセスできる。
Prometheus Operator がインストールされている。Prometheus Operator のダウンロードと使用についての詳細は、GitHub の Prometheus Operator プロジェクトを参照してください。

手順

OpenShift 上の Decision Server デプロイメントの DeploymentConfig オブジェクトで、PROMETHEUS_SERVER_EXT_DISABLED 環境変数を false に設定して、Prometheus 拡張機能を有効にします。この変数は、OpenShift Web コンソールを使用するか、コマンド端末で oc コマンドを使用してこの変数を設定してください。
```
oc set env dc/<dc_name> PROMETHEUS_SERVER_EXT_DISABLED=false -n <namespace>
```
```
oc set env dc/<dc_name> PROMETHEUS_SERVER_EXT_DISABLED=false -n <namespace>
```
Copy to Clipboard Toggle word wrap
OpenShift に Decision Server をまだデプロイしていない場合には、OpenShift デプロイメントに使用予定の OpenShift テンプレートで (例: rhdm76-prod-immutable-kieserver.yaml)、PROMETHEUS_SERVER_EXT_DISABLED テンプレートパラメーターを false に設定して、Prometheus 拡張機能を有効にします。
OpenShift Operator を使用して Decision Server を OpenShift にデプロイする場合、Decision Server の設定で、PROMETHEUS_SERVER_EXT_DISABLED 環境変数を false に設定して、Prometheus 拡張機能を有効にします。
```
apiVersion: app.kiegroup.org/v1
kind: KieApp
metadata:
  name: enable-prometheus
spec:
  environment: rhpam-trial
  objects:
    servers:
    - env:
      - name: PROMETHEUS_SERVER_EXT_DISABLED
        value: "false"
```
```
apiVersion: app.kiegroup.org/v1
kind: KieApp
metadata:
  name: enable-prometheus
spec:
  environment: rhpam-trial
  objects:
    servers:
    - env:
      - name: PROMETHEUS_SERVER_EXT_DISABLED
        value: "false"
```
Copy to Clipboard Toggle word wrap

service-metrics.yaml ファイルを作成して、Decision Server から Prometheus にメトリクスを公開するサービスを追加します。

apiVersion: v1
kind: Service
metadata:
  annotations:
    description: RHDM Prometheus metrics exposed
  labels:
    app: myapp-kieserver
    application: myapp-kieserver
    template: myapp-kieserver
    metrics: rhdm
  name: rhdm-app-metrics
spec:
  ports:
    - name: web
      port: 8080
      protocol: TCP
      targetPort: 8080
  selector:
    deploymentConfig: myapp-kieserver
  sessionAffinity: None
  type: ClusterIP

apiVersion: v1
kind: Service
metadata:
  annotations:
    description: RHDM Prometheus metrics exposed
  labels:
    app: myapp-kieserver
    application: myapp-kieserver
    template: myapp-kieserver
    metrics: rhdm
  name: rhdm-app-metrics
spec:
  ports:
    - name: web
      port: 8080
      protocol: TCP
      targetPort: 8080
  selector:
    deploymentConfig: myapp-kieserver
  sessionAffinity: None
  type: ClusterIP

Copy to Clipboard

Toggle word wrap

コマンドターミナルで、oc コマンドを使用して、service-metrics.yaml ファイルを OpenShift デプロイメントに適用します。
```
oc apply -f service-metrics.yaml
```
```
oc apply -f service-metrics.yaml
```
Copy to Clipboard Toggle word wrap
metrics-secret など、OpenShift シークレットを作成して、Decision Server の Prometheus メトリクスにアクセスします。シークレットには username と password 要素と Decision Server ユーザー資格情報が含まれている必要があります。OpenShift シークレットの詳細は、OpenShift 開発者ガイドのシークレットの章を参照してください。

ServiceMonitor オブジェクトを定義する service-monitor.yaml ファイルを作成します。サービスモニターにより Prometheus を Decision Server メトリクスサービスに接続できます。

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: rhdm-service-monitor
  labels:
    team: frontend
spec:
  selector:
    matchLabels:
      metrics: rhdm
  endpoints:
    - port: web
      path: /services/rest/metrics
      basicAuth:
        password:
          name: metrics-secret
          key: password
        username:
          name: metrics-secret
          key: username

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: rhdm-service-monitor
  labels:
    team: frontend
spec:
  selector:
    matchLabels:
      metrics: rhdm
  endpoints:
    - port: web
      path: /services/rest/metrics
      basicAuth:
        password:
          name: metrics-secret
          key: password
        username:
          name: metrics-secret
          key: username

Copy to Clipboard

Toggle word wrap

コマンド端末で、oc コマンドを使用して、service-monitor.yaml ファイルを OpenShift デプロイメントに適用します。
```
oc apply -f service-monitor.yaml
```
```
oc apply -f service-monitor.yaml
```
Copy to Clipboard Toggle word wrap
上記の設定を完了すると、Prometheus はメトリクスの収集を開始し、Decision Server は REST API エンドポイント http://HOST:PORT/kie-server/services/rest/metrics にメトリクスを公開します。
http://HOST:PORT/graph の Prometheus expression browser で収集したメトリクスと対話したり、Prometheus データソースを Grafana などのデータグラフ作成ツールと統合したりすることができます。
Prometheus expression browser の場所のホストとポートである http://HOST:PORT/graph は、Prometheus Operator をインストールしたときに Prometheus Web コンソールを公開したルートで定義されています。OpenShift ルートの詳細は、OpenShift アーキテクチャードキュメントのルートの章を参照してください。
図13.5 Prometheus expression browser と Decision Server メトリクス

図13.6 Prometheus expression browser と Decision Server ターゲット

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

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