3.6. 可観測性の設定

1. イベントを受信するサーバープロセスの作成
2. イベントをサーバーに送信するバックエンドを作成する OpenShift Dev Spaces ライブラリーの拡張
3. コンテナーでの Telemetry バックエンドのパッケージ化およびイメージレジストリーへのデプロイ
4. バックエンドのプラグインを追加し、OpenShift Dev Space に Dev Workspaces にプラグインを読み込むよう指示

1. Maven Quarkus プロジェクトのスキャフォールディング:

   mvn io.quarkus:quarkus-maven-plugin:2.7.1.Final:create \
       -DprojectGroupId=mygroup -DprojectArtifactId=devworkspace-telemetry-example-plugin \
   -DprojectVersion=1.0.0-SNAPSHOT

2. src/main/java/mygroup と src/test/java/mygroup の下にあるファイルを削除します。
3. backend-base の最新バージョンおよび Maven コーディネートについては、GitHub パッケージ を参照してください。

4. 以下の依存関係を pom.xml に追加します。

   例3.21 pom.xml

   <!-- Required -->
   <dependency>
       <groupId>org.eclipse.che.incubator.workspace-telemetry</groupId>
       <artifactId>backend-base</artifactId>
       <version>LATEST VERSION FROM PREVIOUS STEP</version>
   </dependency>
   
   
   <!-- Used to make http requests to the telemetry server -->
   <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-rest-client</artifactId>
   </dependency>
   <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-rest-client-jackson</artifactId>
   </dependency>

5. read:packages パーミッションでパーソナルアクセストークンを作成し、GitHub パッケージ から org.eclipse.che.incubator.workspace-telemetry:backend-base 依存関係をダウンロードします。

6. GitHub ユーザー名、パーソナルアクセストークン、che-incubator リポジトリーの詳細を ~/.m2/settings.xml ファイルに追加します。

   例3.22 settings.xml

   <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
   http://maven.apache.org/xsd/settings-1.0.0.xsd">
      <servers>
         <server>
            <id>che-incubator</id>
            <username>YOUR GITHUB USERNAME</username>
            <password>YOUR GITHUB TOKEN</password>
         </server>
      </servers>
   
      <profiles>
         <profile>
            <id>github</id>
            <activation>
               <activeByDefault>true</activeByDefault>
            </activation>
            <repositories>
               <repository>
                  <id>central</id>
                  <url>https://repo1.maven.org/maven2</url>
                  <releases><enabled>true</enabled></releases>
                  <snapshots><enabled>false</enabled></snapshots>
                  </repository>
                  <repository>
                  <id>che-incubator</id>
                  <url>https://maven.pkg.github.com/che-incubator/che-workspace-telemetry-client</url>
               </repository>
            </repositories>
         </profile>
      </profiles>
   </settings>

1. Dev Workspace に DEVWORKSPACE_TELEMETRY_BACKEND_PORT 環境変数を設定します。ここで、値は 4167 に設定されます。

   spec:
     template:
       attributes:
         workspaceEnv:
           - name: DEVWORKSPACE_TELEMETRY_BACKEND_PORT
             value: '4167'

2. Red Hat OpenShift Dev Spaces ダッシュボードから Dev Workspace を再起動します。

3. Dev Workspace のターミナルウィンドウ内で以下のコマンドを実行し、アプリケーションを起動します。--settings フラグを使用して、GitHub アクセストークンが含まれる settings.xml ファイルの場所へのパスを指定します。

   $ mvn --settings=settings.xml quarkus:dev -Dquarkus.http.port=${DEVWORKSPACE_TELEMETRY_BACKEND_PORT}

   アプリケーションは、フロントエンドプラグインからポート 4167 を使用して Telemetry イベントを受け取るようになりました。

検証手順

1. 以下の出力がログに記録されていることを確認します。

   INFO  [org.ecl.che.inc.AnalyticsManager] (Quarkus Main Thread) No welcome message provided
   INFO  [io.quarkus] (Quarkus Main Thread) devworkspace-telemetry-example-plugin 1.0.0-SNAPSHOT on JVM (powered by Quarkus 2.7.2.Final) started in 0.323s. Listening on: http://localhost:4167
   INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.
   INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, kubernetes-client, rest-client, rest-client-jackson, resteasy, resteasy-jsonb, smallrye-context-propagation, smallrye-openapi, swagger-ui, vertx]

2. AnalyticsManager の onEvent() メソッドがフロントエンドプラグインからイベントを受信することを確認するには、l キーを押して Quarkus ライブコーディングを無効にし、IDE 内のファイルを編集します。以下の出力がログに記録されるはずです。

   INFO  [io.qua.dep.dev.RuntimeUpdatesProcessor] (Aesh InputStream Reader) Live reload disabled
   INFO  [org.ecl.che.inc.AnalyticsManager] (executor-thread-2) The received event is: Edit Workspace File in Che

