From 85df6c1c27d757a02b3718c06c97119fc6a80fdc Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 16:40:54 +0800 Subject: [PATCH 01/20] add-hint-log-and-k8sPrometheus --- zh/deploy-on-aws-eks.md | 12 ++++++++++++ zh/deploy-on-azure-aks.md | 12 ++++++++++++ zh/deploy-on-gcp-gke.md | 12 ++++++++++++ zh/deploy-on-general-kubernetes.md | 12 ++++++++++++ 4 files changed, 48 insertions(+) diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md index a543f8331..df550b3ac 100644 --- a/zh/deploy-on-aws-eks.md +++ b/zh/deploy-on-aws-eks.md @@ -703,3 +703,15 @@ spec: 最后使用 `kubectl -n tidb-cluster apply -f tidb-cluster.yaml` 更新 TiDB 集群配置。 更多可参考 [API 文档](https://github.com/pingcap/tidb-operator/blob/v1.6.0/docs/api-references/docs.md)和[集群配置文档](configure-a-tidb-cluster.md)完成 CR 文件配置。 + +## 配置 TiDB 监控 + +请参阅[部署 TiDB 集群监控与告警](monitor-a-tidb-cluster.md)。 + +> **注意:** +> +> 建议[持久化监控数据](monitor-a-tidb-cluster#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 + +## 日志收集 + +请参阅[日志收集](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/logs-collection)。 diff --git a/zh/deploy-on-azure-aks.md b/zh/deploy-on-azure-aks.md index 7067b6154..c7ff8c38e 100644 --- a/zh/deploy-on-azure-aks.md +++ b/zh/deploy-on-azure-aks.md @@ -569,3 +569,15 @@ Azure Disk 支持多种磁盘类型。若需要低延迟、高吞吐,可以选 3. 使用本地存储。 完成前面步骤后,local-volume-provisioner 即可发现集群内所有本地 NVMe SSD 盘。在 tidb-cluster.yaml 中添加 `tikv.storageClassName` 字段并设置为 `local-storage` 即可,可以参考前文[部署 TiDB 集群和监控](#部署-tidb-集群和监控)部分。 + +## 配置 TiDB 监控 + +请参阅[部署 TiDB 集群监控与告警](monitor-a-tidb-cluster.md)。 + +> **注意:** +> +> 建议[持久化监控数据](monitor-a-tidb-cluster#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 + +## 日志收集 + +请参阅[日志收集](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/logs-collection)。 diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md index e4a68daae..bbedc57ef 100644 --- a/zh/deploy-on-gcp-gke.md +++ b/zh/deploy-on-gcp-gke.md @@ -448,3 +448,15 @@ spec: 最后使用 `kubectl -n tidb-cluster apply -f tidb-cluster.yaml` 更新 TiDB 集群配置。 更多可参考 [API 文档](https://github.com/pingcap/tidb-operator/blob/v1.6.0/docs/api-references/docs.md)和[集群配置文档](configure-a-tidb-cluster.md)完成 CR 文件配置。 + +## 配置 TiDB 监控 + +请参阅[部署 TiDB 集群监控与告警](monitor-a-tidb-cluster.md)。 + +> **注意:** +> +> 建议[持久化监控数据](monitor-a-tidb-cluster#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 + +## 日志收集 + +请参阅[日志收集](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/logs-collection)。 diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index cc8456b4b..74d236b15 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -133,3 +133,15 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t > **注意:** > > TiDB(v4.0.2 起且发布于 2023 年 2 月 20 日前的版本)默认会定期收集使用情况信息,并将这些信息分享给 PingCAP 用于改善产品。若要了解所收集的信息详情及如何禁用该行为,请参见 [TiDB 遥测功能使用文档](https://docs.pingcap.com/zh/tidb/stable/telemetry)。自 2023 年 2 月 20 日起,新发布的 TiDB 版本默认不再收集使用情况信息分享给 PingCAP,参见 [TiDB 版本发布时间线](https://docs.pingcap.com/zh/tidb/stable/release-timeline)。 + +## 配置 TiDB 监控 + +请参阅[部署 TiDB 集群监控与告警](monitor-a-tidb-cluster.md)。 + +> **注意:** +> +> 建议[持久化监控数据](monitor-a-tidb-cluster#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 + +## 日志收集 + +请参阅[日志收集](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/logs-collection)。 From 0d086b6eafa7248e45eca487cb1c858b5c1e7c3a Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 16:50:13 +0800 Subject: [PATCH 02/20] fix --- zh/deploy-on-aws-eks.md | 2 +- zh/deploy-on-azure-aks.md | 2 +- zh/deploy-on-gcp-gke.md | 2 +- zh/deploy-on-general-kubernetes.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md index df550b3ac..131f41aa2 100644 --- a/zh/deploy-on-aws-eks.md +++ b/zh/deploy-on-aws-eks.md @@ -710,7 +710,7 @@ spec: > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 +> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 ## 日志收集 diff --git a/zh/deploy-on-azure-aks.md b/zh/deploy-on-azure-aks.md index c7ff8c38e..01bb6df7e 100644 --- a/zh/deploy-on-azure-aks.md +++ b/zh/deploy-on-azure-aks.md @@ -576,7 +576,7 @@ Azure Disk 支持多种磁盘类型。若需要低延迟、高吞吐,可以选 > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 +> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 ## 日志收集 diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md index bbedc57ef..357698d03 100644 --- a/zh/deploy-on-gcp-gke.md +++ b/zh/deploy-on-gcp-gke.md @@ -455,7 +455,7 @@ spec: > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 +> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 ## 日志收集 diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 74d236b15..27d52f979 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -140,7 +140,7 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 +> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 ## 日志收集 From b69d5e66b43b1d043e6ae14cf40adcd1eb4bb58f Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 17:01:29 +0800 Subject: [PATCH 03/20] fix --- zh/deploy-on-general-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 27d52f979..671f929fb 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -140,7 +140,7 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 +> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 ## 日志收集 From efc4cdd2ee1844b2193921458f3a7071e9c94ac4 Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 17:05:58 +0800 Subject: [PATCH 04/20] fix --- zh/deploy-on-general-kubernetes.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 671f929fb..4e56cb68c 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -140,8 +140,9 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 +> 默认 TiDB 监控数据不会持久化,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 +> 默认 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 ## 日志收集 -请参阅[日志收集](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/logs-collection)。 +请参阅[日志收集](logs-collection.md)。 From bf60ccf948b60d1f364915a9296f8c12f8508300 Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 17:09:55 +0800 Subject: [PATCH 05/20] fix --- zh/deploy-on-general-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 4e56cb68c..8b8f69e9f 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -145,4 +145,4 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t ## 日志收集 -请参阅[日志收集](logs-collection.md)。 +系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 From b68ff7cc30541ec788398fc12d2db72a66857ea8 Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 17:12:41 +0800 Subject: [PATCH 06/20] fix --- zh/deploy-on-general-kubernetes.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 8b8f69e9f..828add198 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -140,8 +140,7 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t > **注意:** > -> 默认 TiDB 监控数据不会持久化,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 -> 默认 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 +> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 ## 日志收集 From 5143823e82be5b55a11a5af46215dc7396650254 Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 17:19:20 +0800 Subject: [PATCH 07/20] fix --- zh/deploy-on-general-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 828add198..9aa47b840 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -144,4 +144,4 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t ## 日志收集 -系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 +系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时会容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 From 0cc4ebfc09d304c98080c4967436fc53dc084814 Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 17:20:56 +0800 Subject: [PATCH 08/20] fix --- zh/deploy-on-general-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 9aa47b840..25c9d9fc8 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -144,4 +144,4 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t ## 日志收集 -系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时会容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 +系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 From c289d6c37dce3b109d7d1fd0281ec1dae1d3377c Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 17:25:52 +0800 Subject: [PATCH 09/20] fix --- zh/deploy-on-aws-eks.md | 4 ++-- zh/deploy-on-azure-aks.md | 4 ++-- zh/deploy-on-gcp-gke.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md index 131f41aa2..69e790bac 100644 --- a/zh/deploy-on-aws-eks.md +++ b/zh/deploy-on-aws-eks.md @@ -710,8 +710,8 @@ spec: > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 +> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 ## 日志收集 -请参阅[日志收集](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/logs-collection)。 +系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 diff --git a/zh/deploy-on-azure-aks.md b/zh/deploy-on-azure-aks.md index 01bb6df7e..352ba000a 100644 --- a/zh/deploy-on-azure-aks.md +++ b/zh/deploy-on-azure-aks.md @@ -576,8 +576,8 @@ Azure Disk 支持多种磁盘类型。若需要低延迟、高吞吐,可以选 > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 +> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 ## 日志收集 -请参阅[日志收集](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/logs-collection)。 +系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md index 357698d03..bd5346ee8 100644 --- a/zh/deploy-on-gcp-gke.md +++ b/zh/deploy-on-gcp-gke.md @@ -455,8 +455,8 @@ spec: > **注意:** > -> 建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据),并[设置 kube-prometheus 与 AlertManager](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/monitor-a-tidb-cluster.md#%E8%AE%BE%E7%BD%AE-kube-prometheus-%E4%B8%8E-alertmanager)。 +> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 ## 日志收集 -请参阅[日志收集](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/logs-collection)。 +系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 From 66dc22f7a691993490fb6a2fd664093bcf6622a9 Mon Sep 17 00:00:00 2001 From: yiduoyunQ <719547995@qq.com> Date: Mon, 29 Jul 2024 17:35:20 +0800 Subject: [PATCH 10/20] add en --- en/deploy-on-aws-eks.md | 12 ++++++++++++ en/deploy-on-azure-aks.md | 12 ++++++++++++ en/deploy-on-gcp-gke.md | 12 ++++++++++++ en/deploy-on-general-kubernetes.md | 12 ++++++++++++ 4 files changed, 48 insertions(+) diff --git a/en/deploy-on-aws-eks.md b/en/deploy-on-aws-eks.md index 9414fe441..886e86a6e 100644 --- a/en/deploy-on-aws-eks.md +++ b/en/deploy-on-aws-eks.md @@ -721,3 +721,15 @@ Depending on the EKS cluster status, use different commands: Finally, execute `kubectl -n tidb-cluster apply -f tidb-cluster.yaml` to update the TiDB cluster configuration. For detailed CR configuration, refer to [API references](https://github.com/pingcap/tidb-operator/blob/v1.6.0/docs/api-references/docs.md) and [Configure a TiDB Cluster](configure-a-tidb-cluster.md). + +## Configure TiDB monitor + +Please see [Deploy Monitoring and Alerts for a TiDB Cluster](monitor-a-tidb-cluster.md). + +> **Note:** +> +> TiDB monitor don't persist data by default,it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitor don't have POD's CPU, memory, disk metrics, also don't have alert manager, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). + +## Log Collection + +The system and application logs can be useful for troubleshooting issues and automating operations, The TiDB components output the logs in the stdout and stderr of the container by default, and be auto rotated accord to container runtime, when POD restarted log will lost, it is recommended to [Collect logs of TiDB and related components](logs-collection.md). diff --git a/en/deploy-on-azure-aks.md b/en/deploy-on-azure-aks.md index f8a8b00d0..e2c3f99cf 100644 --- a/en/deploy-on-azure-aks.md +++ b/en/deploy-on-azure-aks.md @@ -584,3 +584,15 @@ For instance types that provide local disks, refer to [Lsv2-series](https://docs Add the `tikv.storageClassName` field to the `tidb-cluster.yaml` file and set the value of the field to `local-storage`. For more information, refer to [Deploy TiDB cluster and its monitoring components](#deploy) + +## Configure TiDB monitor + +Please see [Deploy Monitoring and Alerts for a TiDB Cluster](monitor-a-tidb-cluster.md). + +> **Note:** +> +> TiDB monitor don't persist data by default,it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitor don't have POD's CPU, memory, disk metrics, also don't have alert manager, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). + +## Log Collection + +The system and application logs can be useful for troubleshooting issues and automating operations, The TiDB components output the logs in the stdout and stderr of the container by default, and be auto rotated accord to container runtime, when POD restarted log will lost, it is recommended to [Collect logs of TiDB and related components](logs-collection.md). diff --git a/en/deploy-on-gcp-gke.md b/en/deploy-on-gcp-gke.md index 94b4fc614..b8254873e 100644 --- a/en/deploy-on-gcp-gke.md +++ b/en/deploy-on-gcp-gke.md @@ -469,3 +469,15 @@ The two components are *not required* in the deployment. This section shows a qu Finally, execute `kubectl -n tidb-cluster apply -f tidb-cluster.yaml` to update the TiDB cluster configuration. For detailed CR configuration, refer to [API references](https://github.com/pingcap/tidb-operator/blob/v1.6.0/docs/api-references/docs.md) and [Configure a TiDB Cluster](configure-a-tidb-cluster.md). + +## Configure TiDB monitor + +Please see [Deploy Monitoring and Alerts for a TiDB Cluster](monitor-a-tidb-cluster.md). + +> **Note:** +> +> TiDB monitor don't persist data by default,it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitor don't have POD's CPU, memory, disk metrics, also don't have alert manager, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). + +## Log Collection + +The system and application logs can be useful for troubleshooting issues and automating operations, The TiDB components output the logs in the stdout and stderr of the container by default, and be auto rotated accord to container runtime, when POD restarted log will lost, it is recommended to [Collect logs of TiDB and related components](logs-collection.md). diff --git a/en/deploy-on-general-kubernetes.md b/en/deploy-on-general-kubernetes.md index c630b0d34..e71824ee3 100644 --- a/en/deploy-on-general-kubernetes.md +++ b/en/deploy-on-general-kubernetes.md @@ -133,3 +133,15 @@ If you want to initialize your cluster after deployment, refer to [Initialize a > **Note:** > > By default, TiDB (versions starting from v4.0.2 and released before February 20, 2023) periodically shares usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](https://docs.pingcap.com/tidb/stable/telemetry). Starting from February 20, 2023, the telemetry feature is disabled by default in newly released TiDB versions. See [TiDB Release Timeline](https://docs.pingcap.com/tidb/stable/release-timeline) for details. + +## Configure TiDB monitor + +Please see [Deploy Monitoring and Alerts for a TiDB Cluster](monitor-a-tidb-cluster.md). + +> **Note:** +> +> TiDB monitor don't persist data by default,it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitor don't have POD's CPU, memory, disk metrics, also don't have alert manager, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). + +## Log Collection + +The system and application logs can be useful for troubleshooting issues and automating operations, The TiDB components output the logs in the stdout and stderr of the container by default, and be auto rotated accord to container runtime, when POD restarted log will lost, it is recommended to [Collect logs of TiDB and related components](logs-collection.md). From 19add0f7309f61cffe2648ea68db0f56f89f598c Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 29 Jul 2024 17:50:07 +0800 Subject: [PATCH 11/20] fix link --- zh/deploy-on-aws-eks.md | 2 +- zh/deploy-on-azure-aks.md | 2 +- zh/deploy-on-gcp-gke.md | 2 +- zh/deploy-on-general-kubernetes.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md index 69e790bac..24fc24f94 100644 --- a/zh/deploy-on-aws-eks.md +++ b/zh/deploy-on-aws-eks.md @@ -710,7 +710,7 @@ spec: > **注意:** > -> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 +> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 ## 日志收集 diff --git a/zh/deploy-on-azure-aks.md b/zh/deploy-on-azure-aks.md index 352ba000a..e52ae2e4c 100644 --- a/zh/deploy-on-azure-aks.md +++ b/zh/deploy-on-azure-aks.md @@ -576,7 +576,7 @@ Azure Disk 支持多种磁盘类型。若需要低延迟、高吞吐,可以选 > **注意:** > -> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 +> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 ## 日志收集 diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md index bd5346ee8..0b6ff5ab6 100644 --- a/zh/deploy-on-gcp-gke.md +++ b/zh/deploy-on-gcp-gke.md @@ -455,7 +455,7 @@ spec: > **注意:** > -> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 +> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 ## 日志收集 diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 25c9d9fc8..d56a4a9dc 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -140,7 +140,7 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t > **注意:** > -> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-AlertManager)。 +> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 ## 日志收集 From 67a8265c23b0e40183d44b5c4817c30b6560d3e1 Mon Sep 17 00:00:00 2001 From: jirongq <719547995@qq.com> Date: Tue, 30 Jul 2024 10:30:22 +0800 Subject: [PATCH 12/20] Update zh/deploy-on-aws-eks.md Co-authored-by: Aolin --- zh/deploy-on-aws-eks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md index 24fc24f94..448bf8295 100644 --- a/zh/deploy-on-aws-eks.md +++ b/zh/deploy-on-aws-eks.md @@ -710,7 +710,7 @@ spec: > **注意:** > -> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 +> TiDB 监控默认不会持久化数据,为确保数据长期可用,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。TiDB 监控不包含 Pod 的 CPU、内存、磁盘监控,也没有报警系统。为实现更全面的监控和告警,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 ## 日志收集 From d33ebb76229f32ac0172d287eb03d79f9c557495 Mon Sep 17 00:00:00 2001 From: jirongq <719547995@qq.com> Date: Tue, 30 Jul 2024 10:30:44 +0800 Subject: [PATCH 13/20] Update zh/deploy-on-azure-aks.md Co-authored-by: Aolin --- zh/deploy-on-azure-aks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-azure-aks.md b/zh/deploy-on-azure-aks.md index e52ae2e4c..5adebe931 100644 --- a/zh/deploy-on-azure-aks.md +++ b/zh/deploy-on-azure-aks.md @@ -576,7 +576,7 @@ Azure Disk 支持多种磁盘类型。若需要低延迟、高吞吐,可以选 > **注意:** > -> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 +> TiDB 监控默认不会持久化数据,为确保数据长期可用,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。TiDB 监控不包含 Pod 的 CPU、内存、磁盘监控,也没有报警系统。为实现更全面的监控和告警,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 ## 日志收集 From d46d1086d5a3639f744988689dde7bf8199021e6 Mon Sep 17 00:00:00 2001 From: jirongq <719547995@qq.com> Date: Tue, 30 Jul 2024 10:30:57 +0800 Subject: [PATCH 14/20] Update zh/deploy-on-gcp-gke.md Co-authored-by: Aolin --- zh/deploy-on-gcp-gke.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md index 0b6ff5ab6..d59d492aa 100644 --- a/zh/deploy-on-gcp-gke.md +++ b/zh/deploy-on-gcp-gke.md @@ -455,7 +455,7 @@ spec: > **注意:** > -> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 +> TiDB 监控默认不会持久化数据,为确保数据长期可用,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。TiDB 监控不包含 Pod 的 CPU、内存、磁盘监控,也没有报警系统。为实现更全面的监控和告警,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 ## 日志收集 From 2f94a91881ab07d488c38728d2dc23a305e00496 Mon Sep 17 00:00:00 2001 From: jirongq <719547995@qq.com> Date: Tue, 30 Jul 2024 10:31:07 +0800 Subject: [PATCH 15/20] Update zh/deploy-on-general-kubernetes.md Co-authored-by: Aolin --- zh/deploy-on-general-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index d56a4a9dc..e77272ee6 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -140,7 +140,7 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t > **注意:** > -> TiDB 监控默认不会持久化数据,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。 TiDB 监控不包含 POD 的 CPU、内存、磁盘监控,也没有报警系统,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 +> TiDB 监控默认不会持久化数据,为确保数据长期可用,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。TiDB 监控不包含 Pod 的 CPU、内存、磁盘监控,也没有报警系统。为实现更全面的监控和告警,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 ## 日志收集 From 3d8d6abe21b04fae6757ac340894d4639beaafbf Mon Sep 17 00:00:00 2001 From: jirongq <719547995@qq.com> Date: Tue, 30 Jul 2024 10:31:55 +0800 Subject: [PATCH 16/20] Update zh/deploy-on-general-kubernetes.md Co-authored-by: Aolin --- zh/deploy-on-general-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index e77272ee6..821d3d7bc 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -144,4 +144,4 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t ## 日志收集 -系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 +系统与程序的运行日志对排查问题和实现自动化操作可能非常有用。TiDB 各组件默认将日志输出到容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理。当 Pod 重启时,容器日志会丢失。为防止日志丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 From 7a8c688c5a96defe9617766891e0bd1217b51e29 Mon Sep 17 00:00:00 2001 From: jirongq <719547995@qq.com> Date: Tue, 30 Jul 2024 10:32:02 +0800 Subject: [PATCH 17/20] Update zh/deploy-on-gcp-gke.md Co-authored-by: Aolin --- zh/deploy-on-gcp-gke.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md index d59d492aa..041cbb681 100644 --- a/zh/deploy-on-gcp-gke.md +++ b/zh/deploy-on-gcp-gke.md @@ -459,4 +459,4 @@ spec: ## 日志收集 -系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 +系统与程序的运行日志对排查问题和实现自动化操作可能非常有用。TiDB 各组件默认将日志输出到容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理。当 Pod 重启时,容器日志会丢失。为防止日志丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 From ff4054a7d082b287350e3e07015bb540411c11a7 Mon Sep 17 00:00:00 2001 From: jirongq <719547995@qq.com> Date: Tue, 30 Jul 2024 10:32:09 +0800 Subject: [PATCH 18/20] Update zh/deploy-on-azure-aks.md Co-authored-by: Aolin --- zh/deploy-on-azure-aks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-azure-aks.md b/zh/deploy-on-azure-aks.md index 5adebe931..ee3e4ba01 100644 --- a/zh/deploy-on-azure-aks.md +++ b/zh/deploy-on-azure-aks.md @@ -580,4 +580,4 @@ Azure Disk 支持多种磁盘类型。若需要低延迟、高吞吐,可以选 ## 日志收集 -系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 +系统与程序的运行日志对排查问题和实现自动化操作可能非常有用。TiDB 各组件默认将日志输出到容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理。当 Pod 重启时,容器日志会丢失。为防止日志丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 From 7293e0fa43e8811087aff578daac631e30e76953 Mon Sep 17 00:00:00 2001 From: jirongq <719547995@qq.com> Date: Tue, 30 Jul 2024 10:32:16 +0800 Subject: [PATCH 19/20] Update zh/deploy-on-aws-eks.md Co-authored-by: Aolin --- zh/deploy-on-aws-eks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md index 448bf8295..3cfaf154e 100644 --- a/zh/deploy-on-aws-eks.md +++ b/zh/deploy-on-aws-eks.md @@ -714,4 +714,4 @@ spec: ## 日志收集 -系统与程序的运行日志对排查问题以及实现一些自动化操作可能非常有用,TiDB 各组件默认将日志输出在容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理,当 POD 发生重启时容器日志会丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 +系统与程序的运行日志对排查问题和实现自动化操作可能非常有用。TiDB 各组件默认将日志输出到容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理。当 Pod 重启时,容器日志会丢失。为防止日志丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 From 30dace3670aabbd99337875bf63b65cc7c0dd346 Mon Sep 17 00:00:00 2001 From: Aolin Date: Tue, 30 Jul 2024 10:43:37 +0800 Subject: [PATCH 20/20] refine wording --- en/deploy-on-aws-eks.md | 12 ++++++------ en/deploy-on-azure-aks.md | 12 ++++++------ en/deploy-on-gcp-gke.md | 12 ++++++------ en/deploy-on-general-kubernetes.md | 12 ++++++------ zh/deploy-on-aws-eks.md | 2 +- zh/deploy-on-azure-aks.md | 2 +- zh/deploy-on-gcp-gke.md | 2 +- zh/deploy-on-general-kubernetes.md | 2 +- 8 files changed, 28 insertions(+), 28 deletions(-) diff --git a/en/deploy-on-aws-eks.md b/en/deploy-on-aws-eks.md index 886e86a6e..acdaa780c 100644 --- a/en/deploy-on-aws-eks.md +++ b/en/deploy-on-aws-eks.md @@ -722,14 +722,14 @@ Finally, execute `kubectl -n tidb-cluster apply -f tidb-cluster.yaml` to update For detailed CR configuration, refer to [API references](https://github.com/pingcap/tidb-operator/blob/v1.6.0/docs/api-references/docs.md) and [Configure a TiDB Cluster](configure-a-tidb-cluster.md). -## Configure TiDB monitor +## Configure TiDB monitoring -Please see [Deploy Monitoring and Alerts for a TiDB Cluster](monitor-a-tidb-cluster.md). +For more information, see [Deploy monitoring and alerts for a TiDB cluster](monitor-a-tidb-cluster.md). -> **Note:** +> **Note:** > -> TiDB monitor don't persist data by default,it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitor don't have POD's CPU, memory, disk metrics, also don't have alert manager, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). +> TiDB monitoring does not persist data by default. To ensure long-term data availability, it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitoring does not include Pod CPU, memory, or disk monitoring, nor does it have an alerting system. For more comprehensive monitoring and alerting, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). -## Log Collection +## Collect logs -The system and application logs can be useful for troubleshooting issues and automating operations, The TiDB components output the logs in the stdout and stderr of the container by default, and be auto rotated accord to container runtime, when POD restarted log will lost, it is recommended to [Collect logs of TiDB and related components](logs-collection.md). +System and application logs can be useful for troubleshooting issues and automating operations. By default, TiDB components output logs to the container's `stdout` and `stderr`, and log rotation is automatically performed based on the container runtime environment. When a Pod restarts, container logs will be lost. To prevent log loss, it is recommended to [Collect logs of TiDB and its related components](logs-collection.md). diff --git a/en/deploy-on-azure-aks.md b/en/deploy-on-azure-aks.md index e2c3f99cf..02a622d15 100644 --- a/en/deploy-on-azure-aks.md +++ b/en/deploy-on-azure-aks.md @@ -585,14 +585,14 @@ For instance types that provide local disks, refer to [Lsv2-series](https://docs For more information, refer to [Deploy TiDB cluster and its monitoring components](#deploy) -## Configure TiDB monitor +## Configure TiDB monitoring -Please see [Deploy Monitoring and Alerts for a TiDB Cluster](monitor-a-tidb-cluster.md). +For more information, see [Deploy monitoring and alerts for a TiDB cluster](monitor-a-tidb-cluster.md). -> **Note:** +> **Note:** > -> TiDB monitor don't persist data by default,it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitor don't have POD's CPU, memory, disk metrics, also don't have alert manager, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). +> TiDB monitoring does not persist data by default. To ensure long-term data availability, it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitoring does not include Pod CPU, memory, or disk monitoring, nor does it have an alerting system. For more comprehensive monitoring and alerting, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). -## Log Collection +## Collect logs -The system and application logs can be useful for troubleshooting issues and automating operations, The TiDB components output the logs in the stdout and stderr of the container by default, and be auto rotated accord to container runtime, when POD restarted log will lost, it is recommended to [Collect logs of TiDB and related components](logs-collection.md). +System and application logs can be useful for troubleshooting issues and automating operations. By default, TiDB components output logs to the container's `stdout` and `stderr`, and log rotation is automatically performed based on the container runtime environment. When a Pod restarts, container logs will be lost. To prevent log loss, it is recommended to [Collect logs of TiDB and its related components](logs-collection.md). diff --git a/en/deploy-on-gcp-gke.md b/en/deploy-on-gcp-gke.md index b8254873e..1a8f3b7e8 100644 --- a/en/deploy-on-gcp-gke.md +++ b/en/deploy-on-gcp-gke.md @@ -470,14 +470,14 @@ Finally, execute `kubectl -n tidb-cluster apply -f tidb-cluster.yaml` to update For detailed CR configuration, refer to [API references](https://github.com/pingcap/tidb-operator/blob/v1.6.0/docs/api-references/docs.md) and [Configure a TiDB Cluster](configure-a-tidb-cluster.md). -## Configure TiDB monitor +## Configure TiDB monitoring -Please see [Deploy Monitoring and Alerts for a TiDB Cluster](monitor-a-tidb-cluster.md). +For more information, see [Deploy monitoring and alerts for a TiDB cluster](monitor-a-tidb-cluster.md). -> **Note:** +> **Note:** > -> TiDB monitor don't persist data by default,it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitor don't have POD's CPU, memory, disk metrics, also don't have alert manager, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). +> TiDB monitoring does not persist data by default. To ensure long-term data availability, it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitoring does not include Pod CPU, memory, or disk monitoring, nor does it have an alerting system. For more comprehensive monitoring and alerting, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). -## Log Collection +## Collect logs -The system and application logs can be useful for troubleshooting issues and automating operations, The TiDB components output the logs in the stdout and stderr of the container by default, and be auto rotated accord to container runtime, when POD restarted log will lost, it is recommended to [Collect logs of TiDB and related components](logs-collection.md). +System and application logs can be useful for troubleshooting issues and automating operations. By default, TiDB components output logs to the container's `stdout` and `stderr`, and log rotation is automatically performed based on the container runtime environment. When a Pod restarts, container logs will be lost. To prevent log loss, it is recommended to [Collect logs of TiDB and its related components](logs-collection.md). diff --git a/en/deploy-on-general-kubernetes.md b/en/deploy-on-general-kubernetes.md index e71824ee3..a4108a14f 100644 --- a/en/deploy-on-general-kubernetes.md +++ b/en/deploy-on-general-kubernetes.md @@ -134,14 +134,14 @@ If you want to initialize your cluster after deployment, refer to [Initialize a > > By default, TiDB (versions starting from v4.0.2 and released before February 20, 2023) periodically shares usage details with PingCAP to help understand how to improve the product. For details about what is shared and how to disable the sharing, see [Telemetry](https://docs.pingcap.com/tidb/stable/telemetry). Starting from February 20, 2023, the telemetry feature is disabled by default in newly released TiDB versions. See [TiDB Release Timeline](https://docs.pingcap.com/tidb/stable/release-timeline) for details. -## Configure TiDB monitor +## Configure TiDB monitoring -Please see [Deploy Monitoring and Alerts for a TiDB Cluster](monitor-a-tidb-cluster.md). +For more information, see [Deploy monitoring and alerts for a TiDB cluster](monitor-a-tidb-cluster.md). -> **Note:** +> **Note:** > -> TiDB monitor don't persist data by default,it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitor don't have POD's CPU, memory, disk metrics, also don't have alert manager, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). +> TiDB monitoring does not persist data by default. To ensure long-term data availability, it is recommended to [persist monitoring data](monitor-a-tidb-cluster.md#persist-monitoring-data). TiDB monitoring does not include Pod CPU, memory, or disk monitoring, nor does it have an alerting system. For more comprehensive monitoring and alerting, it is recommended to [Set kube-prometheus and AlertManager](monitor-a-tidb-cluster.md#set-kube-prometheus-and-alertmanager). -## Log Collection +## Collect logs -The system and application logs can be useful for troubleshooting issues and automating operations, The TiDB components output the logs in the stdout and stderr of the container by default, and be auto rotated accord to container runtime, when POD restarted log will lost, it is recommended to [Collect logs of TiDB and related components](logs-collection.md). +System and application logs can be useful for troubleshooting issues and automating operations. By default, TiDB components output logs to the container's `stdout` and `stderr`, and log rotation is automatically performed based on the container runtime environment. When a Pod restarts, container logs will be lost. To prevent log loss, it is recommended to [Collect logs of TiDB and its related components](logs-collection.md). diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md index 3cfaf154e..2bc278db2 100644 --- a/zh/deploy-on-aws-eks.md +++ b/zh/deploy-on-aws-eks.md @@ -712,6 +712,6 @@ spec: > > TiDB 监控默认不会持久化数据,为确保数据长期可用,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。TiDB 监控不包含 Pod 的 CPU、内存、磁盘监控,也没有报警系统。为实现更全面的监控和告警,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 -## 日志收集 +## 收集日志 系统与程序的运行日志对排查问题和实现自动化操作可能非常有用。TiDB 各组件默认将日志输出到容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理。当 Pod 重启时,容器日志会丢失。为防止日志丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 diff --git a/zh/deploy-on-azure-aks.md b/zh/deploy-on-azure-aks.md index ee3e4ba01..1fa3cbed1 100644 --- a/zh/deploy-on-azure-aks.md +++ b/zh/deploy-on-azure-aks.md @@ -578,6 +578,6 @@ Azure Disk 支持多种磁盘类型。若需要低延迟、高吞吐,可以选 > > TiDB 监控默认不会持久化数据,为确保数据长期可用,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。TiDB 监控不包含 Pod 的 CPU、内存、磁盘监控,也没有报警系统。为实现更全面的监控和告警,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 -## 日志收集 +## 收集日志 系统与程序的运行日志对排查问题和实现自动化操作可能非常有用。TiDB 各组件默认将日志输出到容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理。当 Pod 重启时,容器日志会丢失。为防止日志丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md index 041cbb681..90b70e8e5 100644 --- a/zh/deploy-on-gcp-gke.md +++ b/zh/deploy-on-gcp-gke.md @@ -457,6 +457,6 @@ spec: > > TiDB 监控默认不会持久化数据,为确保数据长期可用,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。TiDB 监控不包含 Pod 的 CPU、内存、磁盘监控,也没有报警系统。为实现更全面的监控和告警,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 -## 日志收集 +## 收集日志 系统与程序的运行日志对排查问题和实现自动化操作可能非常有用。TiDB 各组件默认将日志输出到容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理。当 Pod 重启时,容器日志会丢失。为防止日志丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。 diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md index 821d3d7bc..bec54fbe3 100644 --- a/zh/deploy-on-general-kubernetes.md +++ b/zh/deploy-on-general-kubernetes.md @@ -142,6 +142,6 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-general-kubernetes/','/zh/t > > TiDB 监控默认不会持久化数据,为确保数据长期可用,建议[持久化监控数据](monitor-a-tidb-cluster.md#持久化监控数据)。TiDB 监控不包含 Pod 的 CPU、内存、磁盘监控,也没有报警系统。为实现更全面的监控和告警,建议[设置 kube-prometheus 与 AlertManager](monitor-a-tidb-cluster.md#设置-kube-prometheus-与-alertmanager)。 -## 日志收集 +## 收集日志 系统与程序的运行日志对排查问题和实现自动化操作可能非常有用。TiDB 各组件默认将日志输出到容器的 `stdout` 和 `stderr` 中,并依据容器运行时环境自动进行日志的滚动清理。当 Pod 重启时,容器日志会丢失。为防止日志丢失,建议[收集 TiDB 及相关组件日志](logs-collection.md)。