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 软件包 以获取最新版本的 Maven 与 backend-base 协调。

4. 在 pom.xml 中添加以下依赖项：

   例 3.13. 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.14. 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. 通过创建 TelemetryService.java来设置 RESTEasy REST 客户端

   例 3.19. TelemetryService.java

   package org.my.group;
   
   import java.util.Map;
   
   import javax.ws.rs.Consumes;
   import javax.ws.rs.POST;
   import javax.ws.rs.Path;
   import javax.ws.rs.core.MediaType;
   import javax.ws.rs.core.Response;
   
   import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
   
   @RegisterRestClient
   public interface TelemetryService {
       @POST
       @Path("/event") 1
       @Consumes(MediaType.APPLICATION_JSON)
       Response sendEvent(Map<String, Object> payload);
   }

   1

   为 POST 请求发出的端点。

2. 在 src/main/resources/application.properties 文件中指定 TelemetryService 的基本 URL：

   例 3.20. application.properties

   org.my.group.TelemetryService/mp-rest/url=http://little-telemetry-server-che.apps-crc.testing

3. 将 TelemetryService 注入 AnalyticsManager 并在 Event （）中发送 POST 请求

   例 3.21. AnalyticsManager.java

   @Dependent
   @Alternative
   public class AnalyticsManager extends AbstractAnalyticsManager {
       @Inject
       @RestClient
       TelemetryService telemetryService;
   
   ...
   
   @Override
   public void onEvent(AnalyticsEvent event, String ownerId, String ip, String userAgent, String resolution, Map<String, Object> properties) {
       Map<String, Object> payload = new HashMap<String, Object>(properties);
       payload.put("event", event);
       telemetryService.sendEvent(payload);
   }

   这会发送 HTTP 请求到遥测服务器，并在小时间内自动延迟相同的事件。默认持续时间为 1500 毫秒。

1. 在现有 Dev Workspace 的 components 字段中添加以下内容：

   components:
     ...
     - name: telemetry-plug-in
       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. 在编辑器中编辑文件，并在示例遥测服务器日志中观察其事件。

验证步骤

1. 从 Red Hat OpenShift Dev Spaces 仪表板启动新的或现有的 Dev Workspace。
2. 按照 第 3.6.1.6.12 节 “在 Dev Workspace 中指定遥测插件” 的验证步骤，验证遥测插件是否正常工作。

流程

1. 创建一个 ClusterRoleBinding 将与 Prometheus 关联的 ServiceAccount 绑定到 devworkspace-controller-metrics-reader ClusterRole。对于 监控堆栈示例，要使用的 ServiceAccount 的名称是 prometheus。

   注意

   如果没有 ClusterRoleBinding，您无法访问 Dev Workspace 指标，因为访问使用基于角色的访问控制(RBAC)进行保护。

   例 3.31. ClusterRoleBinding

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: devworkspace-controller-metrics-binding
   subjects:
     - kind: ServiceAccount
       name: prometheus
       namespace: monitoring
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: ClusterRole
     name: devworkspace-controller-metrics-reader

2. 将 Prometheus 配置为从 devworkspace-controller-metrics Service 公开的端口 8443 中提取指标，再从 devworkspace-webhookserver Service 公开的端口 9443 中提取指标。

   注意

   监控堆栈示例 已创建了带有空配置的 prometheus-config ConfigMap。要提供 Prometheus 配置详情，请编辑 ConfigMap 的 data 字段。

   例 3.32. Prometheus 配置

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: prometheus-config
     namespace: monitoring
   data:
     prometheus.yml: |-
         global:
           scrape_interval: 5s 1
           evaluation_interval: 5s 2
         scrape_configs: 3
           - job_name: 'DevWorkspace'
             scheme: https
             authorization:
               type: Bearer
               credentials_file: '/var/run/secrets/kubernetes.io/serviceaccount/token'
             tls_config:
               insecure_skip_verify: true
             static_configs:
               - targets: ['devworkspace-controller-metrics.<DWO_project>:8443'] 4
           - job_name: 'DevWorkspace webhooks'
             scheme: https
             authorization:
               type: Bearer
               credentials_file: '/var/run/secrets/kubernetes.io/serviceaccount/token'
             tls_config:
               insecure_skip_verify: true
             static_configs:
               - targets: ['devworkspace-webhookserver.<DWO_project>:9443'] 5

   1

   抓取目标的速率。

   2

   重新检查记录和警报规则的速率。

   3

   Prometheus 监控的资源。在默认配置中，两个作业是 DevWorkspace 和 DevWorkspace Webhook，提取由 devworkspace-controller-metrics 和 devworkspace-webhookserver 服务公开的时间序列数据。

   4

   来自端口 8443 的指标的修整目标。将 <DWO_project > 替换为 devworkspace-controller-metrics Service 所在的项目。

   5

   来自端口 9443 的指标的修整目标。将 <DWO_project > 替换为 devworkspace-webhookserver Service 所在的项目。

3. 缩减 Prometheus Deployment 并向上读取上一步中更新的 ConfigMap。

   $ oc scale --replicas=0 deployment/prometheus -n monitoring && oc scale --replicas=1 deployment/prometheus -n monitoring

验证

1. 使用端口转发在本地访问 Prometheus 服务：

   $ oc port-forward svc/prometheus 9090:9090 -n monitoring

2. 通过查看 localhost:9090/targets 上的目标端点来验证所有目标是否已启动。

3. 使用 Prometheus 控制台查看和查询指标：

   • 查看 localhost:9090/metrics 上的指标。

   • 从 localhost:9090/graph 来查询指标。

     如需更多信息，请参阅使用表达式浏览器。

流程

1. 为 Prometheus 实例添加数据源。请参阅创建 Prometheus 数据源。
2. 导入 示例 grafana-dashboard.json 仪表板。

流程

1. 将 Prometheus 配置为从端口 8087 中提取指标。

   注意

   监控堆栈示例 已创建了带有空配置的 prometheus-config ConfigMap。要提供 Prometheus 配置详情，请编辑 ConfigMap 的 data 字段。

   例 3.33. Prometheus 配置

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: prometheus-config
   data:
     prometheus.yml: |-
         global:
           scrape_interval:     5s             1
           evaluation_interval: 5s             2
         scrape_configs:                       3
           - job_name: 'OpenShift Dev Spaces Server'
             static_configs:
               - targets: ['che-host.<OpenShift Dev Spaces_project>:8087']  4

   1

   抓取目标的速率。

   2

   重新检查记录和警报规则的速率。

   3

   Prometheus 监控的资源。在默认配置中，单个作业( OpenShift Dev Spaces Server )提取 OpenShift Dev Spaces 服务器公开的时间序列数据。

   4

   来自端口 8087 的指标的提取目标。将 <OpenShift Dev Spaces_project& gt; 替换为 OpenShift Dev Spaces 项目。默认的 OpenShift Dev Spaces 项目为 openshift-devspaces。

2. 缩减 Prometheus Deployment 并向上读取上一步中更新的 ConfigMap。

   $ oc scale --replicas=0 deployment/prometheus -n monitoring && oc scale --replicas=1 deployment/prometheus -n monitoring

验证

1. 使用端口转发在本地访问 Prometheus 服务：

   $ oc port-forward svc/prometheus 9090:9090 -n monitoring

2. 通过查看 localhost:9090/targets 上的 目标 端点来验证所有目标是否已启动。

3. 使用 Prometheus 控制台查看和查询指标：

   • 查看 localhost:9090/metrics 上的指标。

   • 从 localhost:9090/graph 来查询指标。

     如需更多信息，请参阅使用表达式浏览器。

流程

1. 为 Prometheus 实例添加数据源。请参阅创建 Prometheus 数据源。
2. 导入示例 仪表板。请参阅 导入仪表板。

3. 在 Grafana 控制台中查看 OpenShift Dev Spaces JVM 指标：

   图 3.4. OpenShift Dev Spaces 服务器 JVM 仪表板

   

   图 3.5. 快速事实

   

   图 3.6. JVM 内存

   

   图 3.7. JVM Misc

   

   图 3.8. JVM 内存池(heap)

   

   图 3.9. JVM 内存限值(Non-Heap)

   

   图 3.10. 垃圾回收

   

   图 3.11. 类载入

   

   图 3.12. 缓冲池

   

流程

1. 前往 https://github.com/settings/applications/new。

2. 输入以下值：

   1. 应用程序名称 ：OpenShift Dev Spaces.
   2. 主页 URL:"https://devspaces-<openshift_deployment_name>.<domain_name>"/
   3. 授权回调 URL:"https://devspaces-<openshift_deployment_name>.<domain_name>"/api/oauth/callback
3. 点击 Register application。
4. 点 Generate new client secret。

5. 复制 GitHub OAuth 客户端 ID，并将其编码为 Base64，以便在应用 GitHub OAuth App Secret 时使用：

   $ echo -n '<github_oauth_client_id>' | base64

6. 复制 GitHub OAuth 客户端 Secret，并将其编码为 Base64，以便在应用 GitHub OAuth App Secret 时使用：

   $ echo -n '<github_oauth_client_secret>' | base64

流程

1. 准备 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: github-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: oauth-scm-configuration
     annotations:
       che.eclipse.org/oauth-scm-server: github
       che.eclipse.org/scm-server-endpoint: <github_server_url> 2
   type: Opaque
   data:
     id: <Base64_GitHub_OAuth_Client_ID> 3
     secret: <Base64_GitHub_OAuth_Client_Secret> 4

   1

   OpenShift Dev Spaces 命名空间。默认为 openshift-devspaces。

   2

   GitHub Enterprise Server URL。默认情况下 ，https://github.com 用于 SAAS 版本。

   3

   Base64 编码的 GitHub OAuth 客户端 ID。

   4

   Base64 编码的 GitHub OAuth 客户端 Secret。

2. 应用 Secret：

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 在输出中验证是否创建了 Secret。

流程

1. 点您的 avatar，转到 Edit profile → Applications。
2. 输入 OpenShift Dev Spaces 作为名称。
3. 输入 "https://devspaces-<openshift_deployment_name>.<domain_name>"/api/oauth/callback 作为 Redirect URI。
4. 选中 机密和 过期访问令牌 复选框。
5. 在 Scopes 下，选中 api、write_repository 和 openid es。
6. 点 Save application。

7. 复制 GitLab 应用 ID，并将其编码为 Base64，以便在应用 GitLab-authorized 应用程序 Secret 时使用：

   $ echo -n '<gitlab_application_id>' | base64

8. 复制 GitLab Client Secret，并将其编码为 Base64，以便在应用 GitLab-authorized 应用程序 Secret 时使用：

   $ echo -n '<gitlab_client_secret>' | base64

流程

1. 准备 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: gitlab-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: oauth-scm-configuration
     annotations:
       che.eclipse.org/oauth-scm-server: gitlab
       che.eclipse.org/scm-server-endpoint: <gitlab_server_url> 2
   type: Opaque
   data:
     id: <Base64_GitLab_Application_ID> 3
     secret: <Base64_GitLab_Client_Secret> 4

   1

   OpenShift Dev Spaces 命名空间。默认为 openshift-devspaces。

   2

   GitLab 服务器 URL。使用 https://gitlab.com 作为 SAAS 版本。

   3

   Base64 编码的 GitLab 应用程序 ID。

   4

   Base64 编码的 GitLab 客户端 Secret。

2. 应用 Secret：

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 在输出中验证是否创建了 Secret。

流程

1. 在命令行中，运行命令来创建后续步骤所需的文件，并在应用应用程序链接 Secret 时使用：

   $ openssl genrsa -out private.pem 2048 && \
   openssl pkcs8 -topk8 -inform pem -outform pem -nocrypt -in private.pem -out privatepkcs8.pem && \
   cat privatepkcs8.pem | sed 's/-----BEGIN PRIVATE KEY-----//g' | sed 's/-----END PRIVATE KEY-----//g' | tr -d '\n' | base64 | tr -d '\n' > privatepkcs8-stripped.pem && \
   openssl rsa -in private.pem -pubout > public.pub && \
   cat public.pub | sed 's/-----BEGIN PUBLIC KEY-----//g' | sed 's/-----END PUBLIC KEY-----//g' | tr -d '\n' > public-stripped.pub && \
   openssl rand -base64 24 > bitbucket-consumer-key && \
   openssl rand -base64 24 > bitbucket-shared-secret

2. 转到 "管理" → 应用程序链接。
3. 输入 "https://devspaces-<openshift_deployment_name>.<domain_name>"/ in the URL 字段，然后点击 Create new link。
4. 在提供的 Application URL 下重定向一次，选中 Use this URL 复选框，再单击 Continue 。
5. 输入 OpenShift Dev Spaces 作为 Application Name。
6. 选择 Generic Application 作为 Application Type。
7. 输入 OpenShift Dev Spaces 作为 Service Provider Name。
8. 将 bitbucket-consumer-key 文件的内容粘贴到 Consumer 键。
9. 将 bitbucket-shared-secret 文件的内容粘贴到 Shared secret。
10. 输入 <bitbucket_server_url> /plugins/servlet/oauth/request-token，作为 Request Token URL。
11. 输入 <bitbucket_server_url> /plugins/servlet/oauth/access-token，作为 访问令牌 URL。
12. 输入 <bitbucket_server_url> /plugins/servlet/oauth/authorize 作为 Authorize URL。
13. 选中 Create incoming 链接 复选框，再单击 Continue。
14. 将 bitbucket_consumer_key 文件的内容粘贴到 Consumer Key。
15. 输入 OpenShift Dev Spaces 作为 使用者名称。
16. 将 public-stripped.pub 文件的内容粘贴到 Public Key，再单击 Continue。

流程

1. 准备 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: bitbucket-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/component: oauth-scm-configuration
       app.kubernetes.io/part-of: che.eclipse.org
     annotations:
       che.eclipse.org/oauth-scm-server: bitbucket
       che.eclipse.org/scm-server-endpoint: <bitbucket_server_url> 2
   type: Opaque
   data:
     private.key: <Base64_content_of_privatepkcs8-stripped.pem> 3
     consumer.key: <Base64_content_of_bitbucket_server_consumer_key> 4
     shared_secret: <Base64_content_of_bitbucket-shared-secret> 5

   1

   OpenShift Dev Spaces 命名空间。默认为 openshift-devspaces。

   2

   Bitbucket 服务器的 URL。

   3

   privatepkcs8-stripped.pem 文件的 Base64 编码内容。

   4

   bitbucket_consumer_key 文件的 Base64 编码内容。

   5

   bitbucket-shared-secret 文件的 Base64 编码内容。

2. 应用 Secret：

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 在输出中验证是否创建了 Secret。

流程

1. 点 avatar，进入 All workspaces 页面。
2. 选择一个工作区并点它。
3. 前往 Settings → OAuth consumers → Add consumer。
4. 输入 OpenShift Dev Spaces 作为名称。
5. 输入 "https://devspaces-<openshift_deployment_name>.<domain_name>"/api/oauth/callback 作为 Callback URL。
6. 在 "权限" 下，选中所有 帐户 和存储库复选框，然后单击保存。

7. 展开添加的使用者，然后复制 Key 值并将其编码为 Base64，以便在应用 Bitbucket OAuth consumer Secret 时使用：

   $ echo -n '<bitbucket_oauth_consumer_key>' | base64

8. 复制 Secret 值并将其编码为 Base64，以便在应用 Bitbucket OAuth consumer Secret 时使用：

   $ echo -n '<bitbucket_oauth_consumer_secret>' | base64

流程

1. 准备 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: bitbucket-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: oauth-scm-configuration
     annotations:
       che.eclipse.org/oauth-scm-server: bitbucket
   type: Opaque
   data:
     id: <Base64_Bitbucket_Oauth_Consumer_Key> 2
     secret: <Base64_Bitbucket_Oauth_Consumer_Secret> 3

   1

   OpenShift Dev Spaces 命名空间。默认为 openshift-devspaces。

   2

   base64 编码的 Bitbucket OAuth 使用者密钥。

   3

   Base64 编码的 Bitbucket OAuth 使用者 Secret。

2. 应用 Secret：

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 在输出中验证是否创建了 Secret。