diff --git a/content/zh/docs/concepts/cluster-administration/system-metrics.md b/content/zh/docs/concepts/cluster-administration/system-metrics.md index fc2c5de272..60e1847ee4 100644 --- a/content/zh/docs/concepts/cluster-administration/system-metrics.md +++ b/content/zh/docs/concepts/cluster-administration/system-metrics.md @@ -4,6 +4,16 @@ content_type: concept weight: 60 --- + + 系统组件指标可以更好地了解系统内部发生的情况。指标对于构建仪表板和告警特别有用。 -Kubernetes 组件以 [Prometheus 格式](https://prometheus.io/docs/instrumenting/exposition_formats/)生成度量值。 +Kubernetes 组件以 [Prometheus 格式](https://prometheus.io/docs/instrumenting/exposition_formats/) +生成度量值。 这种格式是结构化的纯文本，旨在使人和机器都可以阅读。 @@ -25,20 +36,6 @@ Kubernetes 组件以 [Prometheus 格式](https://prometheus.io/docs/instrumentin In most cases metrics are available on `/metrics` endpoint of the HTTP server. For components that doesn't expose endpoint by default it can be enabled using `--bind-address` flag. Examples of those components: - -* {{< glossary_tooltip term_id="kube-controller-manager" text="kube-controller-manager" >}} -* {{< glossary_tooltip term_id="kube-proxy" text="kube-proxy" >}} -* {{< glossary_tooltip term_id="kube-apiserver" text="kube-apiserver" >}} -* {{< glossary_tooltip term_id="kube-scheduler" text="kube-scheduler" >}} -* {{< glossary_tooltip term_id="kubelet" text="kubelet" >}} - -In a production environment you may want to configure [Prometheus Server](https://prometheus.io/) or some other metrics scraper -to periodically gather these metrics and make them available in some kind of time series database. - -Note that {{< glossary_tooltip term_id="kubelet" text="kubelet" >}} also exposes metrics in `/metrics/cadvisor`, `/metrics/resource` and `/metrics/probes` endpoints. Those metrics do not have same lifecycle. - -If your cluster uses {{< glossary_tooltip term_id="rbac" text="RBAC" >}}, reading metrics requires authorization via a user, group or ServiceAccount with a ClusterRole that allows accessing `/metrics`. -For example: --> ## Kubernetes 中的指标 @@ -53,14 +50,24 @@ For example: * {{< glossary_tooltip term_id="kube-scheduler" text="kube-scheduler" >}} * {{< glossary_tooltip term_id="kubelet" text="kubelet" >}} -在生产环境中，你可能需要配置 [Prometheus 服务](https://prometheus.io/) 或 + +在生产环境中，你可能需要配置 [Prometheus 服务器](https://prometheus.io/) 或 某些其他指标搜集器以定期收集这些指标，并使它们在某种时间序列数据库中可用。 请注意，{{< glossary_tooltip term_id="kubelet" text="kubelet" >}} 还会在 `/metrics/cadvisor`， `/metrics/resource` 和 `/metrics/probes` 端点中公开度量值。这些度量值的生命周期各不相同。 如果你的集群使用了 {{< glossary_tooltip term_id="rbac" text="RBAC" >}}， -则读取指标需要通过基于用户、组或 ServiceAccount 的鉴权，要求具有允许访问 `/metrics` 的 ClusterRole。 +则读取指标需要通过基于用户、组或 ServiceAccount 的鉴权，要求具有允许访问 +`/metrics` 的 ClusterRole。 例如： ```yaml @@ -78,58 +85,69 @@ rules: ## 指标生命周期 -Alpha 指标 → 稳定指标 → 弃用指标 → 隐藏指标 → 删除 +Alpha 指标 → 稳定的指标 → 弃用的指标 → 隐藏的指标 → 删除的指标 -Alpha 指标没有稳定性保证，因此可以随时对其进行修改或者删除。 +Alpha 指标没有稳定性保证。这些指标可以随时被修改或者删除。 -稳定指标可以保证不会改变；具体而言，稳定意味着： +稳定的指标可以保证不会改变。这意味着： -* 指标本身不会被删除（或重命名） -* 指标的类型不会被更改 +* 稳定的、不包含已弃用（deprecated）签名的指标不会被删除（或重命名） +* 稳定的指标的类型不会被更改 -已弃用的指标表明该指标最终将被删除；要搞清楚对应版本，你需要检查其注解， -其中包括从哪个 kubernetes 版本开始，将不再考虑该指标。 - -过期前： - -``` -# HELP some_counter this counts things -# TYPE some_counter counter -some_counter 0 -``` - -过期后: - -``` -# HELP some_counter (Deprecated since 1.15.0) this counts things -# TYPE some_counter counter -some_counter 0 -``` +已弃用的指标最终将被删除，不过仍然可用。 +这类指标包含注解，标明其被废弃的版本。 -隐藏指标后，默认情况下，该指标不会发布以供抓取。要使用隐藏指标，你需要覆盖相关集群组件的配置。 +例如： -指标一旦删除，就不会发布。你无法通过重载配置来改变这一点。 +* 被弃用之前： + + ``` + # HELP some_counter this counts things + # TYPE some_counter counter + some_counter 0 + ``` +* 被启用之后： + + ``` + # HELP some_counter (Deprecated since 1.15.0) this counts things + # TYPE some_counter counter + some_counter 0 + ``` + + +隐藏的指标不会再被发布以供抓取，但仍然可用。 +要使用隐藏指标，请参阅[显式隐藏指标](#show-hidden-metrics)节。 + +删除的指标不再被发布，亦无法使用。 + + -## 显示隐藏指标 +## 显示隐藏指标 {#show-hidden-metrics} -综上所述，管理员可以通过设置可执行文件的命令行参数来启用隐藏指标， +如上所述，管理员可以通过设置可执行文件的命令行参数来启用隐藏指标， 如果管理员错过了上一版本中已经弃用的指标的迁移，则可以把这个用作管理员的逃生门。 -`show-hidden-metrics-for-version` 标志接受版本号作为取值，版本号给出你希望显示该发行版本中已弃用的指标。 +`show-hidden-metrics-for-version` 标志接受版本号作为取值，版本号给出 +你希望显示该发行版本中已弃用的指标。 版本表示为 x.y，其中 x 是主要版本，y 是次要版本。补丁程序版本不是必须的， 即使指标可能会在补丁程序发行版中弃用，原因是指标弃用策略规定仅针对次要版本。 @@ -226,6 +245,60 @@ cloudprovider_gce_api_request_duration_seconds { request = "detach_disk"} cloudprovider_gce_api_request_duration_seconds { request = "list_disk"} ``` + +### kube-scheduler 指标 {#kube-scheduler-metrics} + +{{< feature-state for_k8s_version="v1.20" state="alpha" >}} + +调度器会暴露一些可选的指标，报告所有运行中 Pods 所请求的资源和期望的约束值。 +这些指标可用来构造容量规划监控面板、访问调度约束的当前或历史数据、 +快速发现因为缺少资源而无法被调度的负载，或者将 Pod 的实际资源用量 +与其请求值进行比较。 + + +kube-scheduler 组件能够辩识各个 Pod 所配置的资源 +[请求和约束](/zh/docs/concepts/configuration/manage-resources-containers/)。 +在 Pod 的资源请求值或者约束值非零时，kube-scheduler 会以度量值时间序列的形式 +生成报告。该时间序列值包含以下标签： +- 名字空间 +- Pod 名称 +- Pod 调度所处节点，或者当 Pod 未被调度时用空字符串表示 +- 优先级 +- 为 Pod 所指派的调度器 +- 资源的名称（例如，`cpu`） +- 资源的单位，如果知道的话（例如，`cores`） + + +一旦 Pod 进入完成状态（其 `restartPolicy` 为 `Never` 或 `OnFailure`，且 +其处于 `Succeeded` 或 `Failed` Pod 阶段，或者已经被删除且所有容器都具有 +终止状态），该时间序列停止报告，因为调度器现在可以调度其它 Pod 来执行。 +这两个指标称作 `kube_pod_resource_request` 和 `kube_pod_resource_limit`。 + +指标暴露在 HTTP 端点 `/metrics/resources`，与调度器上的 `/metrics` 端点 +一样要求相同的访问授权。你必须使用 +`--show-hidden-metrics-for-version=1.20` 标志才能暴露那些稳定性为 Alpha +的指标。 + ## {{% heading "whatsnext" %}} * 阅读有关指标的 [Prometheus 文本格式](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#text-based-format) -* 查看 [Kubernetes 稳定指标](https://github.com/kubernetes/kubernetes/blob/master/test/instrumentation/testdata/stable-metrics-list.yaml)的列表 +* 查看 [Kubernetes 稳定指标](https://github.com/kubernetes/kubernetes/blob/master/test/instrumentation/testdata/stable-metrics-list.yaml) + 的列表 * 阅读有关 [Kubernetes 弃用策略](/zh/docs/reference/using-api/deprecation-policy/#deprecating-a-feature-or-behavior)