连接链接可观察性指南
前言 复制链接链接已复制到粘贴板!
对红帽文档提供反馈
红帽感谢您对产品文档的反馈。
要进行改进,请创建一个 Jira 问题,并描述您推荐的更改。提供尽可能多的详细信息,以帮助文档团队快速定位请求。
前提条件
- 您有一个红帽客户门户网站帐户。此帐户允许您登录到 Red Hat Jira Software 实例。如果您没有帐户,系统会提示您创建一个帐户。
流程
- 单击以下链接: 创建问题。
- 在 Summary 文本框中,输入问题的简短描述。
在 Description 文本框中,提供以下信息:
- 找到此问题的页面的 URL。
- 有关此问题的详细描述。您可以将信息保留在其他字段中,使其默认值。
- 在 Reporter 字段中输入 JIRA 用户名。
- 点 Create 将 JIRA 问题提交到文档团队。
感谢您抽出时间提供反馈。
第 1 章 连接链接可观察性 复制链接链接已复制到粘贴板!
您可以使用连接链路观察功能来观察和监控基于云的应用程序、API 和网关。
1.1. 连接链接可观察性功能 复制链接链接已复制到粘贴板!
连接链接使用 Kuadrant-maintained Gateway API 状态指标、通过连接链接组件公开的指标,以及 Envoy 公开的标准指标来构建一组模板仪表板和警报。
您可以下载并使用这些 Kuadrant 社区模板与 Grafana、Prometheus 和 Alertmanager 部署集成,或者将它们用作根据您的特定需求修改的起点。
图 1.1. 平台工程师 Grafana 仪表板
平台工程师仪表板显示如下详情:
- 策略合规性和监管.
- 资源消耗。
- 错误率。
- 请求延迟和吞吐量。
- 用于 API 错误率和延迟的多窗口、多刻刻警报模板。
- 多集群分割。
图 1.2. 应用程序开发人员 Grafana 仪表板
应用程序开发人员仪表板更侧重于策略,而不是平台工程师仪表板,它更侧重于 API 和应用程序。例如,这包括请求延迟和每个 API 吞吐量等详情,以及 API 路径的请求和错误率。
图 1.3. Business 用户 Grafana 仪表板
business 用户仪表板包括如下详情:
- 每个 API 每秒的请求数。
- 在指定时间增加或降低 API 使用量率。
第 2 章 配置可观察性指标 复制链接链接已复制到粘贴板!
连接链接提供的仪表板和警报使用连接链接和网关 API 组件导出的指标,以深入了解应用程序、API 和网关。虽然并不重要,但最好配置这些指标并在 OpenShift 集群上设置这些仪表板和警报。
用于观察连接功能的示例仪表板和警报使用 OpenShift 中用户监控堆栈中提供的低级别 CPU 指标和网络指标,以及来自 Gateway API 和连接链接资源的资源状态指标。
本节提供了 OpenShift 文档的链接,有关如何配置监控和指标存储,并演示了如何配置资源以提取相关指标。
您必须在您要使用连接链接的每个 OpenShift 集群上执行这些步骤。
先决条件
- 您已安装了连接链接,如在 OpenShift 上安装连接链接 中所述。
- 您已为用户定义的项目设置了监控,如 OpenShift 监控文档 中所述。
流程
在 OpenShift 中启用了对用户项目的监控,这允许从网关和连接链接组件中提取指标。要在 OpenShift 中提取额外指标,您可以安装
kube-state-metrics实例,其中包含自定义资源配置,如下所示:kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/kube-state-metrics.yaml kubectl apply -k https://github.com/Kuadrant/gateway-api-state-metrics/config/kuadrant?ref=0.6.0
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/kube-state-metrics.yaml kubectl apply -k https://github.com/Kuadrant/gateway-api-state-metrics/config/kuadrant?ref=0.6.0Copy to Clipboard Copied! Toggle word wrap Toggle overflow 一些示例仪表板根据请求路径聚合数据。默认情况下,OpenShift Service Mesh 指标不包括请求路径的标签,但您可以启用这些标签,如下所示:
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/telemetry.yaml
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/telemetry.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注意这可能会导致生成多个时间序列的高卡性标签,这可能会影响性能和资源使用量。如需了解更多详细信息,请参阅 卡in ality 上的可靠 Insights 博客文章。
您可以从各种连接链接 Operator 配置指标提取,如下所示:
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/prometheus/monitors/operators.yaml
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/prometheus/monitors/operators.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注意您必须应用额外的配置,以便提取所有相关指标。但是,此配置取决于您以后如何部署网关。有关所需步骤的详情,请参阅使用连接链接 配置和部署网关策略。
其他资源
- 有关如何在 OpenShift Service Mesh 中启用指标的详情,请参阅 OpenShift Service Mesh 指标文档。
- 有关连接链接组件指标的详情,请查看 Kuadrant 指标文档。
第 3 章 配置可观察性仪表板和警报 复制链接链接已复制到粘贴板!
连接链接通过示例仪表板和警报(可随时使用并可自定义以满足您的环境)提供各种监控连接链接部署的起点。
连接链接示例仪表板上传到 Grafana 仪表板网站。您可以将以下仪表板导入到 OpenShift 上的 Grafana 部署中:
| Name | 仪表板 ID |
|---|---|
| 21538 | |
| 20982 | |
| 20981 |
本节介绍如何启用示例仪表板和警报,并提供其他资源的链接。
您必须在您要使用连接链接的每个 OpenShift 集群上执行这些步骤。
先决条件
- 您已配置了指标,如 第 2 章 配置可观察性指标 所述。
- 您已在 OpenShift 上安装和设置 Grafana。例如,请参阅 Kaudrant Observability 在 Openshift 上安装 Grafana。
3.1. 配置 Grafana 仪表板示例 复制链接链接已复制到粘贴板!
您可以使用其用户界面将仪表板导入到 Grafana 中,或使用 OpenShift 中的自定义资源自动将仪表板导入到 Grafana 中:
- 在 Grafana UI 中导入仪表板
- JSON 文件 :使用 Grafana UI 中的 Import 功能直接上传仪表板 JSON 文件。
仪表板 ID :使用 Grafana UI 中的 Import 功能,使用仪表板 ID 通过 Grafana.com 导入。
您可以从 Grafana 仪表板网站 上的相关仪表板页面中下载 JSON 文件或复制仪表板 ID。如需更多信息,请参阅 有关如何导入短划线的 Grafana 文档。
- 在 OpenShift 中自动导入仪表板
您可以通过在
ConfigMap中添加 JSON 文件来自动进行仪表板置备,它必须挂载于/etc/grafana/provisioning/dashboards。提示另外,为了避免在 Grafana 部署中添加
ConfigMap卷挂载,您可以使用GrafanaDashboard资源来引用ConfigMap。例如,请参阅 Grafana 文档中的来自 ConfigMap 的 Dashboard。数据源配置为模板变量,自动与现有数据源集成。这些仪表板的指标是从 Prometheus 中获取的。如需更多信息,请参阅有关指标 的 Kuadrant 文档。
如果一些仪表板面板正常工作,连接链接中的 HTTPRoutes 必须包括一个与服务名称匹配的服务和部署匹配的服务和部署标签,例如 。这允许使用网关 API 状态指标加入低级 Istio 和 Envoy 指标。
service =my-app 和 appdeployment =my-
其他资源
3.2. 配置示例 Prometheus 警报 复制链接链接已复制到粘贴板!
您可以将 Kuadrant 示例警报 集成到 Prometheus 中作为 PrometheusRule 资源,然后调整警报阈值以满足您的特定操作需求。
还包括使用 Sloth GitHub 项目 生成的服务级别目标(SLO)警报。您可以使用这些警报与 SLO Grafana 仪表板集成,该仪表板 使用生成的标签来全面概述 SLO。
有关如何配置 Prometheus 警报的详情,请参阅有关管理警报规则的 OpenShift 文档。
附录 A. 使用您的红帽订阅 复制链接链接已复制到粘贴板!
红帽连接链接通过软件订阅提供。要管理您的订阅,请通过红帽客户门户网站访问您的帐户。
管理您的订阅
- 转至 access.redhat.com。
- 如果您还没有帐户,请创建一个帐户。
- 登录到您的帐户。
- 在菜单栏中,单击 Subscriptions 以查看和管理您的订阅。
更新于 2025-05-14