Config Sync 指标

本页面介绍了可用于监控 Config Sync 资源的 OpenTelemetry 指标。

Config Sync 使用 OpenCensus 创建和记录指标，并使用 OpenTelemetry 将其指标导出到 Prometheus 和 Cloud Monitoring。您可以将 OpenTelemetry 指标导出到其他监控系统。以下指南介绍了如何导出指标：

• Cloud Monitoring
• 自定义监控系统
• Prometheus

OpenTelemetry 指标

Config Sync 和 Resource Group Controller 使用 OpenCensus 收集以下指标，并通过 OpenTelemetry 收集器提供这些指标。标记列列出了适用于每个指标的 Config Sync 特定标记。带有标记的指标代表多个测量结果，每个标记值组合对应一个。

注意：协调器标记是根据 RootSync 和 RepoSync 对象动态创建的。如需查看此标记的外观和使用方法的示例，请参阅按照协调器查询指标。

Config Sync 指标

名称	类型	标签	说明
api_duration_seconds	分布	operation、status	API 服务器调用的延迟时间分布。
apply_duration_seconds	分布	status	将从可靠来源声明的资源应用于集群的延迟时间分布。
apply_operations_total	计数	operation、status、controller	为将资源从可靠来源同步到集群而执行的操作总数。
declared_resources	最后一个值		从 Git 解析的已声明资源数量。
internal_errors_total	计数	来源	Config Sync 遇到的内部错误总数。如果没有发生内部错误，指标可能不会显示在查询结果中。
last_sync_timestamp	最后一个值	status	从 Git 最近一次同步的时间戳。
parser_duration_seconds	分布	status、trigger、source	从可靠来源同步到集群所涉及的不同阶段的延迟时间分布。
pipeline_error_observed	最后一个值	name、reconciler、component	RootSync 和 RepoSync 自定义资源的状态。值 1 表示失败。
reconcile_duration_seconds	分布	status	由协调器管理器处理的协调事件的延迟时间分布。
reconciler_errors	最后一个值	component、errorclass	将资源从可靠来源同步到集群时遇到的错误数量。
remediate_duration_seconds	分布	status	补救器协调事件的延迟时间分布。
resource_conflicts_total	计数		因缓存资源和集群资源之间存在不匹配而导致的资源冲突总数。如果没有发生资源冲突，指标可能不会显示在查询结果中。
resource_fights_total	计数		过于频繁同步的资源总数。任何高于零的结果都表示有问题。如需了解详情，请参阅 KNV2005：ResourceFightWarning。 如果没有发生资源争夺，指标可能不会显示在查询结果中。

资源组控制器指标

资源组控制器是 Config Sync 中的一个组件，它可跟踪代管式资源并检查每个资源是否准备就绪或已协调。您可以查看以下指标。

名称	类型	标签	说明
rg_reconcile_duration_seconds	分布	stallreason	协调 ResourceGroup CR 所需的时间分布
resource_group_total	最后一个值		当前的 ResourceGroup CR 数量
resource_count	最后一个值	resourcegroup	一个 ResourceGroup 跟踪的资源总数
ready_resource_count	最后一个值	resourcegroup	ResourceGroup 中准备就绪的资源总数
resource_ns_count	最后一个值	resourcegroup	ResourceGroup 中的资源使用的命名空间数量
cluster_scoped_resource_count	最后一个值	resourcegroup	ResourceGroup 中集群范围的资源的数量
crd_count	最后一个值	resourcegroup	ResourceGroup 中的 CRD 数量
kcc_resource_count	最后一个值	resourcegroup	ResourceGroup 中的 KCC 资源总数
pipeline_error_observed	最后一个值	name、reconciler、component	RootSync 和 RepoSync 自定义资源的状态。值 1 表示失败。

Config Sync 指标标签

指标标签可用于聚合 Cloud Monitoring 和 Prometheus 中的指标数据。可从 Monitoring 控制台中的“分组依据”下拉列表选择这些指标。

如需详细了解 Cloud Monitoring 标签和 Prometheus 指标标签，请参阅指标模型的组成部分和 Prometheus 数据模型。

