3.6. 配置可观察性

1. 创建接收事件的服务器进程
2. 扩展 OpenShift Dev Spaces 库以创建向服务器发送事件的后端
3. 在容器中打包遥测后端并将其部署到镜像 registry
4. 为后端添加插件，并指示 OpenShift Dev Spaces 在 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. 如需最新的版本，请参阅 GitHub 软件包，以及 backend-base 的 Maven 协调。

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. 在 ~/.m2/settings.xml 文件中添加您的 GitHub 用户名、个人访问令牌和 che-incubator 存储库详情：

   例 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 接收遥测事件。

验证步骤

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 插件容器是否在 Dev Workspace pod 中运行。在这里，这可以通过检查编辑器中的 Workspace 视图进行验证。

   
2. 在编辑器中编辑文件，并在示例遥测服务器日志中观察其事件。

验证步骤

1. 从 Red Hat OpenShift Dev Spaces 仪表板中启动新的或现有的 Dev Workspace。
2. 按照 第 3.6.2.12 节 “在 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 命名空间。默认值为 openshift-devspaces。

   2

   提取目标的速度。

2. 允许 in-cluster Prometheus 实例检测 OpenShift Dev Spaces 命名空间中的 ServiceMonitor。默认的 OpenShift Dev Spaces 命名空间为 openshift-devspaces。

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

验证

1. 对于 OpenShift Dev Spaces 的新安装，请通过从 Dashboard 创建 OpenShift Dev Spaces 工作区来生成指标。
2. 在 OpenShift Web 控制台的 Administrator 视图中，进入 Observe Metrics。

3. 运行 PromQL 查询以确认指标可用。例如，输入 devworkspace_started_total 并点 Run query。

   如需了解更多指标，请参阅 第 3.6.3.2 节 “dev Workspace 特定指标”。

验证步骤

1. 在 OpenShift Web 控制台的 Administrator 视图中，进入 Observe Dashboards。
2. 前往 Dashboard 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 命名空间。默认值为 openshift-devspaces。

   2

   提取目标的速度。

2. 创建 Role 和 RoleBinding，以允许 Prometheus 查看指标。

   例 3.40. 角色

   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 命名空间。默认值为 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 命名空间。默认值为 openshift-devspaces。

3. 允许 in-cluster Prometheus 实例检测 OpenShift Dev Spaces 命名空间中的 ServiceMonitor。默认的 OpenShift Dev Spaces 命名空间为 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 query。

验证步骤

1. 在 OpenShift Web 控制台的 Administrator 视图中，进入 Observe Dashboards。

2. 进入 Dashboard Dev Workspace Operator，验证仪表板面板是否包含数据。

   图 3.3. 快速事实

   

   图 3.4. JVM 内存

   

   图 3.5. JVM Misc

   

   图 3.6. JVM 内存池(heap)

   

   图 3.7. JVM 内存池(Non-Heap)

   

   图 3.8. 垃圾回收

   

   图 3.9. 类加载

   

   图 3.10. 缓冲池