This documentation is for a release that is no longer maintained
See documentation for the latest supported version.3.6. 配置可观察性
要配置 OpenShift Dev Spaces 观察功能,请参阅:
3.6.1. Woopra 遥测插件 复制链接链接已复制到粘贴板!
Woopra Telemetry 插件是 一个插件,用于将遥测从 Red Hat OpenShift Dev Spaces 安装发送到 Segment 和 Woopra。此插件 由红帽托管的 Eclipse Che 使用,但任何 Red Hat OpenShift Dev Spaces 部署都可以利用这个插件。除了有效 Woopra 域和 Segment Write 密钥外,没有依赖项。插件的 devfile v2 ,plugin.yaml,有四个可传递给插件的环境变量:
-
WOOPRA_DOMAIN
- 要发送事件的 Woopra 域。 -
SEGMENT_WRITE_KEY
- 将事件发送到 Segment 和 Woopra 的写键。 -
WOOPRA_DOMAIN_ENDPOINT
- 如果您想要直接传递 Woopra 域,则插件将从返回 Woopra 域的 HTTP 端点中获取。 -
SEGMENT_WRITE_KEY_ENDPOINT
- 如果您想要直接传递 Segment 写密钥,则插件将从返回 Segment 写密钥的 HTTP 端点中获取它。
在 Red Hat OpenShift Dev Spaces 安装中启用 Woopra 插件:
流程
使用正确设置的环境变量,将
plugin.yaml
devfile v2 文件部署到 HTTP 服务器中。配置
CheCluster
自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2. 创建遥测插件 复制链接链接已复制到粘贴板!
本节介绍如何创建扩展 AbstractAnalyticsManager
并实现以下方法的 AnalyticsManager
类:
-
isEnabled ()
- 确定遥测后端是否正常工作。这可能意味着,始终返回true
,或者有更复杂的检查,例如当缺少连接属性时返回false
。 -
destroy ()
- 关闭遥测后端前运行的清理方法。此方法发送WORKSPACE_STOPPED
事件。 -
onActivity ()
- 通知给定用户仍然发生一些活动。这主要用于发送WORKSPACE_INACTIVE
事件。 -
onEvent ()
- 将遥测事件提交到遥测服务器,如WORKSPACE_USED
或WORKSPACE_STARTED
。 -
increaseDuration ()
- 增加当前事件的持续时间,而不是在小时间内发送多个事件。
以下部分涵盖了:
- 创建遥测服务器,将事件回显到标准输出。
- 扩展 OpenShift Dev Spaces 遥测客户端并实施用户的自定义后端。
-
创建一个
plugin.yaml
文件,代表自定义后端的 Dev Workspace 插件。 -
通过设置
CheCluster
自定义资源中的workspacesDefaultPlugins
属性,指定自定义插件到 OpenShift Dev Spaces 的位置。
3.6.2.1. 开始使用 复制链接链接已复制到粘贴板!
本文档描述了扩展 OpenShift Dev Spaces 遥测系统以与自定义后端通信所需的步骤:
- 创建接收事件的服务器进程
- 扩展 OpenShift Dev Spaces 库,以创建将事件发送到服务器的后端
- 在容器中打包遥测后端并将其部署到镜像 registry
- 为您的后端添加插件,并指示 OpenShift Dev Spaces 加载 Dev Workspaces 中的插件
此处 提供了遥测后端的完整示例。
创建接收事件的服务器
出于演示目的,本例演示了如何创建从遥测插件接收事件的服务器并将其写入标准输出。
对于生产环境用例,请考虑与第三方遥测系统(例如,Segment、Woopra)集成,而不是创建自己的遥测服务器。在这种情况下,使用供应商的 API 将事件从自定义后端发送到其系统。
以下 Go 代码在端口 8080
上启动一个服务器,并将事件写入标准输出:
例 3.11. main.go
基于此代码创建容器镜像,并将其公开为 openshift-devspaces
项目中的 OpenShift 中部署。示例遥测服务器的代码位于 telemetry-server-example 中。要部署遥测服务器,请克隆存储库并构建容器:
git clone https://github.com/che-incubator/telemetry-server-example cd telemetry-server-example podman build -t registry/organization/telemetry-server-example:latest . podman push registry/organization/telemetry-server-example:latest
$ git clone https://github.com/che-incubator/telemetry-server-example
$ cd telemetry-server-example
$ podman build -t registry/organization/telemetry-server-example:latest .
$ podman push registry/organization/telemetry-server-example:latest
manifest_with_ingress.yaml
和 manifest_with_route
都包含 Deployment 和 Service 的定义。前者还定义了 Kubernetes Ingress,后者则定义一个 OpenShift 路由。
在清单文件中,替换 image
和 host
字段以匹配您推送的镜像和 OpenShift 集群的公共主机名。然后运行:
kubectl apply -f manifest_with_[ingress|route].yaml -n openshift-devspaces
$ kubectl apply -f manifest_with_[ingress|route].yaml -n openshift-devspaces
3.6.2.2. 创建后端项目 复制链接链接已复制到粘贴板!
为了在开发时快速反馈,建议在 Dev Workspace 内进行开发。这样,您可以在集群中运行应用程序,并从前端 telemetry 插件接收事件。
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
mvn io.quarkus:quarkus-maven-plugin:2.7.1.Final:create \ -DprojectGroupId=mygroup -DprojectArtifactId=devworkspace-telemetry-example-plugin \ -DprojectVersion=1.0.0-SNAPSHOT
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
删除
src/main/java/mygroup
和src/test/java/mygroup
下的文件。 -
有关
backend-base
的最新版本,请参阅 GitHub 软件包。 在
pom.xml
中添加以下依赖项:例 3.12.
pom.xml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
创建一个具有
read:packages
权限的个人访问令牌,以便从 GitHub 软件包下载org.eclipse.che.incubator.workspace-telemetry:backend-base
依赖项。 在
~/.m2/settings.xml
文件中添加 GitHub 用户名、个人访问令牌和che-incubator
存储库详情:例 3.13.
settings.xml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.3. 创建 AnalyticsManager 的聚合实施并添加专用逻辑 复制链接链接已复制到粘贴板!
在 src/main/java/mygroup
下,在项目中创建两个文件:
-
MainConfiguration.java
- 包含提供给AnalyticsManager
的配置。 -
AnalyticsManager.java
- 包含特定于遥测系统的逻辑。
例 3.14. MainConfiguration.java
- 1
- MicroProfile 配置注解用于注入
welcome.message
配置。
有关如何设置特定于您的后端的配置属性的更多详细信息,请参阅 Quarkus 配置参考指南。
例 3.15. AnalyticsManager.java
由于 org.my.group.AnalyticsManager
和 org.my.group.MainConfiguration
是替代 Bean,因此使用 src/main/resources/application.properties
中的 quarkus.arc.selected-alternatives
属性来指定它们。
例 3.16. application.properties
quarkus.arc.selected-alternatives=MainConfiguration,AnalyticsManager
quarkus.arc.selected-alternatives=MainConfiguration,AnalyticsManager
3.6.2.4. 在 Dev Workspace 中运行应用程序 复制链接链接已复制到粘贴板!
在 Dev Workspace 中设置
DEVWORKSPACE_TELEMETRY_BACKEND_PORT
环境变量。此处,值设为4167
。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 从 Red Hat OpenShift Dev Spaces 仪表板中重启 Dev Workspace。
在 Dev Workspace 的终端窗口中运行以下命令以启动应用程序。使用
--settings
标志指定包含 GitHub 访问令牌的settings.xml
文件的位置的路径。mvn --settings=settings.xml quarkus:dev -Dquarkus.http.port=${DEVWORKSPACE_TELEMETRY_BACKEND_PORT}
$ mvn --settings=settings.xml quarkus:dev -Dquarkus.http.port=${DEVWORKSPACE_TELEMETRY_BACKEND_PORT}
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 应用程序现在通过前端插件的端口
4167
接收遥测事件。
验证步骤
验证以下输出是否已记录:
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]
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]
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 要验证
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
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
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.5. 实现 isEnabled () 复制链接链接已复制到粘贴板!
在本示例中,每当调用时,此方法始终返回 true
。
例 3.17. AnalyticsManager.java
@Override public boolean isEnabled() { return true; }
@Override
public boolean isEnabled() {
return true;
}
可以在 isEnabled ()
中放入更复杂的逻辑。例如,托管的 OpenShift Dev Spaces Woopra 后端 会在确定是否启用了后端前检查配置属性是否存在。
3.6.2.6. 在Event ()的实现 复制链接链接已复制到粘贴板!
onEvent ()
将后端收到的事件发送到遥测系统。对于示例应用,它会将 HTTP POST 有效负载发送到来自遥测服务器的 /event
端点。
3.6.2.6.1. 向示例 telemetry 服务器发送 POST 请求 复制链接链接已复制到粘贴板!
在以下示例中,遥测服务器应用通过以下 URL 部署到 OpenShift :http://little-telemetry-server-che.apps-crc.testing
,其中 apps-crc.testing
是 OpenShift 集群的入口域名。
通过创建
TelemetryService.java
来设置 RESTEasy REST 客户端例 3.18.
TelemetryService.java
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 发出请求
的端点
。
在
src/main/resources/application.properties
文件中指定TelemetryService
的基本 URL:例 3.19.
application.properties
org.my.group.TelemetryService/mp-rest/url=http://little-telemetry-server-che.apps-crc.testing
org.my.group.TelemetryService/mp-rest/url=http://little-telemetry-server-che.apps-crc.testing
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将
TelemetryService
注入AnalyticsManager
,并在onEvent ()
中发送POST
请求例 3.20.
AnalyticsManager.java
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 这会向遥测服务器发送 HTTP 请求,并在少量时间内自动延迟相同的事件。默认持续时间为 1500 毫秒。
3.6.2.7. 实现 增加Duration () 复制链接链接已复制到粘贴板!
许多遥测系统可识别事件持续时间。AbstractAnalyticsManager
合并同一时间间发生的类似事件。这种 increaseDuration ()
实现是一个 no-op。此方法使用用户遥测供应商的 API 更改事件或事件属性,以反映事件的增加持续时间。
例 3.21. AnalyticsManager.java
@Override public void increaseDuration(AnalyticsEvent event, Map<String, Object> properties) {}
@Override
public void increaseDuration(AnalyticsEvent event, Map<String, Object> properties) {}
3.6.2.8. 实现 onActivity () 复制链接链接已复制到粘贴板!
设置不活跃超时限制,并使用 onActivity ()
来发送 WORKSPACE_INACTIVE
事件(如果最后一次事件时间超过超时)。
例 3.22. AnalyticsManager.java
3.6.2.9. 实现 destroy () 复制链接链接已复制到粘贴板!
调用 destroy ()
时,发送 WORKSPACE_STOPPED
事件并关闭任何资源,如连接池。
例 3.23. AnalyticsManager.java
@Override public void destroy() { onEvent(WORKSPACE_STOPPED, lastOwnerId, lastIp, lastUserAgent, lastResolution, commonProperties); }
@Override
public void destroy() {
onEvent(WORKSPACE_STOPPED, lastOwnerId, lastIp, lastUserAgent, lastResolution, commonProperties);
}
运行 mvn quarkus:dev
,如 第 3.6.2.4 节 “在 Dev Workspace 中运行应用程序” 所述,并使用 Ctrl+C 终止应用程序,将 WORKSPACE_STOPPED
事件发送到服务器。
3.6.2.10. 打包 Quarkus 应用程序 复制链接链接已复制到粘贴板!
如需了解在容器中打包应用程序的最佳说明,请参阅 Quarkus 文档。构建容器并将其推送到您选择的容器 registry。
3.6.2.10.1. 用于构建使用 JVM 运行的 Quarkus 镜像的 Dockerfile 示例 复制链接链接已复制到粘贴板!
例 3.24. Dockerfile.jvm
要构建镜像,请运行:
mvn package && \ podman build -f src/main/docker/Dockerfile.jvm -t image:tag .
mvn package && \
podman build -f src/main/docker/Dockerfile.jvm -t image:tag .
3.6.2.10.2. 用于构建 Quarkus 原生镜像的 Dockerfile 示例 复制链接链接已复制到粘贴板!
例 3.25. Dockerfile.native
要构建镜像,请运行:
mvn package -Pnative -Dquarkus.native.container-build=true && \ podman build -f src/main/docker/Dockerfile.native -t image:tag .
mvn package -Pnative -Dquarkus.native.container-build=true && \
podman build -f src/main/docker/Dockerfile.native -t image:tag .
3.6.2.11. 为您的插件创建 plugin.yaml 复制链接链接已复制到粘贴板!
创建一个 plugin.yaml
devfile v2 文件,该文件代表 Dev Workspace 插件,该插件在 Dev Workspace Pod 中运行自定义后端。有关 devfile v2 的更多信息,请参阅 Devfile v2 文档
例 3.26. plugin.yaml
- 1
- 指定从 第 3.6.2.10 节 “打包 Quarkus 应用程序” 构建的容器镜像。
- 2
- 为来自 Example 4 的
welcome.message
可选配置属性设置值。
通常,用户会将此文件部署到公司 Web 服务器。本指南介绍了如何在 OpenShift 中创建 Apache Web 服务器,并在其中托管插件。
创建引用新 plugin.yaml
文件的 ConfigMap
对象。
oc create configmap --from-file=plugin.yaml -n openshift-devspaces telemetry-plugin-yaml
$ oc create configmap --from-file=plugin.yaml -n openshift-devspaces telemetry-plugin-yaml
创建部署、服务和路由来公开 Web 服务器。部署引用此 ConfigMap
对象并将其放置在 /var/www/html
目录中。
例 3.27. manifest.yaml
oc apply -f manifest.yaml
$ oc apply -f manifest.yaml
验证步骤
部署启动后,确认 web 服务器中的
plugin.yaml
可用:curl apache-che.apps-crc.testing/plugin.yaml
$ curl apache-che.apps-crc.testing/plugin.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.12. 在 Dev Workspace 中指定 telemetry 插件 复制链接链接已复制到粘贴板!
在现有 Dev Workspace 的
components
字段中添加以下内容:components: ... - name: telemetry-plugin plugin: uri: http://apache-che.apps-crc.testing/plugin.yaml
components: ... - name: telemetry-plugin plugin: uri: http://apache-che.apps-crc.testing/plugin.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 从 OpenShift Dev Spaces 仪表板启动 Dev Workspace。
验证步骤
验证遥测插件容器是否在 Dev Workspace pod 中运行。在这里,这可以通过检查编辑器中的 Workspace 视图进行验证。
- 编辑编辑器中的文件,并在示例遥测服务器日志中观察其事件。
3.6.2.13. 为所有 Dev Workspaces 应用 telemetry 插件 复制链接链接已复制到粘贴板!
将 telemetry 插件设置为默认插件。在 Dev Workspace 启动时,针对新的和现有的 Dev Workspaces 应用默认插件。
配置
CheCluster
自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证步骤
- 从 Red Hat OpenShift Dev Spaces 仪表板中启动一个新的或现有的 Dev Workspace。
- 按照 第 3.6.2.12 节 “在 Dev Workspace 中指定 telemetry 插件” 的验证步骤,验证遥测插件是否正常工作。
3.6.2.14. 配置服务器日志记录 复制链接链接已复制到粘贴板!
可以微调 OpenShift Dev Spaces 服务器中可用的单个日志记录器的日志级别。
整个 OpenShift Dev Spaces 服务器的日志级别使用 Operator 的 cheLogLevel
配置属性进行全局配置。请参阅 第 3.1.3 节 “CheCluster
自定义资源字段参考”。要在不是由 Operator 管理的安装中设置全局日志级别,请在 che
ConfigMap 中指定 CHE_LOG_LEVEL
环境变量。
可以使用 CHE_LOGGER_CONFIG
环境变量在 OpenShift Dev Spaces 服务器中配置单个日志记录器的日志级别。
3.6.2.14.1. 配置日志级别 复制链接链接已复制到粘贴板!
流程
配置
CheCluster
自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "<key1=value1,key2=value2>"
spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "<key1=value1,key2=value2>"
1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 以逗号分隔的键值对列表,其中 key 是日志记录器的名称,如 OpenShift Dev Spaces 服务器日志输出中所示,值是所需的日志级别。
例 3.28. 为
WorkspaceManager
配置调试模式spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "org.eclipse.che.api.workspace.server.WorkspaceManager=DEBUG"
spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "org.eclipse.che.api.workspace.server.WorkspaceManager=DEBUG"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.14.2. 日志记录器命名 复制链接链接已复制到粘贴板!
日志记录器的名称遵循使用这些日志记录器的内部服务器类的类名称。
3.6.2.14.3. 日志记录 HTTP 流量 复制链接链接已复制到粘贴板!
流程
要记录 OpenShift Dev Spaces 服务器和 Kubernetes 或 OpenShift 集群的 API 服务器之间的 HTTP 流量,请配置
CheCluster
自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "che.infra.request-logging=TRACE"
spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "che.infra.request-logging=TRACE"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.15. 使用 dsc 收集日志 复制链接链接已复制到粘贴板!
Red Hat OpenShift Dev Spaces 的安装由 OpenShift 集群中运行的几个容器组成。虽然可以从每个正在运行的容器手动收集日志,但 dsc
提供了可自动化该进程的命令。
以下命令可使用 dsc
工具从 OpenShift 集群收集 Red Hat OpenShift Dev Spaces 日志:
dsc server:logs
收集现有的 Red Hat OpenShift Dev Spaces 服务器日志,并将其存储在本地机器的目录中。默认情况下,日志下载到计算机上的临时目录中。但是,这可以通过指定
-d
参数来覆盖。例如,要将 OpenShift Dev Spaces 日志下载到/home/user/che-logs/
目录中,请使用 命令dsc server:logs -d /home/user/che-logs/
dsc server:logs -d /home/user/che-logs/
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 在运行时,
dsc server:logs
会在指定存储日志文件的目录在控制台中打印一条消息:Red Hat OpenShift Dev Spaces logs will be available in '/tmp/chectl-logs/1648575098344'
Red Hat OpenShift Dev Spaces logs will be available in '/tmp/chectl-logs/1648575098344'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 如果在非默认项目中安装了 Red Hat OpenShift Dev Spaces,
dsc server:logs
需要-n <NAMESPACE>
; paremeter,其中 <NAMESPACE
> 是安装 Red Hat OpenShift Dev Spaces 的 OpenShift 项目。例如,若要从my-namespace
项目中的 OpenShift Dev Spaces 获取日志,请使用该命令dsc server:logs -n my-namespace
dsc server:logs -n my-namespace
Copy to Clipboard Copied! Toggle word wrap Toggle overflow dsc server:deploy
-
使用
dsc
安装时,OpenShift Dev Spaces 安装过程中会自动收集日志。与dsc server:logs
一样,可以使用-d
参数指定目录日志。
其他资源
- "DS 参考文档"
3.6.3. 监控 Dev Workspace Operator 复制链接链接已复制到粘贴板!
您可以配置 OpenShift in-cluster 监控堆栈,以提取 Dev Workspace Operator 公开的指标。
3.6.3.1. 收集 Dev Workspace Operator 指标 复制链接链接已复制到粘贴板!
使用 in-cluster Prometheus 实例来收集、存储和查询 Dev Workspace Operator 的指标:
先决条件
- OpenShift Dev Spaces 的机构实例已安装并在 Red Hat OpenShift 中运行。
-
一个活跃的
oc
会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 -
devworkspace-controller-metrics
服务在端口8443
上公开指标。默认情况下,这是预先配置的。
流程
为检测 Dev Workspace Operator 指标服务创建 ServiceMonitor。
允许集群内 Prometheus 实例检测 OpenShift Dev Spaces 命名空间中的 ServiceMonitor。默认 OpenShift Dev Spaces 命名空间为
openshift-devspaces
。oc label namespace openshift-devspaces openshift.io/cluster-monitoring=true
$ oc label namespace openshift-devspaces openshift.io/cluster-monitoring=true
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
- 对于 OpenShift Dev Spaces 的新安装,请通过从 Dashboard 创建 OpenShift Dev Spaces 工作区来生成指标。
-
在 OpenShift Web 控制台的 Administrator 视图中,进入 Observe
Metrics。 运行 PromQL 查询以确认指标可用。例如,输入
devworkspace_started_total
并点 Run query。如需了解更多指标,请参阅 第 3.6.3.2 节 “特定于 dev Workspace 的指标”。
要排除缺失的指标,请查看 Prometheus 容器日志以了解可能的与 RBAC 相关的错误:
获取 Prometheus pod 的名称:
oc get pods -l app.kubernetes.io/name=prometheus -n openshift-monitoring -o=jsonpath='{.items[*].metadata.name}'
$ oc get pods -l app.kubernetes.io/name=prometheus -n openshift-monitoring -o=jsonpath='{.items[*].metadata.name}'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 从上一步中的 Prometheus pod 输出 Prometheus 容器日志的最后 20 行:
oc logs --tail=20 <prometheus_pod_name> -c prometheus -n openshift-monitoring
$ oc logs --tail=20 <prometheus_pod_name> -c prometheus -n openshift-monitoring
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.3.2. 特定于 dev Workspace 的指标 复制链接链接已复制到粘贴板!
下表描述了 devworkspace-controller-metrics
服务公开的 Dev Workspace 特定指标。
Name | 类型 | 描述 | 标签 |
---|---|---|---|
| 计数 | Dev Workspace 启动事件的数量。 |
|
| 计数 |
Dev Workspaces 数量成功进入 |
|
| 计数 | 失败的 Dev Workspaces 数量。 |
|
| Histogram | 启动 Dev Workspace 所需的时间(以秒为单位)。 |
|
Name | 描述 | 值 |
---|---|---|
|
Dev Workspace 的 |
|
|
Dev Workspace 的 |
|
| 工作区启动失败的原因。 |
|
Name | 描述 |
---|---|
| 启动失败,因为 devfile 用于创建 Dev Workspace。 |
|
因为以下错误,启动失败: |
| 未知故障原因。 |
配置 in-cluster Prometheus 实例以收集 Dev Workspace Operator 指标后,您可以在 OpenShift Web 控制台的 Administrator 视角中查看自定义仪表板的指标。
先决条件
- 您的机构 OpenShift Dev Spaces 实例已安装并在 Red Hat OpenShift 中运行。
-
一个活跃的
oc
会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 - 集群内 Prometheus 实例正在收集指标。请参阅 第 3.6.3.1 节 “收集 Dev Workspace Operator 指标”。
流程
在
openshift-config-managed
项目中为仪表板定义创建 ConfigMap,并应用必要的标签。oc create configmap grafana-dashboard-dwo \ --from-literal=dwo-dashboard.json="$(curl https://raw.githubusercontent.com/devfile/devworkspace-operator/main/docs/grafana/openshift-console-dashboard.json)" \ -n openshift-config-managed
$ oc create configmap grafana-dashboard-dwo \ --from-literal=dwo-dashboard.json="$(curl https://raw.githubusercontent.com/devfile/devworkspace-operator/main/docs/grafana/openshift-console-dashboard.json)" \ -n openshift-config-managed
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注意上一命令包含来自上游社区的材料的链接。本材料代表了最新的可用内容,以及最新的最佳实践。这些提示尚未被红帽的 QE 部门利用,并且尚未由广泛的用户组证明。请小心使用此信息。
oc label configmap grafana-dashboard-dwo console.openshift.io/dashboard=true -n openshift-config-managed
$ oc label configmap grafana-dashboard-dwo console.openshift.io/dashboard=true -n openshift-config-managed
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注意仪表板定义基于 Grafana 6.x 仪表板。并非所有 Grafana 6.x 仪表板功能在 OpenShift Web 控制台中都被支持。
验证步骤
-
在 OpenShift Web 控制台的 Administrator 视图中,进入 Observe
Dashboards。 -
进入 Dashboard
Che Server JVM,并验证仪表板面板是否包含数据。
3.6.3.4. Dev Workspace Operator 的仪表板 复制链接链接已复制到粘贴板!
OpenShift Web 控制台自定义仪表板基于 Grafana 6.x,并显示 Dev Workspace Operator 中的以下指标。
不是 Grafana 6.x 仪表板的所有功能都作为 OpenShift Web 控制台仪表板被支持。
3.6.3.4.1. dev Workspace 指标 复制链接链接已复制到粘贴板!
Dev Workspace Metrics 面板中显示特定于 Dev Workspace 的指标。
图 3.1. Dev Workspace Metrics 面板
- 平均工作空间开始时间
- 平均工作区启动持续时间。
- 工作区启动
- 成功和失败的工作区启动数量。
- dev Workspace 成功和失败
- 成功和失败的 Dev Workspace 启动之间的比较。
- dev Workspace 失败率
- 失败的工作区启动数量和工作区启动总数之间的比率。
- dev Workspace 启动失败原因
显示工作空间启动失败的重复图表:
-
BadRequest
-
InfrastructureFailure
-
Unknown
-
3.6.3.4.2. Operator 指标 复制链接链接已复制到粘贴板!
Operator Metrics 面板中会显示特定于 Operator 的指标。
图 3.2. Operator Metrics 面板
- flight 中的 Webhook
- 不同 Webhook 请求数量之间的比较。
- 工作队列深度
- 工作队列中的协调请求数。
- memory
- Dev Workspace 控制器和 Dev Workspace Webhook 服务器的内存用量。
- 每秒平均协调计数(DWO)
- Dev Workspace 控制器的平均每秒协调计数数。
3.6.4. 监控 Dev Spaces 服务器 复制链接链接已复制到粘贴板!
您可以配置 OpenShift Dev Spaces 以公开 OpenShift Dev Spaces 服务器的 JVM 内存和类加载。
3.6.4.1. 启用和公开 OpenShift Dev Spaces 服务器指标 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 在 che-host
服务的端口 8087
上公开 JVM 指标。您可以配置此行为。
流程
配置
CheCluster
自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: components: metrics: enable: <boolean>
spec: components: metrics: enable: <boolean>
1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
true
启用,false
为 disable。
3.6.4.2. 使用 Prometheus 收集 OpenShift Dev Spaces 服务器指标 复制链接链接已复制到粘贴板!
使用 in-cluster Prometheus 实例为 OpenShift Dev Spaces Server 收集、存储和查询 JVM 指标:
先决条件
- 您的机构 OpenShift Dev Spaces 实例已安装并在 Red Hat OpenShift 中运行。
-
一个活跃的
oc
会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 -
OpenShift Dev Spaces 在端口
8087
上公开指标。请参阅启用和公开 OpenShift Dev Spaces 服务器 JVM 指标。
流程
创建 ServiceMonitor 以检测 OpenShift Dev Spaces JVM 指标服务。
创建 Role 和 RoleBinding,以允许 Prometheus 查看指标。
例 3.31. 角色
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- OpenShift Dev Spaces 命名空间。默认值为
openshift-devspaces
。
例 3.32. RoleBinding
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- OpenShift Dev Spaces 命名空间。默认值为
openshift-devspaces
。
允许集群内 Prometheus 实例检测 OpenShift Dev Spaces 命名空间中的 ServiceMonitor。默认 OpenShift Dev Spaces 命名空间为
openshift-devspaces
。oc label namespace openshift-devspaces openshift.io/cluster-monitoring=true
$ oc label namespace openshift-devspaces openshift.io/cluster-monitoring=true
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
-
在 OpenShift Web 控制台的 Administrator 视图中,进入 Observe
Metrics。 -
运行 PromQL 查询以确认指标可用。例如,输入
process_uptime_seconds{job="che-host"}
并点 Run query。
要排除缺失的指标,请查看 Prometheus 容器日志以了解可能的与 RBAC 相关的错误:
获取 Prometheus pod 的名称:
oc get pods -l app.kubernetes.io/name=prometheus -n openshift-monitoring -o=jsonpath='{.items[*].metadata.name}'
$ oc get pods -l app.kubernetes.io/name=prometheus -n openshift-monitoring -o=jsonpath='{.items[*].metadata.name}'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 从上一步中的 Prometheus pod 输出 Prometheus 容器日志的最后 20 行:
oc logs --tail=20 <prometheus_pod_name> -c prometheus -n openshift-monitoring
$ oc logs --tail=20 <prometheus_pod_name> -c prometheus -n openshift-monitoring
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
配置 in-cluster Prometheus 实例以收集 OpenShift Dev Spaces Server JVM 指标后,您可以在 OpenShift Web 控制台的 Administrator 视角中查看自定义仪表板的指标。
先决条件
- 您的机构 OpenShift Dev Spaces 实例已安装并在 Red Hat OpenShift 中运行。
-
一个活跃的
oc
会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 - 集群内 Prometheus 实例正在收集指标。请参阅 第 3.6.4.2 节 “使用 Prometheus 收集 OpenShift Dev Spaces 服务器指标”。
流程
在
openshift-config-managed
项目中为仪表板定义创建 ConfigMap,并应用必要的标签。oc create configmap grafana-dashboard-devspaces-server \ --from-literal=devspaces-server-dashboard.json="$(curl https://raw.githubusercontent.com/eclipse-che/che-server/main/docs/grafana/openshift-console-dashboard.json)" \ -n openshift-config-managed
$ oc create configmap grafana-dashboard-devspaces-server \ --from-literal=devspaces-server-dashboard.json="$(curl https://raw.githubusercontent.com/eclipse-che/che-server/main/docs/grafana/openshift-console-dashboard.json)" \ -n openshift-config-managed
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注意上一命令包含来自上游社区的材料的链接。本材料代表了最新的可用内容,以及最新的最佳实践。这些提示尚未被红帽的 QE 部门利用,并且尚未由广泛的用户组证明。请小心使用此信息。
oc label configmap grafana-dashboard-devspaces-server console.openshift.io/dashboard=true -n openshift-config-managed
$ oc label configmap grafana-dashboard-devspaces-server console.openshift.io/dashboard=true -n openshift-config-managed
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注意仪表板定义基于 Grafana 6.x 仪表板。并非所有 Grafana 6.x 仪表板功能在 OpenShift Web 控制台中都被支持。
验证步骤
-
在 OpenShift Web 控制台的 Administrator 视图中,进入 Observe
Dashboards。 进入 Dashboard
Dev Workspace Operator,并验证仪表板面板是否包含数据。 图 3.3. 快速事实
图 3.4. JVM 内存
图 3.5. JVM Misc
图 3.6. JVM 内存池(堆)
图 3.7. JVM 内存池(Non-Heap)
图 3.8. 垃圾回收
图 3.9. 类加载
图 3.10. 缓冲池