1. 以下を既存の Dev Workspace の components フィールドに追加します。

   components:
     ...
     - name: telemetry-plugin
       plugin:
         uri: http://apache-che.apps-crc.testing/plugin.yaml

2. OpenShift Dev Spaces ダッシュボードから Dev Workspace を起動します。

検証手順

1. Telemetry-plug-in コンテナーが Dev Workspace Pod で稼働していることを確認します。ここでは、これはエディターで Workspace ビューをチェックして検証されます。

   
2. エディター内のファイルを編集し、Telemetry サーバーのログのサンプルでイベントを確認します。

検証手順

1. Red Hat OpenShift Dev Spaces ダッシュボードから新規または既存の Dev Workspace を起動します。
2. 「Dev Workspace での Telemetry プラグインの指定」 の検証手順に従って、Telemetry プラグインが機能していることを確認します。

手順

1. Dev Workspace Operator メトリックサービスを検出するための ServiceMonitor を作成します。

   例3.38 ServiceMonitor

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: devworkspace-controller
     namespace: openshift-devspaces 1
   spec:
     endpoints:
       - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
         interval: 10s 2
         port: metrics
         scheme: https
         tlsConfig:
           insecureSkipVerify: true
     namespaceSelector:
       matchNames:
         - openshift-operators
     selector:
       matchLabels:
         app.kubernetes.io/name: devworkspace-controller

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   2

   ターゲットが収集されるレート。

2. クラスター内の Prometheus インスタンスが OpenShift Dev Spaces namespace 内の ServiceMonitor を検出できるようにします。デフォルトの OpenShift Dev Spaces namespace はopenshift-devspaces です。

   $ oc label namespace openshift-devspaces openshift.io/cluster-monitoring=true

検証

1. OpenShift Dev Spaces を新規インストールする場合は、ダッシュボードから OpenShift Dev Spaces ワークスペースを作成してメトリックを生成します。
2. OpenShift Web コンソールの Administrator ビューで、Observe Metrics に移動します。

3. PromQL クエリーを実行して、メトリックが利用可能であることを確認します。たとえば、devworkspace_started_total を入力し、Run queries をクリックします。

   その他のメトリクスは、「Dev Workspace 固有のメトリック」 を参照してください。

検証手順

1. OpenShift Web コンソールの Administrator ビューで、Observe Dashboards に移動します。
2. Danshboard Che Server JVM に移動し、ダッシュボードパネルにデータが含まれていることを確認します。

手順

1. OpenShift Dev Spaces JVM メトリックサービスを検出するための ServiceMonitor を作成します。

   例3.39 ServiceMonitor

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: che-host
     namespace: openshift-devspaces 1
   spec:
     endpoints:
       - interval: 10s 2
         port: metrics
         scheme: http
     namespaceSelector:
       matchNames:
         - openshift-devspaces 3
     selector:
       matchLabels:
         app.kubernetes.io/name: devspaces

   1 3

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   2

   ターゲットが収集されるレート。

2. Prometheus がメトリックを表示できるようにするには、Role と RoleBinding を作成します。

   例3.40 Role

   kind: Role
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     name: prometheus-k8s
     namespace: openshift-devspaces 1
   rules:
     - verbs:
         - get
         - list
         - watch
       apiGroups:
         - ''
       resources:
         - services
         - endpoints
         - pods

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   例3.41 RoleBinding

   kind: RoleBinding
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     name: view-devspaces-openshift-monitoring-prometheus-k8s
     namespace: openshift-devspaces 1
   subjects:
     - kind: ServiceAccount
       name: prometheus-k8s
       namespace: openshift-monitoring
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: Role
     name: prometheus-k8s

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

3. クラスター内の Prometheus インスタンスが OpenShift Dev Spaces namespace 内の ServiceMonitor を検出できるようにします。デフォルトの OpenShift Dev Spaces namespace はopenshift-devspaces です。

   $ oc label namespace openshift-devspaces openshift.io/cluster-monitoring=true

検証

1. OpenShift Web コンソールの Administrator ビューで、Observe Metrics に移動します。
2. PromQL クエリーを実行して、メトリックが利用可能であることを確認します。たとえば、process_uptime_seconds{job="che-host"} と入力し、Run queries をクリックします。

検証手順

1. OpenShift Web コンソールの Administrator ビューで、Observe Dashboards に移動します。

2. Dashboard Dev Workspace Operator に移動し、ダッシュボードパネルにデータが含まれていることを確認します。

   図3.3 クイックファクト

   

   図3.4 JVM メモリー

   

   図3.5 JVM Misc

   

   図3.6 JVM メモリープール (ヒープ)

   

   図3.7 JVM メモリープール (非ヒープ)

   

   図3.8 ガベージコレクション

   

   図3.9 クラスローディング

   

   図3.10 バッファープール