注意：Config Sync 指标和 Resource Group Controller 指标中的标记在概念上等效于本部分中的标签。

指标标签

Config Sync 和 Resource Group Controller 指标会使用以下标签，这些标签在使用 Cloud Monitoring 和 Prometheus 进行监控时可用。

名称	值	说明
operation	create、patch、update、delete	执行的操作类型
status	success、error	操作的执行状态
reconciler	rootsync、reposync	协调器的类型
source	parser、differ、remediator	内部错误的来源
trigger	retry、watchUpdate、managementConflict、resync、reimport	协调事件的触发因素
name	协调器的名称	协调器的名称
component	parsing、source、sync、rendering、readiness	协调所在组件/当前阶段的名称
container	reconciler、git-sync	容器的名称
resource	cpu、memory	资源的类型
controller	applier、remediator	根协调器或命名空间协调器中的控制器名称
type	任何 Kubernetes 资源，例如 ClusterRole、Namespace、NetworkPolicy、Role 等。	Kubernetes API 的类型
commit	----	最近同步的提交的哈希值

注意：根据生产代码库提交频率和部署的 Kubernetes Kind 的差异，与其他指标相比，指标标签 commit 和 type 可能会导致 Cloud Monitoring 指标写入吞吐量增加。受影响的指标包括 apply_duration_seconds、api_duration_seconds、declared_resources、apply_operations_total。如需避免费用增加或者您不需要这些指标，请按照相关说明使用 ConfigMap 修补 otel 收集器部署，并从 filter/cloudmonitoring 许可名单中移除上述指标。

资源标签

发送到 Prometheus 和 Cloud Monitoring 的 Config Sync 指标设置了以下指标标签来标识来源 Pod：

名称	说明
k8s.node.name	托管 Kubernetes Pod 的节点的名称
k8s.pod.namespace	Pod 的命名空间
k8s.pod.uid	Pod 的 UID
k8s.pod.ip	Pod 的 IP
k8s.deployment.name	拥有 Pod 的 Deployment 的名称

从 reconciler Pod 发送到 Prometheus 和 Cloud Monitoring 的 Config Sync 指标还设置了以下指标标签来标识用于配置协调器的 RootSync 或 RepoSync：

名称	说明
configsync.sync.kind	配置此协调器的资源种类：RootSync 或 RepoSync
configsync.sync.name	配置此协调器的 RootSync 或 RepoSync 的名称
configsync.sync.namespace	配置此协调器的 RootSync 或 RepoSync 的命名空间

Cloud Monitoring 资源标签

Cloud Monitoring 资源标签用于将存储空间中的指标编入索引，这意味着它们对基数的影响可以忽略不计，与指标标签不同，基数是重要的性能问题。如需了解详情，请参阅受监控的资源类型。

k8s_container 资源类型设置了以下资源标签来标识来源容器：

名称	说明
container_name	容器的名称
pod_name	Pod 的名称
namespace_name	Pod 的命名空间
location	托管节点的集群的区域或地区
cluster_name	托管节点的集群的名称
project	托管集群的项目的 ID

了解 pipeline_error_observed 指标

pipeline_error_observed 指标可帮助您快速识别未同步或包含未协调为所需状态的资源的 RepoSync 或 RootSync CR。

• 对于 RootSync 或 RepoSync 的成功同步，具有所有组件（rendering、source、sync、readiness）的指标的值显示为 0。

  

• 当最新提交使自动呈现失败时，包含组件 rendering 的指标的值为 1。

• 在签出最新提交遇到错误或最新提交包含无效配置时，具有组件 source 的指标的值显示为 1。

• 当某个资源无法应用于集群时，具有组件 sync 的指标的值显示为 1。

• 如果应用资源，但资源无法达到其所需状态，则具有组件 readiness 的指标的值显示为 1。例如，Deployment 已应用于集群，但相应的 pod 却未成功创建。

后续步骤

• 详细了解如何监控 RootSync 和 RepoSync 对象。
• 了解如何使用 Config Sync SLI。