mirror of
https://github.com/kubesphere/website.git
synced 2025-12-26 00:12:48 +00:00
finish extension translation
Signed-off-by: zhuxiujuan28 <562873187@qq.com>
This commit is contained in:
zhuxiujuan28
parent
e5737379f9
commit
ac67f38fd0
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 28a65f11229c45f0bcd1b632d006acbb
|
||||
* Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18] in the upper right corner of the list to refresh the list information.
|
||||
* Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18] in the upper right corner of the list to refresh the list information.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 7a00832787eb484492170688816b225c
|
||||
本节介绍如何查看告警列表。
|
||||
This section describes how to view the alert list.
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: a11cb13f4c4d44e59332bb4fe44859c0
|
||||
. 在**告警**页面点击**来源于自定义规则**或**来源于内置规则**打开告警列表。
|
||||
. On the **Alerts** page, click **From Custom Rules** or **From Built-in Rules** to open the alert list.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: c6a3057001e24f3d85a69f8429cf509c
|
||||
* 在列表上方点击搜索框并设置搜索条件，可按告警内容、告警状态、告警级别和规则名称搜索告警。
|
||||
* Click the search box above the list to search for alerts by alert content, alert status, severity, and rule name.
|
||||
|
|
@ -1,36 +1,36 @@
|
|||
// :ks_include_id: 9bb30ff8148c403aa266fbe96dcaa2a8
|
||||
* 告警列表提供以下信息：
|
||||
* The alert list provides the following information:
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|消息
|
||||
|Message
|
||||
|
|
||||
include::../ruleGroups/ruleGroups-para-message.adoc[]
|
||||
|
||||
|状态
|
||||
|Status
|
||||
|
|
||||
告警当前的状态。
|
||||
The current status of the alert.
|
||||
|
||||
include::alerts-para-alertingStatus.adoc[]
|
||||
|
||||
|告警级别
|
||||
|Severity
|
||||
|
|
||||
include::../ruleGroups/ruleGroups-para-alertLevel.adoc[]
|
||||
|
||||
|规则名称
|
||||
|告警规则的名称。
|
||||
|Alerting Name
|
||||
|The name of the alert rule.
|
||||
|
||||
|规则组
|
||||
|告警规则组的名称。
|
||||
|Rule Group
|
||||
|The name of the alerting rule group.
|
||||
|
||||
|监控目标
|
||||
|生成告警的监控目标的类型和名称。
|
||||
|Monitored Target
|
||||
|The type and name of the monitored target that generated the alert.
|
||||
|
||||
|触发时间
|
||||
|Trigger Time
|
||||
|
|
||||
include::../ruleGroups/ruleGroups-para-activationTime.adoc[]
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: eb9742b579e948b29be0240b89d9335b
|
||||
* **验证中**：监控指标满足预设的条件，但未满足预设的持续时间。
|
||||
* **Pending**: The monitoring metrics meet the preset conditions but do not meet the preset duration.
|
||||
|
||||
* **已触发**：监控指标满足预设的条件，并且满足预设的持续时间。
|
||||
* **Firing**: The monitoring metrics meet the preset conditions and the preset duration.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: c545dcba1c5d46908a87e91f9fc37f77
|
||||
* 在列表右上角点击**导出**可下载 JSON 格式的资源用量数据。
|
||||
* Click **Export** in the upper right corner of the list to download the resource usage data in JSON format.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 3a85d5dfa0a2462c87c54f9779cfbdc6
|
||||
* 在列表左上角点击image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18]可按升序/降序排序。
|
||||
* Click image:/images/ks-qkcp/zh/icons/sort-ascending.svg[sort-ascending,18,18]/image:/images/ks-qkcp/zh/icons/sort-descending.svg[sort-descending,18,18] in the upper left corner of the list to sort in ascending/descending order.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 09ffce0603e5476d9b35342407c90402
|
||||
本节介绍如何创建自定义监控面板。
|
||||
This section introduces how to create a custom monitoring dashboard.
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 3f3c9d810bbb43449843917a945b0d18
|
||||
本节介绍如何使用自定义监控面板。
|
||||
This section introduces how to use custom monitoring dashboards.
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
// :ks_include_id: ebf1355e06284d8a8c1f0d1c6ae2dcdf
|
||||
本节介绍如何删除自定义监控面板。
|
||||
This section introduces how to delete a custom monitoring dashboard.
|
||||
|
||||
// Warning
|
||||
include::../../../../_ks_components-en/admonitions/warning.adoc[]
|
||||
|
||||
自定义监控面板删除后无法恢复，请谨慎执行此操作。
|
||||
Custom monitoring dashboards cannot be recovered after deletion, so please proceed with caution.
|
||||
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 0a4f15a804bd4a04b35fa4baec7bca69
|
||||
本节介绍如何编辑自定义监控面板。
|
||||
This section introduces how to edit a custom monitoring dashboard.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: fb5da34edef1455388ca60e23308095f
|
||||
. 配置运行在容器中的应用程序，将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。
|
||||
. Configure applications running in containers to expose monitoring metrics that conform to the Prometheus specification at a certain service endpoint. For more information, see the link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus Documentation].
|
||||
|
||||
. 在 KubeSphere Web 控制台，在用于暴露工作负载的服务上设置监控导出器，以声明提供应用程序监控指标的路径。KubeSphere 将根据监控导出器的相关参数获取应用程序的监控指标。
|
||||
. In the {ks_product-en} web console, set up a monitoring exporter on the service exposing the workload to declare the path providing application monitoring metrics. KubeSphere will get the application's monitoring metrics based on the relevant parameters of the monitoring exporter.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 86dce4cf97db45baa0af638a00a5a435
|
||||
KubeSphere 支持通过自定义监控面板对应用程序的运行状态进行监控。您可以通过以下方式使用自定义监控面板：
|
||||
KubeSphere supports monitoring the running status of applications through custom monitoring dashboards. You can use custom monitoring dashboards in the following ways:
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 459d38d3365247858833ed44c54b075d
|
||||
本节介绍如何查看自定义监控面板。
|
||||
This section introduces how to view a custom monitoring dashboard.
|
||||
|
|
@ -1,42 +1,42 @@
|
|||
// :ks_include_id: 5b3a15eedffe4ef39e6a46e6adc2b335
|
||||
. 在**创建自定义监控面板**对话框，设置监控面板的名称、描述和模板，然后点击**下一步**。
|
||||
. In the **Create Custom Monitoring Dashboard** dialog, set the name, description, and template of the monitoring dashboard, then click **Next**.
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|名称
|
||||
|自定义监控面板的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。
|
||||
|Name
|
||||
|The name of the custom monitoring dashboard. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long.
|
||||
|
||||
|描述
|
||||
|自定义监控面板的描述信息。描述可包含任意字符，最长 256 个字符。
|
||||
|Description
|
||||
|The description of the custom monitoring dashboard. The description can contain any characters and can be up to 256 characters long.
|
||||
|
||||
|模板
|
||||
|自定义监控面板的模板。
|
||||
|Template
|
||||
|The template of the custom monitoring dashboard.
|
||||
|
||||
* KubeSphere 提供预置了 Elasticsearch、MySQL、Redis、Jenkins 和 GPU 自定义监控面板的模板。每个模板都提供了一些预置的监控指标和监控图，您可以在模板的基础上进行定制以减少操作。
|
||||
* KubeSphere provides templates with preset custom monitoring dashboards for Elasticsearch, MySQL, Redis, Jenkins, and GPU. Each template provides some preset monitoring metrics and monitoring charts, which you can customize on top of to reduce operations.
|
||||
|
||||
* 如需使用 Grafana 监控面板，您需要上传 Grafana 监控面板配置文件。
|
||||
* To use a Grafana dashboard, you need to upload the Grafana dashboard configuration file.
|
||||
|
||||
* 您也可以使用选择**自定义**使用空模板。
|
||||
* You can also choose **Custom** to use an empty template.
|
||||
|===
|
||||
--
|
||||
|
||||
. 在自定义监控面板编辑页面，根据需要设置监控图和以文本显示的监控指标。
|
||||
. On the custom monitoring dashboard editing page, set the monitoring charts and text-displayed monitoring metrics as needed.
|
||||
+
|
||||
====
|
||||
* 在页面左侧点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]，设置指标参数，然后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18]可创建以文本显示的监控指标。
|
||||
* Click image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18] on the left side of the page, set the metric parameters, then click image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18] to create text-displayed monitoring metrics.
|
||||
+
|
||||
--
|
||||
include::customMonitoringDashboards-para-textMetric.adoc[]
|
||||
--
|
||||
|
||||
* 在页面右下角点击**添加监控项**，选择**折线图**或**柱状图**，设置图表参数，然后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18]可创建监控图。
|
||||
* Click **Add Monitoring Item** in the lower right corner of the page, select **Line Chart** or **Bar Chart**, set the chart parameters, then click image:/images/ks-qkcp/zh/icons/check-dark.svg[check-dark,18,18] to create monitoring charts.
|
||||
+
|
||||
--
|
||||
include::customMonitoringDashboards-para-monitoringChart.adoc[]
|
||||
--
|
||||
====
|
||||
|
||||
. 在页面右上角点击**保存模板**。监控面板创建完成后将显示在自定义监控面板列表中。
|
||||
. Click **Save Template** in the upper right corner of the page. After the monitoring dashboard is created, it will be displayed in the custom monitoring dashboard list.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: 91f54871ad6f447eaca67f6b1853872e
|
||||
. 在需要删除的自定义监控面板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。
|
||||
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the custom monitoring dashboard you want to delete, then select **Delete** from the dropdown list.
|
||||
|
||||
. 在**删除自定义监控面板**对话框，输入自定义监控面板的名称，然后点击**确定**。
|
||||
. In the **Delete Custom Monitoring Dashboard** dialog, enter the name of the custom monitoring dashboard, then click **OK**.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
// :ks_include_id: da77b27e5b9840dab0503615aec625a4
|
||||
. 选择需要删除的自定义监控面板左侧的复选框，然后在自定义监控面板列表上方点击**删除**。
|
||||
. Select the checkbox on the left side of the custom monitoring dashboards you want to delete, then click **Delete** above the custom monitoring dashboard list.
|
||||
|
||||
. 在**批量删除自定义监控面板**对话框，输入自定义监控面板的名称，然后点击**确定**。
|
||||
. In the **Delete Multiple Custom Monitoring Dashboards** dialog, enter the names of the custom monitoring dashboards, then click **OK**.
|
||||
+
|
||||
--
|
||||
include::../../note-separateNamesByComma.adoc[]
|
||||
|
|
|
|||
|
|
@ -1,32 +1,34 @@
|
|||
// :ks_include_id: 1762c0ce44e445d89cd9f2e5b34055fa
|
||||
. 在列表中点击一个自定义监控面板的名称打开自定义监控面板，然后在页面右上角点击**编辑模板**。
|
||||
. Click the name of a custom monitoring dashboard in the list to open the custom monitoring dashboard, then click **Edit Template** in the upper right corner of the page.
|
||||
|
||||
. 在页面左侧设置以文本显示的监控指标。
|
||||
. Set the text-displayed monitoring metrics on the left side of the page.
|
||||
+
|
||||
====
|
||||
* 点击image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18]可添加监控指标。
|
||||
* Click image:/images/ks-qkcp/zh/icons/add-dark.svg[add-dark,18,18] to add monitoring metrics.
|
||||
+
|
||||
--
|
||||
include::customMonitoringDashboards-para-textMetric.adoc[]
|
||||
--
|
||||
|
||||
* 将光标悬停在监控指标上，然后点击image:/images/ks-qkcp/zh/icons/trash-dark.svg[trash-dark,18,18]可删除监控指标。
|
||||
* Hover the cursor over a monitoring metric, then click image:/images/ks-qkcp/zh/icons/trash-dark.svg[trash-dark,18,18] to delete the monitoring metric.
|
||||
|
||||
* 将光标悬停在监控指标上，然后点击image:/images/ks-qkcp/zh/icons/pen-dark.svg[pen-dark,18,18]可编辑监控指标。
|
||||
* Hover the cursor over a monitoring metric, then click image:/images/ks-qkcp/zh/icons/pen-dark.svg[pen-dark,18,18] to edit the monitoring metric.
|
||||
====
|
||||
|
||||
. 在页面右侧的监控图列表设置监控图。
|
||||
. Set the monitoring charts in the monitoring chart list on the right side of the page.
|
||||
+
|
||||
====
|
||||
* 点击**添加监控项**可添加监控图。
|
||||
* Click **Add Monitoring Item** to add monitoring charts.
|
||||
+
|
||||
--
|
||||
include::customMonitoringDashboards-para-monitoringChart.adoc[]
|
||||
--
|
||||
|
||||
* 将光标悬停在监控图名称上，然后点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除监控图。
|
||||
* Hover the cursor over the monitoring chart name, then click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] to delete the monitoring chart.
|
||||
|
||||
* 将光标悬停在监控图名称上，然后点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen-light,18,18]可编辑监控图。
|
||||
* Hover the cursor over the monitoring chart name, then click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen-light,18,18] to edit the monitoring chart.
|
||||
|
||||
* Drag image:/images/ks-qkcp/zh/icons/drag-handle.svg[drag-handle,18,18] on the right side to adjust the sorting of the monitoring charts.
|
||||
====
|
||||
|
||||
. 在页面右上角点击**保存模板**完成编辑。
|
||||
. Click **Save Template** in the upper right corner of the page to complete the editing.
|
||||
|
|
@ -1,17 +1,17 @@
|
|||
// :ks_include_id: f41b68cc492640acadc07b371d665ebb
|
||||
. 在需要操作的自定义监控面板右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。
|
||||
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the custom monitoring dashboard you want to edit, then select **Edit Information** from the dropdown list.
|
||||
|
||||
. 在**编辑信息**对话框，设置自定义监控面板的别名和描述，然后点击**确定**。
|
||||
. In the **Edit Information** dialog, set the alias and description of the custom monitoring dashboard, then click **OK**.
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|别名
|
||||
|自定义监控面板的别名。不同自定义监控面板的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。
|
||||
|Alias
|
||||
|The alias of the custom monitoring dashboard. Different custom monitoring dashboards can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), with a maximum of 63 characters.
|
||||
|
||||
|描述
|
||||
|自定义监控面板的描述信息。描述可包含任意字符，最多包含 256 个字符。
|
||||
|Description
|
||||
|The description of the custom monitoring dashboard. The description can contain any characters, with a maximum of 256 characters.
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: b79841529a1d49a19e7e17eac5decf19
|
||||
. 在 KubeSphere Web 控制台，使用监控指标创建自定义监控面板，从而对应用程序的运行状况进行监控。
|
||||
. In the {ks_product-en} web console, create custom monitoring dashboards using monitoring metrics to monitor the running status of applications.
|
||||
|
|
@ -1,18 +1,18 @@
|
|||
// :ks_include_id: d52d25b1598e4adb94ab8b79c98a1e00
|
||||
. 在列表中点击一个自定义监控面板的名称打开监控面板。
|
||||
. Click the name of a custom monitoring dashboard in the list to open the dashboard.
|
||||
+
|
||||
--
|
||||
* 在页面左侧区域可查看以文本显示的监控指标。
|
||||
* View text-displayed monitoring metrics in the left area of the page.
|
||||
|
||||
* 在页面中间区域可查看监控指标折线图或柱状图。
|
||||
* View line charts or bar charts of monitoring metrics in the middle area of the page.
|
||||
|
||||
* 在页面右侧点击image:/images/ks-qkcp/zh/icons/chevron-right.svg[chevron-right,18,18]可查看每个监控指标的子指标及其在指定时间范围内的最大值、最小值、平均值和最后采样值。
|
||||
* Click image:/images/ks-qkcp/zh/icons/chevron-right.svg[chevron-right,18,18] on the right side of the page to view sub-metrics of each monitoring metric and their maximum, minimum, average, and last sampled values within the specified time range.
|
||||
|
||||
* 在页面上方点击image:/images/ks-qkcp/zh/icons/theme.svg[theme,18,18]可切换浅色和深色主题。
|
||||
* Click image:/images/ks-qkcp/zh/icons/theme.svg[theme,18,18] at the top of the page to switch between light and dark themes.
|
||||
|
||||
* 在页面上方点击image:/images/ks-qkcp/zh/icons/calendar-dark.svg[calendar-dark,18,18]可设置数据的时间范围。
|
||||
* Click image:/images/ks-qkcp/zh/icons/calendar-dark.svg[calendar-dark,18,18] at the top of the page to set the time range of the data.
|
||||
|
||||
* 在页面上方点击image:/images/ks-qkcp/zh/icons/refresh-dark.svg[refresh-dark,18,18]可设置数据的刷新间隔。
|
||||
* Click image:/images/ks-qkcp/zh/icons/refresh-dark.svg[refresh-dark,18,18] at the top of the page to set the refresh interval of the data.
|
||||
|
||||
* 在页面右上角点击image:/images/ks-qkcp/zh/icons/close-dark.svg[close,18,18]可返回自定义监控面板列表。
|
||||
--
|
||||
* Click image:/images/ks-qkcp/zh/icons/close-dark.svg[close,18,18] in the upper right corner of the page to return to the custom monitoring dashboard list.
|
||||
--
|
||||
|
|
@ -1,30 +1,30 @@
|
|||
// :ks_include_id: 02c275a851594f868957a3c32ff9f5cd
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|图例类型
|
||||
|监控图的纵向数据展示方式，可选类型包括**基础图**和**堆叠图**。
|
||||
|Graph Types
|
||||
|The vertical data display method of the monitoring chart, with options including **Basic Chart** and **Stacked Chart**.
|
||||
|
||||
|图表配色
|
||||
|监控图的配色风格，可选类型包括**默认配色**、**冷色调**和**暖色调**。
|
||||
|Chart Colors
|
||||
|The color scheme of the monitoring chart, with options including **Default Colors**, **Cool Colors**, and **Warm Colors**.
|
||||
|
||||
|基本信息
|
||||
|用户自定义的监控图名称和描述信息。
|
||||
|Basic Information
|
||||
|User-defined name and description for the monitoring chart.
|
||||
|
||||
|数据
|
||||
|监控图中显示的监控指标。
|
||||
|Data
|
||||
|The monitoring metrics displayed in the monitoring chart.
|
||||
|
||||
* **图例名称**：用户自定义的监控指标名称。
|
||||
* **Metric Name**: User-defined name for the monitoring metric.
|
||||
|
||||
* **间隔**：监控图中数据的时间间隔，取值为 <数值><单位>，例如 **1m** 表示数据时间间隔为 1 分钟。
|
||||
* **Interval**: The time interval of the data in the monitoring chart, with a value of <number><unit>, for example, **1m** means the data time interval is 1 minute.
|
||||
|
||||
* **监控指标**：应用程序暴露的监控指标。您可以点击**监控指标**然后在下拉列表中选择监控指标，也可以手动输入 PromQL 语句。请确保您已配置应用程序暴露监控指标，并已配置监控导出器。有关 PromQL 表达式的更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。
|
||||
* **Monitoring Metric**: The monitoring metrics exposed by the application. You can click **Monitoring Metric** and then select a monitoring metric from the dropdown list, or manually enter a PromQL statement. Ensure that you have configured the application to expose monitoring metrics and have set up the monitoring exporter. For more information about PromQL expressions, see the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus Documentation].
|
||||
|
||||
|Y 轴
|
||||
|监控图的纵坐标轴设置。
|
||||
|Y Axis
|
||||
|Settings for the vertical axis of the monitoring chart.
|
||||
|
||||
* **单位**：纵坐标轴的数据单位。
|
||||
* **Unit**: The unit of the data on the vertical axis.
|
||||
|
||||
* **精确位**：纵坐标轴数据的有效小数位数。
|
||||
* **Decimal Places**: The number of significant decimal places in the data on the vertical axis.
|
||||
|===
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 5ed9a5c35fa945bc84988f238d7ab69a
|
||||
应用程序暴露的监控指标。您可以点击**监控指标**然后在下拉列表中选择监控指标，也可以手动输入 PromQL 语句。请确保您已配置应用程序暴露监控指标，并已配置监控导出器。有关 PromQL 表达式的更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。
|
||||
The monitoring metrics exposed by the application. You can click **Monitoring Metric** and then select a monitoring metric from the dropdown list, or manually enter a PromQL statement. Ensure that you have configured the application to expose monitoring metrics and have set up the monitoring exporter. For more information about PromQL expressions, see the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus Documentation].
|
||||
|
|
@ -1,18 +1,18 @@
|
|||
// :ks_include_id: 6d474f2ff06e43c7bc9003aaa10e29c2
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|图表名称
|
||||
|监控指标的名称。
|
||||
|Chart Name
|
||||
|The name of the monitoring metric.
|
||||
|
||||
|单位
|
||||
|指标数据的单位。
|
||||
|Unit
|
||||
|The unit of the metric data.
|
||||
|
||||
|精确位
|
||||
|指标数据的有效小数位数。
|
||||
|Decimal Places
|
||||
|The number of significant decimal places in the metric data.
|
||||
|
||||
|监控指标
|
||||
|Monitoring Metric
|
||||
|
|
||||
include::customMonitoringDashboards-para-monitoringMetric.adoc[]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 385623699d0d48bda614b5a8de5c062d
|
||||
* 您需要配置运行在容器中的应用程序将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。
|
||||
* Configure applications running in containers to expose monitoring metrics that conform to the Prometheus specification at a certain service endpoint. For more information, see the link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus Documentation].
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
The IP address of the cluster gateway or project gateway.
|
||||
|
||||
// tag::bullets[]
|
||||
* If the external access mode of the gateway is NodePort, the **Gateway Address** is the IP address of one of the cluster nodes. Clients can access the backend services of the Ingresses through the IP address and port of any cluster node.
|
||||
* If the external access mode of the gateway is **NodePort**, the **Gateway Address** is the IP address of one of the cluster nodes. Clients can access the backend services of the Ingresses through the IP address and port of any cluster node.
|
||||
|
||||
* If the external access mode of the gateway is LoadBalancer, the **Gateway Address** is the address of the load balancer.
|
||||
* If the external access mode of the gateway is **LoadBalancer**, the **Gateway Address** is the address of the load balancer.
|
||||
|
||||
// end::bullets[]
|
||||
|
|
@ -1,15 +1,15 @@
|
|||
// :ks_include_id: 66ed1f4913ff42b5b26a407b2ce28c78
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|服务地址
|
||||
|Address
|
||||
|
|
||||
include::logReceivers-para-address.adoc[]
|
||||
|
||||
|索引前缀
|
||||
|日志数据的索引前缀，用于区分不同类型的日志。仅对 Elasticsearch 和 OpenSearch 可用。
|
||||
|Index Prefix
|
||||
|The index prefix of log data, used to distinguish different types of logs. Only available for Elasticsearch and OpenSearch.
|
||||
|
||||
|主题
|
||||
|日志数据的主题，用于区分不同类型的日志。仅对 Kafka 可用。
|
||||
|Topic
|
||||
|The topic of log data, used to distinguish different types of logs. Only available for Kafka.
|
||||
|===
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 52e9e8100b4444ebb9fbb42175d917f3
|
||||
日志接收器的服务地址和服务端口。{ks_product-en}会将日志发送给该地址和端口。{ks_product-en}默认使用的 OpenSearch 的服务地址和服务端口为 **opensearch-cluster-data.kubesphere-logging-system.svc:9200**。
|
||||
The service address and port of the log receiver. {ks_product-en} will send logs to this address and port. The default service address and port of OpenSearch used by {ks_product-en} is **opensearch-cluster-data.kubesphere-logging-system.svc:9200**.
|
||||
|
|
@ -1,35 +1,35 @@
|
|||
// :ks_include_id: 9b12ede280884331985685925cf5dfc4
|
||||
* 容器组列表提供以下信息：
|
||||
* The pod list provides the following information:
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|名称
|
||||
|容器组的名称。
|
||||
|Name
|
||||
|The name of the pod.
|
||||
|
||||
|状态
|
||||
|容器组的状态。
|
||||
|Status
|
||||
|The status of the pod.
|
||||
|
||||
include::pods-para-podStatus_overview.adoc[]
|
||||
// pod 状态不一样
|
||||
// pod status is different
|
||||
|
||||
|节点
|
||||
|容器组所在的节点和节点的 IP 地址。
|
||||
|Node
|
||||
|The node where the pod is located and the node's IP address.
|
||||
|
||||
include::pods-para-podIpPool.adoc[]
|
||||
|
||||
// |应用
|
||||
// |容器组所属的应用。
|
||||
// |Application
|
||||
// |The application the pod belongs to.
|
||||
|
||||
|项目
|
||||
|容器组所属的项目。
|
||||
|Project
|
||||
|The project the pod belongs to.
|
||||
|
||||
|集群
|
||||
|容器组所属的集群。
|
||||
|Cluster
|
||||
|The cluster the pod belongs to.
|
||||
|
||||
|更新时间
|
||||
|容器组的更新时间。
|
||||
|Update Time
|
||||
|The update time of the pod.
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,13 +1,11 @@
|
|||
// :ks_include_id: 8cc83a9c58b8460cbcf369b1a07288b1
|
||||
|
||||
* **运行中**：容器组已分配给某个节点，容器组中的所有容器都已被创建，至少有一个容器正在运行、启动或重启。
|
||||
* **Running**: The pod has been assigned to a node, all containers in the pod have been created, and at least one container is running, starting, or restarting.
|
||||
|
||||
* **等待中**：容组器已被系统接受，但有至少一个容器尚未创建也未运行。此状态下，容器组可能正在等待调度，或等待容器镜像下载完成。
|
||||
* **Pending**: The pod has been accepted by the system, but at least one container has not been created or is not running. This state may indicate that the pod is waiting for scheduling or for the container image to be downloaded.
|
||||
|
||||
* **成功完成**：容器组中的所有容器都成功终止（以 0 退出码终止），并且不再重启。
|
||||
* **Completed**: All containers in the pod have terminated successfully (with an exit code of 0) and will not be restarted.
|
||||
|
||||
* **失败**：容器组中的所有容器都已终止，并且至少有一个容器以非 0 退出码终止。
|
||||
* **Failed**: All containers in the pod have terminated, and at least one container has terminated with a non-zero exit code.
|
||||
|
||||
* **未知**：系统无法获取容器组状态。出现这种状态通常是由于系统与容器组所在的主机通信失败。
|
||||
|
||||
// 已完成 vs 成功完成：https://github.com/kubesphere/project/issues/3983#issuecomment-2246982909
|
||||
* **Unknown**: The system is unable to get the status of the pod. This state usually occurs when the system fails to communicate with the host where the pod is located.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: e19cfac61c85491d9f631ba61f012c62
|
||||
本节介绍如何创建告警规则组。
|
||||
This section introduces how to create an alert rule group.
|
||||
|
||||
{ks_product-en}的监控告警功能底层基于 Promtheus 实现，每个规则组可包含多条告警规则。您可以使用系统提供的规则模板创建告警规则，也可手动输入 PromQL 表达式创建告警规则。有关更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。
|
||||
The monitoring and alerting functions of {ks_product-en} are implemented based on Prometheus. Each rule group can contain multiple alert rules. You can create alert rules using the rule templates provided by the system or manually enter PromQL expressions to create alert rules. For more information, see the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus Documentation].
|
||||
|
|
@ -1,16 +1,16 @@
|
|||
// :ks_include_id: afa42dbe50664f968d66928b7d9b75d6
|
||||
本节介绍如何删除告警规则组。
|
||||
This section describes how to delete alert rule groups.
|
||||
|
||||
// Note
|
||||
include::../../../../_ks_components-en/admonitions/note.adoc[]
|
||||
|
||||
{ks_product-en}仅支持删除自定义规则组，不支持删除内置规则组。
|
||||
{ks_product-en} only supports deleting custom rule groups, not built-in rule groups.
|
||||
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
|
||||
// Warning
|
||||
include::../../../../_ks_components-en/admonitions/warning.adoc[]
|
||||
|
||||
规则组删除后不能恢复，请谨慎执行此操作。
|
||||
Rule groups cannot be recovered after deletion, so please proceed with caution.
|
||||
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 43829ece490644d8ba2c2e823ad90719
|
||||
本节介绍如何启用和禁用告警规则组。规则组禁用后，系统将不再根据规则组生成告警。
|
||||
This section describes how to enable and disable alerting rule groups. After a rule group is disabled, the system will no longer generate alerts based on the rule group.
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
// :ks_include_id: 50920b439c7f4f4e996fecec215f24ed
|
||||
本节介绍如何编辑规则组中的告警规则。
|
||||
This section describes how to edit alert rules in a rule group.
|
||||
|
||||
// Note
|
||||
include::../../../../_ks_components-en/admonitions/note.adoc[]
|
||||
|
||||
{ks_product-en}仅支持编辑自定义规则组，不支持编辑内置规则组。
|
||||
{ks_product-en} only supports editing custom rule groups, not built-in rule groups.
|
||||
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: d62dbb9307bf4f21a25a732737dbe531
|
||||
本节介绍如何编辑告警规则组信息。
|
||||
This section introduces how to edit the information of an alert rule group.
|
||||
|
||||
您可以编辑告警规则组的别名、检查周期和描述。{ks_product-en}不支持编辑规则组的名称。
|
||||
You can edit the alias, check interval, and description of the alert rule group. KubeSphere does not support editing the name of a rule group.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 60f5fd04585b4a97bb5c99721f03edcb
|
||||
本节介绍如何查看告警规则组详情。
|
||||
This section introduces how to view the details of an alert rule group.
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 75e22548eee741e48e1bcf6c7499fc65
|
||||
本节介绍如何查看告警规则组列表。
|
||||
This section introduces how to view the alert rule group list.
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: b8f6aaa1104a42b3a0856ce1f21e1cea
|
||||
. 在**告警规则**页签，点击**添加告警规则**，根据需要选择**规则模板**或**自定义规则**设置告警规则。
|
||||
. On the **Alert Rules** tab, click **Add Alert Rule** and select **Rule Template** or **Custom Rule** as needed to set the alert rule.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 1f7f6ffdb0cb446689a451e85ddf8d11
|
||||
. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑信息**。
|
||||
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to edit, and then select **Edit Information** from the dropdown list.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
// :ks_include_id: 513da96dc1b64eb9af9a791f349a9fce
|
||||
. 完成告警规则设置后点击image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18]保存设置，然后点击**创建**。
|
||||
. After completing the alert rule settings, click image:/images/ks-qkcp/zh/icons/check-dark.svg[check,18,18] to save the settings, then click **Create**.
|
||||
+
|
||||
--
|
||||
规则组创建完成后将显示在规则组列表中。
|
||||
--
|
||||
The rule group will be displayed in the rule group list after creation.
|
||||
--
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: 0b6f7a63668142ce8f5d70a7f013a852
|
||||
. 在需要删除的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**删除**。
|
||||
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to delete, and then select **Delete** from the dropdown list.
|
||||
|
||||
. 在**删除规则组**对话框，输入规则组的名称，然后点击**确定**。
|
||||
. In the **Delete Rule Group** dialog, enter the name of the rule group, and then click **OK**.
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
// :ks_include_id: c98f892c063d4948889dcb04d2bef599
|
||||
. 勾选需要删除的规则组左侧的复选框，然后在规则组列表上方点击**删除**。
|
||||
. Select the checkbox on the left side of the rule groups you need to delete, and then click **Delete** above the rule group list.
|
||||
|
||||
. 在**批量删除规则组**对话框，输入规则组的名称，然后点击**确定**。
|
||||
. In the **Delete Multiple Rule Groups** dialog, enter the names of the rule groups, and then click **OK**.
|
||||
+
|
||||
--
|
||||
include::../../note-separateNamesByComma.adoc[]
|
||||
--
|
||||
--
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
// :ks_include_id: 8e195bed54da4a4d8f7337f34ddec2ec
|
||||
. 在需要禁用的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**禁用**。
|
||||
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to disable, and then select **Disable** from the dropdown list.
|
||||
|
||||
. 在**禁用规则组**对话框，输入规则组的名称，然后点击**确定**。
|
||||
. In the **Disable Rule Group** dialog, enter the name of the rule group, and then click **OK**.
|
||||
|
||||
. 在已禁用的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**启用**可启用规则组。
|
||||
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the disabled rule group, and then select **Enable** from the dropdown list to enable the rule group.
|
||||
|
|
@ -1,10 +1,10 @@
|
|||
// :ks_include_id: 76fde78ac7ba4fef9a7a125fa849713d
|
||||
. 勾选需要禁用的规则组左侧的复选框，然后在规则组列表上方点击**禁用**。
|
||||
. Select the checkbox on the left side of the rule groups you need to disable, and then click **Disable** above the rule group list.
|
||||
|
||||
. 在**批量禁用规则组**对话框，输入规则组的名称，然后点击**确定**。
|
||||
. In the **Disable Multiple Rule Groups** dialog, enter the names of the rule groups, and then click **OK**.
|
||||
+
|
||||
--
|
||||
include::../../note-separateNamesByComma.adoc[]
|
||||
--
|
||||
|
||||
. 勾选已禁用的规则组左侧的复选框，然后在规则组列表上方点击**启用**可批量启用规则组。
|
||||
. Select the checkbox on the left side of the disabled rule groups, and then click **Enable** above the rule group list to batch enable the rule groups.
|
||||
|
|
@ -1,12 +1,12 @@
|
|||
// :ks_include_id: af3bb03cf3e148bfa42409178889df61
|
||||
. 在**编辑告警规则**对话框，编辑已有的告警规则或创建新告警规则，然后点击**确定**。
|
||||
. In the **Edit Alert Rules** dialog, edit existing alert rules or create new alert rules, and then click **OK**.
|
||||
+
|
||||
--
|
||||
* 将光标悬停在已有的告警规则上，点击切换开关可启用/禁用告警规则。
|
||||
* Hover over an existing alert rule and click the toggle switch to enable/disable the alert rule.
|
||||
|
||||
* 将光标悬停在已有的告警规则上，点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除告警规则。
|
||||
* Hover over an existing alert rule and click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] to delete the alert rule.
|
||||
|
||||
* 将光标悬停在已有的告警规则上，点击image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18]可修改告警规则的设置。
|
||||
* Hover over an existing alert rule and click image:/images/ks-qkcp/zh/icons/pen-light.svg[pen,18,18] to modify the settings of the alert rule.
|
||||
|
||||
* 点击**添加告警规则**可创建新告警规则。
|
||||
--
|
||||
* Click **Add Alert Rule** to create a new alert rule.
|
||||
--
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 3f022ef6620a4e01a4946d45ee3e93ce
|
||||
. 在需要编辑的规则组右侧点击image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑告警规则**。
|
||||
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] on the right side of the rule group you need to edit, and then select **Edit Alert Rules** from the dropdown list.
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
// :ks_include_id: 33d094f3069e40519db31aec587457b4
|
||||
. 在**编辑信息**对话框，设置规则组的基本信息，然后点击**确定**。
|
||||
. In the **Edit Information** dialog, set the basic information for the rule group, and then click **OK**.
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
include::ruleGroups-para-aliasCheckIntervalDescription.adoc[]
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 8ada03e949d64141806728273792c325
|
||||
. 在**规则组**页面，点击**自定义规则组**或**内置规则组**，然后在列表中点击一个规则组的名称打开其详情页面。
|
||||
. On the **Rule Groups** page, click **Custom Rule Groups** or **Built-in Rule Groups**, then click the name of a rule group in the list to open its details page.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 6b961b60bdf64acab9b19b9c28b5fb3e
|
||||
. 在**规则组**页面，点击**自定义规则组**或**内置规则组**打开规则组列表。
|
||||
. On the **Rule Groups** page, click **Custom Rule Groups** or **Built-in Rule Groups** to open the rule group list.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: d6ed4db86bde40cbaa6d3dbebecda452
|
||||
* 在列表上方点击搜索框并输入关键字，可搜索名称包含特定关键字的规则组。
|
||||
* Click the search box at the top of the list to search for rule groups by name.
|
||||
|
|
@ -1,16 +1,16 @@
|
|||
// :ks_include_id: 0909f39a50384c55b38d52472ab4085e
|
||||
. 在**基本信息**页签，设置规则组的基本信息，然后点击**下一步**。
|
||||
. On the **Basic Information** tab, set the basic information of the rule group, then click **Next**.
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|名称
|
||||
|规则组的名称。
|
||||
|Name
|
||||
|The name of the rule group.
|
||||
|
||||
名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。
|
||||
The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long.
|
||||
|
||||
include::ruleGroups-para-aliasCheckIntervalDescription.adoc[]
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,56 +1,56 @@
|
|||
// :ks_include_id: 539c72cb8f884103bce5d979f3b31d09
|
||||
. 在规则组详情页面左侧的**属性**区域查看规则组的资源属性。
|
||||
. View the resource attributes of the rule group in the **Attributes** area on the left side of the details page.
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
include::ruleGroups-para-ruleGroupStatus.adoc[]
|
||||
|
||||
|检查间隔
|
||||
|指标检查之间的时间间隔。
|
||||
|Check Interval
|
||||
|The time interval between metric checks.
|
||||
|
||||
include::ruleGroups-para-timeSpent.adoc[]
|
||||
|
||||
|创建时间
|
||||
|规则组的创建时间。
|
||||
|Creation Time
|
||||
|The creation time of the rule group.
|
||||
|
||||
|创建者
|
||||
|规则组的创建者。
|
||||
|Creator
|
||||
|The creator of the rule group.
|
||||
|===
|
||||
--
|
||||
|
||||
. 在规则组详情页面右侧的**告警规则**页签查看规则组中设置的告警规则。
|
||||
. View the alert rules set in the rule group in the **Alert Rules** tab on the right side of the rule group details page.
|
||||
+
|
||||
--
|
||||
**告警规则**页签显示告警规则的名称、告警级别、触发状态、监控目标和最近检查时间。
|
||||
The **Alert Rules** tab displays the name, severity, trigger status, monitoring target, and last check time of the alert rules.
|
||||
|
||||
* 在告警规则名称右侧点击image:/images/ks-qkcp/zh/icons/monitor.svg[monitor,18,18]可查看监控指标数据。
|
||||
* Click image:/images/ks-qkcp/zh/icons/monitor.svg[monitor,18,18] on the right side of the alert rule name to view the metric data.
|
||||
|
||||
* 在告警规则右侧点击image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18]可查看告警规则的触发条件、PromSQL 表达式和告警消息内容。
|
||||
* Click image:/images/ks-qkcp/zh/icons/chevron-down.svg["chevron-down",18,18] on the right side of the alert rule to view the trigger condition, PromSQL expression, and alert message content of the alert rule.
|
||||
--
|
||||
|
||||
. 在规则组详情页面右侧点击**告警**页签查看当前生成的告警。
|
||||
. Click the **Alerts** tab on the right side of the details page to view the currently generated alerts.
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|消息
|
||||
|Message
|
||||
|
|
||||
include::ruleGroups-para-message.adoc[]
|
||||
|
||||
|告警级别
|
||||
|Severity
|
||||
|
|
||||
include::ruleGroups-para-alertLevel.adoc[]
|
||||
|
||||
|监控目标
|
||||
|规则组的监控目标。
|
||||
|Monitoring Target
|
||||
|The monitoring target of the rule group.
|
||||
|
||||
|触发时间
|
||||
|Trigger Time
|
||||
|
|
||||
include::ruleGroups-para-activationTime.adoc[]
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: c3b29bad32424d7abc3be2e77357df17
|
||||
规则组由**未触发**状态变为**验证中**状态的时间。
|
||||
The time when the rule group changed from the **Inactive** state to the **Pending** state.
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 63afbb864bc3418ca45d632bcda4ba1d
|
||||
告警的级别，包括**提醒、警告、重要、紧急**。
|
||||
The level of the alert, including **Info, Warning, Error, Critical**.
|
||||
|
|
@ -1,18 +1,18 @@
|
|||
// :ks_include_id: 9e29dba51eed467195d8b4402adcee08
|
||||
* 规则组列表提供以下信息：
|
||||
* The rule group list provides the following information:
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|名称
|
||||
|规则组的名称。
|
||||
|Name
|
||||
|The name of the rule group.
|
||||
|
||||
include::ruleGroups-para-ruleGroupStatus.adoc[]
|
||||
|
||||
|规则状态
|
||||
|规则组中包含的告警规则的状态。
|
||||
|Rule Status
|
||||
|The status of the alert rules contained in the rule group.
|
||||
|
||||
include::ruleGroups-para-alertingStatusInactive.adoc[]
|
||||
|
||||
|
|
@ -22,10 +22,10 @@ include::ruleGroups-para-alertingStatusDisabled.adoc[]
|
|||
|
||||
include::ruleGroups-para-timeSpent.adoc[]
|
||||
|
||||
// |集群
|
||||
// |使用该规则组进行资源监控的集群。
|
||||
// |Cluster
|
||||
// |The cluster using this rule group for resource monitoring.
|
||||
|
||||
|最近检查
|
||||
|最近一次指标检查的执行时间。
|
||||
|Last Check
|
||||
|The execution time of the most recent metric check.
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,18 +1,18 @@
|
|||
// :ks_include_id: 9e29dba51eed467195d8b4402adcee08
|
||||
* 规则组列表提供以下信息：
|
||||
* The rule group list provides the following information:
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|名称
|
||||
|规则组的名称。
|
||||
|Name
|
||||
|The name of the rule group.
|
||||
|
||||
include::ruleGroups-para-ruleGroupStatus.adoc[]
|
||||
|
||||
|规则状态
|
||||
|规则组中包含的告警规则的状态。
|
||||
|Rule Status
|
||||
|The status of the alert rules contained in the rule group.
|
||||
|
||||
include::ruleGroups-para-alertingStatusInactive.adoc[]
|
||||
|
||||
|
|
@ -22,10 +22,10 @@ include::ruleGroups-para-alertingStatusDisabled.adoc[]
|
|||
|
||||
// include::ruleGroups-para-timeSpent.adoc[]
|
||||
|
||||
|集群
|
||||
|使用该规则组进行资源监控的集群。
|
||||
|Cluster
|
||||
|The clusters using this rule group for resource monitoring.
|
||||
|
||||
|最近检查
|
||||
|最近一次指标检查的执行时间。
|
||||
|Last Check
|
||||
|The execution time of the most recent metric check.
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: a88a0cc5a6db44ab923dd629c50bafd4
|
||||
* **已禁用**：告警规则已被禁用。
|
||||
* **Disabled**: The alert rule has been disabled.
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 6bf2b0acd7e043fc8ef1328d3b45bec3
|
||||
* **未触发**：监控指标未满足预设的条件。此状态下系统不生成告警。
|
||||
* **Inactive**: The monitoring metrics do not meet the preset conditions. No alerts are generated in this state.
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
// :ks_include_id: 154069b262b94648a55d983b0875f8c6
|
||||
|别名
|
||||
|规则组的别名。不同规则组的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。
|
||||
|Alias
|
||||
|The alias of the rule group. Different rule groups can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), and cannot start or end with a hyphen (-), with a maximum of 63 characters.
|
||||
|
||||
|检查间隔
|
||||
|指标检查之间的时间间隔。默认值为 1 分钟。
|
||||
|Check Interval
|
||||
|The time interval between metric checks. The default value is 1 minute.
|
||||
|
||||
|描述
|
||||
|规则组的描述信息。
|
||||
|Description
|
||||
|The description of the rule group.
|
||||
|
||||
描述可包含任意字符，最长 256 个字符。
|
||||
The description can contain any characters, with a maximum of 256 characters.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 5f7a598e105f43558afe250665ee56d2
|
||||
告警消息的概要和详情。如果未设置消息的详情，**消息**列将显示告警规则组的概要。
|
||||
The summary and details of the alert message. If the details of the message are not set, the **Message** column will display the summary of the rule group.
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
// :ks_include_id: d4684807ee1d4a93ac734c072d1ce511
|
||||
|规则组状态
|
||||
|规则组当前是否已启用。
|
||||
|Rule Group Status
|
||||
|Whether the rule group is currently enabled.
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
// :ks_include_id: 83be107bbcde41f7a4e73bae25c1e923
|
||||
|耗时
|
||||
|最近一次指标检查所花费的时间。
|
||||
|Time Spent
|
||||
|The time spent on the most recent metric check.
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: 6aade36eb695477ab6e8a0eda652c52e
|
||||
本节介绍如何编辑监控导出器。
|
||||
This section introduces how to edit a metrics exporter.
|
||||
|
||||
监控导出器用于对应用程序进行监控。{ks_product-en}平台的监控告警功能底层通过 Prometheus 实现。为监控应用程序的运行状况，您需要进行以下操作：
|
||||
A metrics exporter is used to monitor applications. The monitoring and alerting functions of KubeSphere are implemented through Prometheus at the bottom layer. To monitor the running status of applications, you need to perform the following operations:
|
||||
|
|
@ -1,47 +1,48 @@
|
|||
// :ks_include_id: f0e2bbaddcbd4d3db4ce4f3625f57ca1
|
||||
. 在服务详情页面左上角选择**更多操作 > 编辑监控导出器**。
|
||||
. Select **More > Edit Metrics Exporter** in the upper left corner of the service details page.
|
||||
|
||||
. 在**编辑监控导出器**页面，设置监控指标的收集路径、收集间隔和超时时间，然后点击**确定**。
|
||||
. On the **Edit Metrics Exporter** page, set the collection path, collection interval, and timeout for the monitoring metrics, then click **OK**.
|
||||
+
|
||||
--
|
||||
{ks_product-en}的监控告警模块将根据此处设置的参数访问服务并收集应用程序的监控指标。
|
||||
The monitoring and alerting module of KubeSphere will access the service and collect the application's monitoring metrics based on the parameters set here.
|
||||
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|协议
|
||||
|用于通信的协议，取值可以为 **HTTP** 或 **HTTPS**。
|
||||
|Protocol
|
||||
|The protocol used for communication, which can be **HTTP** or **HTTPS**.
|
||||
|
||||
|端口
|
||||
|用于通信的服务端口。
|
||||
|Port
|
||||
|The service port used for communication.
|
||||
|
||||
|路径
|
||||
|暴露应用程序监控指标的路径。
|
||||
|Path
|
||||
|The path exposing the application's monitoring metrics.
|
||||
|
||||
|认证方式
|
||||
|收集应用程序监控指标过程的通信认证方式。
|
||||
|Authentication Method
|
||||
|The communication authentication method for the process of collecting application monitoring metrics.
|
||||
|
||||
* **无需认证**：不采用任何认证手段。此方式可能存在信息安全隐患。
|
||||
* **No Authentication**: No authentication method is used. This method may have information security risks.
|
||||
|
||||
* **TLS**：收集应用程序监控指标的过程通过 TLS 协议进程认证。
|
||||
* **TLS**: The process of collecting application monitoring metrics is authenticated through the TLS protocol.
|
||||
|
||||
* **Bear 令牌**：通过令牌进行认证。
|
||||
* **Bearer Token**: Authentication is performed through a token.
|
||||
|
||||
* **基础认证**：通过用户名和密码认证。
|
||||
* **Basic Authentication**: Authentication is performed through a username and password.
|
||||
|
||||
除**无需认证**外，其他认证方式都需要在应用程序中配置对应的认证逻辑，并提前创建包含认证信息的保密字典。
|
||||
Except for **No Authentication**, other authentication methods require corresponding authentication logic to be configured in the application and a Secret containing the authentication information to be created in advance.
|
||||
|
||||
|收集间隔
|
||||
|应用程序监控指标的收集间隔，单位为分钟。
|
||||
|Collection Interval
|
||||
|The collection interval for application monitoring metrics, in minutes.
|
||||
|
||||
|超时时间
|
||||
|每次收集应用程序监控指标的超时时间，单位为秒。
|
||||
|Timeout
|
||||
|The timeout for each collection of application monitoring metrics, in seconds.
|
||||
|===
|
||||
--
|
||||
|
||||
// Note
|
||||
include::../../../../_ks_components-en/admonitions/note.adoc[]
|
||||
|
||||
监控导出器创建完成后，您还需要在{ks_product-en} Web 控制台使用监控指标进一步创建规则组或自定义监控面板，以对应用程序的运行状态进行监控。
|
||||
After the metrics exporter is created, you also need to use the monitoring metrics to further create rule groups or custom monitoring dashboards in the {ks_product-en} web console to monitor the running status of the application.
|
||||
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
include::../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 9014ea6811834538b9c5b7fe24097a91
|
||||
. 在{ks_product-en} Web 控制台，使用监控指标创建规则组或自定义监控面板，从而对应用程序的运行状况进行监控。
|
||||
. In the {ks_product-en} web console, create rule groups or custom monitoring dashboards using monitoring metrics to monitor the running status of applications.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: f845b7136ccc47a59ea94257751c74cc
|
||||
* 您需要配置目标应用程序将符合 Prometheus 规范的监控指标暴露在某个服务端路径下。有关更多信息，请参阅 link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus 官方文档]。
|
||||
* You should configure the application to expose monitoring metrics that conform to the Prometheus specification at a certain service endpoint. For more information, see the link:https://prometheus.io/docs/instrumenting/clientlibs/[Prometheus Documentation].
|
||||
|
||||
* 如果监控指标采集过程需要认证，您还需要在目标应用程序中配置相关认证逻辑，并在{ks_product-en}平台提前创建包含认证信息的保密字典。
|
||||
* If the monitoring metric collection process requires authentication, you also need to configure the relevant authentication logic in the target application and create a Secret containing the authentication information in the {ks_product-en} platform in advance.
|
||||
|
|
@ -26,7 +26,7 @@
|
|||
|Stores events of Kubernetes resources and provides multi-tenant event query and viewing functions.
|
||||
|
||||
// |WhizardTelemetry Auditing
|
||||
// |It provides auditing management for Kubernetes and KubeSphere: records user behaviors on the {ks_product-en} platform in real-time, and provides audit history query and viewing functions, which can quickly trace back the behaviors of users.
|
||||
// |Provides auditing management for Kubernetes and KubeSphere: records user behaviors on the {ks_product-en} platform in real-time, and provides audit history query and viewing functions, which can quickly trace back the behaviors of users.
|
||||
|
||||
|WhizardTelemetry Monitoring
|
||||
|Provides multi-tenant monitoring capabilities for cloud-native resources, including real-time and historical data display of core monitoring indicators for objects such as clusters, nodes, workloads, GPU, K8s control plane, etc. It includes the Whizard Observability Center.
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
|Based on the monitoring data collected by KubeSphere, it manages alerting and alerting rules for different resource types and metrics data.
|
||||
|
||||
// |WhizardTelemetry Events Alerting
|
||||
// |Define alerting rules for Kubernetes/KubeSphere auditing events, Kubernetes native events, and Kubernetes logs, evaluate incoming event data and log data, and send alerts to specified receivers such as HTTP endpoints.
|
||||
// |Defines alerting rules for Kubernetes/KubeSphere auditing events, Kubernetes native events, and Kubernetes logs, evaluate incoming event data and log data, and send alerts to specified receivers such as HTTP endpoints.
|
||||
|
||||
|WhizardTelemetry Notification
|
||||
|Manages notifications in multi-tenant Kubernetes environments. It receives alerts, cloud events, and other types of events (such as audits and Kubernetes events) from different senders, and send notifications to corresponding tenant receivers based on tenant labels (such as namespaces or users).
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 6eca522f12cc4fac84157f8cae7f92ba
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product-en} Web 控制台。
|
||||
. Log in to the {ks_product-en} web console with a user having the **platform-admin** role.
|
||||
|
|
@ -1,23 +1,23 @@
|
|||
// :ks_include_id: e1fc48dace834fd9b24c37503267b870
|
||||
* 通用参数
|
||||
* Common Parameters
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|规则名称
|
||||
|告警规则的名称。规则名称可包含任意字符，最长 63 个字符。
|
||||
|Rule Name
|
||||
|The name of the alert rule. The rule name can contain any characters and can be up to 63 characters long.
|
||||
|
||||
|标签设置
|
||||
|为告警规则设置键值对标签，以便在通知订阅中通过标签过滤，发送标签符合特定条件的告警通知。
|
||||
|Label Setting
|
||||
|Set key-value pair labels for the alert rule, so that alerts can be filtered by labels in notification subscriptions and sent to recipients whose labels meet specific conditions.
|
||||
|
||||
告警规则创建后，会自动生成一个键为 rule_id 的标签。
|
||||
After the alert rule is created, a label with the key `rule_id` will be automatically generated.
|
||||
|
||||
|概要
|
||||
|告警消息的内容概要。消息概要可包含任意字符，最长 63 个字符。
|
||||
|Summary
|
||||
|The content summary of the alert message. The message summary can contain any characters and can be up to 63 characters long.
|
||||
|
||||
|详情
|
||||
|告警消息的详细描述。消息详情可包含任意字符，最长 256 个字符。
|
||||
|Details
|
||||
|The detailed description of the alert message. The message details can contain any characters and can be up to 256 characters long.
|
||||
|===
|
||||
--
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
// :ks_include_id: 3c60b62a4b7b46268fc4359057be4bbd
|
||||
|持续时间
|
||||
|设置系统等待一段时间并检查告警情况是否持续存在，如果告警情况持续存在才触发告警。
|
||||
|Duration
|
||||
|Set the system to wait for a period of time and check if the alert situation persists. If the alert situation persists, an alert is triggered.
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
// :ks_include_id: bbc7923adc904ec2a560a3b6a8d350de
|
||||
|告警规则表达式
|
||||
|用于指定监控目标和触发条件的 PromQL 表达式。有关更多信息，请参阅 link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus 官方文档]。
|
||||
|Rule Expression
|
||||
|The PromQL expression used to specify the monitoring target and trigger condition. For more information, see the link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Prometheus Documentation].
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
// :ks_include_id: 197c3cc778524087a496fa04b4eabab8
|
||||
|触发条件
|
||||
|触发告警的条件。您可以设置条件的指标、操作符、阈值、持续时间和告警的级别。例如，CPU 用量 > 80% 持续 60 分钟时触发重要告警。
|
||||
|Trigger Condition
|
||||
|The condition that triggers the alert. You can set the metric, operator, threshold, duration, and severity of the condition. For example, a critical alert is triggered when CPU usage > 80% for 60 minutes.
|
||||
|
|
@ -1,24 +1,24 @@
|
|||
// :ks_include_id: 6883b8e230774b5085de676f53fe897b
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|键
|
||||
|通知内容中的键。点击下拉列表可选择预设的键，在下拉列表中可以输入自定义的键。
|
||||
|Key
|
||||
|The key in the notification content. Click the dropdown list to select a preset key, or input a custom key in the dropdown list.
|
||||
|
||||
|操作符
|
||||
|筛选条件的操作符。
|
||||
|Operator
|
||||
|The operator for the filter condition.
|
||||
|
||||
* **包含**：键对应的值包含特定的字符串。
|
||||
* **Contains**: The value corresponding to the key contains a specific string.
|
||||
|
||||
* **不包含**：键对应的值不包含特定的字符串。
|
||||
* **Does Not Contain**: The value corresponding to the key does not contain a specific string.
|
||||
|
||||
* **存在**：通知内容中存在特定的键。
|
||||
* **Exists**: The specific key exists in the notification content.
|
||||
|
||||
* **不存在**：通知内容中不存在特定的键。
|
||||
* **Does Not Exist**: The specific key does not exist in the notification content.
|
||||
|
||||
* **正则匹配**：通过正则表达式来筛选符合条件的通知。
|
||||
* **Regex Match**: Filter notifications that meet the conditions through a regular expression.
|
||||
|
||||
|值
|
||||
|键对应的值必须包含的字符串。按 **Enter** 可设置多个字符串，键对应的值包含其中一个字条串即满足条件。
|
||||
|Values
|
||||
|The value corresponding to the key must include the specified string. Press **Enter** to set multiple strings. If the value corresponding to the key contains any of these strings, the condition is met.
|
||||
|===
|
||||
|
|
@ -1,18 +1,18 @@
|
|||
// :ks_include_id: 9f95c83dc7754be49bf6b78b7587d110
|
||||
* 群机器人设置
|
||||
* Chatbot Settings
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|Webhook URL
|
||||
|群机器人的 Webhook URL。{ks_product-en}将向该 URL 发送通知。
|
||||
|The Webhook URL of the chatbot. {ks_product-en} will send notifications to this URL.
|
||||
|
||||
|Secret
|
||||
|群机器人的访问密钥。
|
||||
|The access key of the chatbot.
|
||||
|
||||
|关键词
|
||||
|群机器人接受的关键词。点击**添加**可设置多个关键词。
|
||||
|Keywords
|
||||
|The keywords accepted by the chatbot. Click **Add** to set multiple keywords.
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
// :ks_include_id: cd2ef9bcec6f4a9e8c517cfa2a4c539d
|
||||
* 过滤条件
|
||||
* Filter Conditions
|
||||
+
|
||||
--
|
||||
{ks_product-en}发送的通知以键值对的形式呈现。当此处填写的**键**和**值**与规则组告警规则的标签设置中的**键**和**值**一致时，就可以通过标签过滤，发送标签符合特定条件的告警通知。点击**添加**可设置多个条件。
|
||||
The notifications sent by {ks_product-en} are presented in the form of key-value pairs. When the **key** and **value** filled in here match the **key** and **value** in the label settings of the alert rules in rule groups, the notifications can be filtered by labels and alert notifications that meet specific label conditions can be sent to receivers. Click **Add** to set multiple conditions.
|
||||
|
||||
include::notificationChannels-para-filterRule_new.adoc[]
|
||||
--
|
||||
--
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: a951805f6c724c60851e752934b9e529
|
||||
* 点击**发送测试信息**以确认通知渠道工作正常。
|
||||
* Click **Send Test Message** to confirm that the notification channel is working properly.
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
// :ks_include_id: 4bc2cd1ba23245a3a6cfa71e436db5d5
|
||||
|会话 ID
|
||||
|接收通知的会话的 User ID 或 Department ID。点击**添加**可设置多个会话 ID。
|
||||
|Session ID
|
||||
|The User ID or Department ID of the session that will receive notifications. Click **Add** to set multiple session IDs.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
// :ks_include_id: 920119fed2624b659ff20db4f8b42082
|
||||
|别名
|
||||
|静默策略的别名。不同静默策略的别名可以相同。别名只能包含中文、字母、数字和连字符（-），不得以连字符（-）开头或结尾，最长 63 个字符。
|
||||
|Alias
|
||||
|The alias of the silence policy. Different silence policies can have the same alias. The alias can only contain Chinese characters, letters, numbers, and hyphens (-), cannot start or end with a hyphen (-), and can be up to 63 characters long.
|
||||
|
||||
|描述
|
||||
|静默策略的描述信息。描述可包含任意字符，最长 256 个字符。
|
||||
|Description
|
||||
|The description of the silence policy. The description can contain any characters and can be up to 256 characters long.
|
||||
|
|
@ -1,14 +1,14 @@
|
|||
// :ks_include_id: 4886da3f3a094de187d396ed1236141b
|
||||
* 对所有通知静默
|
||||
* Silent for All Notifications
|
||||
+
|
||||
--
|
||||
设置静默策略适用于所有通知。
|
||||
Set the silence policy to apply to all notifications.
|
||||
--
|
||||
|
||||
* 自定义静默条件
|
||||
* Custom Silence Conditions
|
||||
+
|
||||
--
|
||||
设置静默策略仅适用于满足指定条件的通知。点击**添加**可设置通知需要满足的条件。
|
||||
Set the silence policy to apply only to notifications that meet the specified conditions. Click **Add** to set the conditions that the notification needs to meet.
|
||||
|
||||
include::../notificationChannels/notificationChannels-para-filterRule_new.adoc[]
|
||||
--
|
||||
--
|
||||
|
|
@ -1,16 +1,14 @@
|
|||
// :ks_include_id: 4cae0895d3854461b646043abc44ff2b
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|持续静默
|
||||
|满足静默条件的通知在所有时间静默。
|
||||
|Silence Continuously
|
||||
|Notifications that meet the silence conditions are silenced at all times.
|
||||
|
||||
|在特定时间范围内静默
|
||||
|满足静默条件的通知在指定的时间范围内静默。您需要选择静默的开始时间和结束时间。
|
||||
|Silence During Time Range
|
||||
|Notifications that meet the silence conditions are silenced during the specified time range. You need to select the start and end times for the silence.
|
||||
|
||||
|周期性静默
|
||||
|满足静默条件的通知每日、每周或每月在指定的时间范围内静默。您需要选择静默的日期、开始时间和结束时间。
|
||||
|===
|
||||
|
||||
静默策略创建完成后将显示在静默策略列表中。
|
||||
|Silence Periodically
|
||||
|Notifications that meet the silence conditions are silenced daily, weekly, or monthly during the specified time range. You need to select the date, start time, and end time for the silence.
|
||||
|===
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: 352d6d8a19f04dbeb3551dbec55871b0
|
||||
. 在微服务配置列表中，点击一个微服务配置的名称打开其详情页面。
|
||||
. Click the name of a microservice configuration in the list to open its details page.
|
||||
|
|
@ -1,109 +1,109 @@
|
|||
// :ks_include_id: 2da62725a68a446abf46e55566d6ae11
|
||||
以下介绍如何设置微服务网关的参数。
|
||||
The following describes how to set the parameters for the microservice gateway.
|
||||
|
||||
* 基本信息
|
||||
* Basic Information
|
||||
+
|
||||
--
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|名称
|
||||
|微服务网关的名称，同时也是对应的部署的名称。名称只能包含小写字母、数字和连字符（-），必须以小写字母或数字开头和结尾，最长 63 个字符。
|
||||
|Name
|
||||
|The name of the microservice gateway, which is also the name of the corresponding deployment. The name can only contain lowercase letters, numbers, and hyphens (-), must start and end with a lowercase letter or number, and can be up to 63 characters long.
|
||||
|
||||
|镜像
|
||||
|用于创建微服务网关的容器镜像。例如 **registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest**。
|
||||
|Image
|
||||
|The container image used to create the microservice gateway. For example, `registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest`.
|
||||
|
||||
|副本数量
|
||||
|微服务网关部署的容器组副本数量。
|
||||
|Number of Replicas
|
||||
|The number of pod replicas for the microservice gateway deployment.
|
||||
|===
|
||||
--
|
||||
|
||||
* 资源配额
|
||||
* Resource Quotas
|
||||
+
|
||||
--
|
||||
设置为微服务网关每个容器的资源预留和资源上限。
|
||||
Set the resource request and resource limit for each container in the microservice gateway.
|
||||
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|CPU 预留
|
||||
|为容器预留的 CPU 资源，单位为核。
|
||||
|CPU Request
|
||||
|The CPU resources reserved for the container, in cores.
|
||||
|
||||
|CPU 上限
|
||||
|允许容器使用的 CPU 资源上限，单位为核。
|
||||
|CPU Limit
|
||||
|The upper limit of CPU resources allowed for the container, in cores.
|
||||
|
||||
|内存预留
|
||||
|为容器预留的内存资源，单位为 MiB。
|
||||
|Memory Request
|
||||
|The memory resources reserved for the container, in MiB.
|
||||
|
||||
|内存上限
|
||||
|允许容器使用的内存资源上限，单位为 MiB。
|
||||
|Memory Limit
|
||||
|The upper limit of memory resources allowed for the container, in MiB.
|
||||
|===
|
||||
--
|
||||
|
||||
* 端口设置
|
||||
* Port Settings
|
||||
+
|
||||
--
|
||||
设置用于暴露微服务网关的服务的端口。
|
||||
Set the ports for the service exposing the microservice gateway.
|
||||
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|协议
|
||||
|目标容器中的应用程序实际监听的协议。
|
||||
|Protocol
|
||||
|The protocol that the application in the target container actually listens on.
|
||||
|
||||
|名称
|
||||
|服务端口的名称。
|
||||
|Name
|
||||
|The name of the service port.
|
||||
|
||||
|容器端口
|
||||
|目标容器中的应用程序实际监听的端口号。如果使用示例容器镜像 **registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest**，请将容器端口号设置为 **8080**。
|
||||
|Container Port
|
||||
|The port number that the application in the target container actually listens on. If using the example container image `registry.cn-beijing.aliyuncs.com/kse/spring-cloud-gateway:latest`, set the container port number to **8080**.
|
||||
|
||||
|服务端口
|
||||
|服务的端口号。
|
||||
|Service Port
|
||||
|The port number of the service.
|
||||
|===
|
||||
|
||||
点击**添加**可设置多个服务端口。在已创建的服务端口右侧点击image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18]可删除服务端口。
|
||||
Click **Add** to set multiple service ports. Click image:/images/ks-qkcp/zh/icons/trash-light.svg[trash-light,18,18] on the right side of the created service port to delete it.
|
||||
--
|
||||
|
||||
* 镜像拉取策略
|
||||
* Image Pull Policy
|
||||
+
|
||||
--
|
||||
include::../../clusterManagement/workloads/createWorkload/workloads-para-imagePullPolicy.adoc[]
|
||||
--
|
||||
|
||||
* 健康检查
|
||||
* Health Check
|
||||
+
|
||||
--
|
||||
include::../../clusterManagement/workloads/createWorkload/workloads-para-healthCheck.adoc[]
|
||||
--
|
||||
|
||||
* 环境变量
|
||||
* Environment Variables
|
||||
+
|
||||
--
|
||||
include::../../clusterManagement/workloads/createWorkload/workloads-para-environmentVariables.adoc[]
|
||||
--
|
||||
|
||||
* 启动命令
|
||||
* Start Command
|
||||
+
|
||||
--
|
||||
include::../../clusterManagement/workloads/createWorkload/workloads-para-startCommand.adoc[]
|
||||
--
|
||||
|
||||
* 外部访问
|
||||
* Advanced Settings > External Access
|
||||
+
|
||||
--
|
||||
设置是否允许从 KubeSphere 集群外部访问微服务网关。如果启用外部访问，您需要选择外部访问模式。
|
||||
Set whether to allow the microservice gateway to be accessed from outside the KubeSphere cluster. If external access is enabled, you need to select the external access mode.
|
||||
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|NodePort
|
||||
|系统将节点的端口映射到服务端口，可通过节点的 IP 地址和节点端口访问服务。
|
||||
|The system maps the node's port to the service port, and the service can be accessed via the node's IP address and node port.
|
||||
|
||||
|LoadBalancer
|
||||
|系统在 NodePort 服务的基础上为服务分配一个外部 IP 地址，并将外部 IP 地址与一个外部负载均衡器绑定。外部负载均衡器监听服务对应的节点端口，从而可以通过外部 IP 地址访问服务。为实现上述功能，LoadBalancer 类型的服务需要负载均衡器插件和基础设施环境提供支持，并且需要设置相关注解。有关更多信息，请联系您的基础设施环境提供商。
|
||||
|The system allocates an external IP address to the service on top of the NodePort service and binds the external IP address to an external load balancer. The external load balancer listens on the node port corresponding to the service, so the service can be accessed via the external IP address. To achieve this functionality, the service in the LoadBalancer type requires load balancer plugins and infrastructure environment support, and relevant annotations need to be set. For more information, contact your infrastructure environment provider.
|
||||
|===
|
||||
--
|
||||
--
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
// :ks_include_id: c7354e9057cd4477a7c4d78ff3c222dc
|
||||
. 在微服务右侧点击image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18]打开微服务实例列表。
|
||||
. Click image:/images/ks-qkcp/zh/icons/plus-square.svg[plus-square,18,18] on the right side of the microservice to open the microservice instance list.
|
||||
|
|
@ -1,20 +1,20 @@
|
|||
// :ks_include_id: 63f2cf5af75e41deb6a5d5c45da3d5b3
|
||||
[%header,cols="1a,4a"]
|
||||
|===
|
||||
|参数 |描述
|
||||
|Parameter |Description
|
||||
|
||||
|名称
|
||||
|微服务实例的名称。
|
||||
|Name
|
||||
|The name of the microservice instance.
|
||||
|
||||
|权重
|
||||
|微服务实例在微服务中的权重。发送给微服务的流量将根据微服务实例的权重分配给微服务实例。
|
||||
|Weight
|
||||
|The weight of the microservice instance within the microservice. Traffic sent to the microservice will be distributed to microservice instances based on their weights.
|
||||
|
||||
|IP 地址
|
||||
|微服务实例的在{ks_product-en}集群内部的访问地址。
|
||||
|IP Address
|
||||
|The internal access address of the microservice instance in the KubeSphere cluster.
|
||||
|
||||
|端口
|
||||
|微服务实例的访问端口号。
|
||||
|Port
|
||||
|The access port number of the microservice instance.
|
||||
|
||||
|创建时间
|
||||
|微服务实例的创建时间。
|
||||
|===
|
||||
|Creation Time
|
||||
|The creation time of the microservice instance.
|
||||
|===
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
// :ks_include_id: b7d4651227e646b1b025777d274f6c4a
|
||||
* Contact the administrator to obtain the IP address and port number of the {ks_product-en} web console.
|
||||
|
||||
* Depending on your network environment, you may need to configure firewall policies and traffic forwarding strategies. For specific instructions, please contact your network administrator.
|
||||
* Depending on your network environment, you may need to configure firewall and traffic forwarding rules. For specific instructions, please contact your network administrator.
|
||||
|
|
@ -50,7 +50,7 @@ You should have the pass:a,q[{ks_permission}] permission on the {ks_product-en}
|
|||
|
||||
|===
|
||||
|
||||
* Click the search box above the list and enter keywords to search for users whose usernames contain specific keywords.
|
||||
* Click the search box above the list to search for users by name.
|
||||
|
||||
* Click image:/images/ks-qkcp/zh/icons/refresh-light.svg[refresh,18,18] in the upper right corner of the list to refresh the list information.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,8 @@ This section explains how to create DevOps projects.
|
|||
|
||||
== Prerequisites
|
||||
|
||||
* A workspace (not `system-workspace`) has been created.
|
||||
|
||||
* {empty}
|
||||
include::../../../../_custom-en/workspaceManagement/workspaceManagement-prer-requiredPermission_v4.adoc[]
|
||||
|
||||
|
|
|
|||
|
|
@ -10,4 +10,4 @@ DevOps supports deploying and managing CI/CD tasks and related workloads on Kube
|
|||
|
||||
After installing DevOps, **DevOps Projects** will appear in the left navigation pane of the workspace.
|
||||
|
||||
This section explains how to manage DevOps projects and operate within DevOps projects, including running pipelines, creating credentials, and integrating tools.
|
||||
This section explains how to manage DevOps projects in a workspace and operate within DevOps projects, including running pipelines, creating credentials, and integrating tools.
|
||||
|
|
@ -1,17 +1,16 @@
|
|||
---
|
||||
title: "配置 WhizardTelemetry 平台服务"
|
||||
description: "介绍如何配置 WhizardTelemetry 平台服务。"
|
||||
title: "Configure WhizardTelemetry Platform Service"
|
||||
description: "Learn how to configure the WhizardTelemetry Platform Service."
|
||||
weight: 01
|
||||
---
|
||||
|
||||
WhizardTelemetry 平台服务是 WhizardTelemetry 可观测平台中各扩展组件的公共服务。它是各个可观测性扩展组件通用的 APIServer，为所有可观测性扩展组件提供公共的后端平台服务。
|
||||
The WhizardTelemetry Platform Service is the common service for all extensions of WhizardTelemetry Observability Platform. It is a common APIServer that providing backend platform services for all observability extensions.
|
||||
|
||||
**配置说明：**
|
||||
**Configuration:**
|
||||
|
||||
* 修改 WhizardTelemetry 平台服务的扩展组件配置，可配合 WhizardTelemetry 监控扩展组件，启用 Whizard 可观测中心。有关更多信息，请参阅 link:../../07-whizard/01-enable-whizard/[Whizard 可观测中心]。
|
||||
* Modify the extension configuration of WhizardTelemetry Platform Service in conjunction with WhizardTelemetry Monitoring to enable the Whizard Observability Center. For more information, see link:../../07-whizard/01-enable-whizard/[Whizard Observability Center].
|
||||
|
||||
* 为 WhizardTelemetry 日志、WhizardTelemetry 审计、WhizardTelemetry 事件、以及通知历史配置 OpenSearch 日志接收器时，如果需要使用多个 OpenSearch 数据库，可以按如下配置。
|
||||
// 有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 平台服务”扩展组件的详情页说明。
|
||||
* When configuring the OpenSearch log receivers for WhizardTelemetry Logging, WhizardTelemetry Auditing, WhizardTelemetry Events, and notification history, if you need to use multiple OpenSearch databases, configure them as follows.
|
||||
+
|
||||
[,yaml]
|
||||
----
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "WhizardTelemetry 平台服务"
|
||||
description: "介绍 WhizardTelemetry 平台服务。"
|
||||
title: "WhizardTelemetry Platform Service"
|
||||
description: "Learn about the WhizardTelemetry Platform Service."
|
||||
weight: 01
|
||||
layout: "second"
|
||||
---
|
||||
---
|
||||
|
|
@ -1,293 +0,0 @@
|
|||
---
|
||||
title: "步骤 1：使用 Vector 将数据写入 Kafka"
|
||||
weight: 01
|
||||
---
|
||||
|
||||
|
||||
== 部署 KSE 并安装日志相关组件
|
||||
|
||||
{ks_product_right}中需要安装的扩展组件：
|
||||
|
||||
- RadonDB DMP
|
||||
- OpenSearch 分布式检索与分析引擎
|
||||
- WhizardTelemetry 平台服务
|
||||
- WhizardTelemetry 数据流水线
|
||||
- WhizardTelemetry 日志
|
||||
- WhizardTelemetry 审计
|
||||
- WhizardTelemetry 通知
|
||||
- WhizardTelemetry 事件
|
||||
|
||||
=== 禁用 OpenSearch Sink
|
||||
|
||||
在安装部署 WhizardTelemetry 日志、WhizardTelemetry 审计、WhizardTelemetry 事件以及 WhizardTelemetry 通知前，需要禁用这些扩展组件配置中 opensearch 的 sink。
|
||||
|
||||
以安装 WhizardTelemetry 审计扩展组件为例，将 sinks.opensearch.enabled 设置为 false。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/disable-opensearch.png[vector,100%]
|
||||
|
||||
== 配置 Kafka
|
||||
|
||||
在{ks_product_both}中，安装 **RadonDB DMP** 扩展组件后，点击顶部导航栏上的image:/images/ks-qkcp/zh/icons/grid.svg[grid,18,18]图标，然后点击 RadonDB DMP 进入数据库管理平台，创建 Kafka 集群以用于收集日志。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/dmp.png[vector,100%]
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/kafka.png[vector,100%]
|
||||
|
||||
=== 启用自动创建 topic
|
||||
|
||||
点击 Kafka 集群名称，进入**参数管理**页签，启用自动创建 topic 的功能。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/parameter.png[vector,100%]
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/enable-topic.png[vector,100%]
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
在 Kafka 集群的详情页左侧可获取 Kafka 的读写地址。
|
||||
|===
|
||||
|
||||
|
||||
=== 创建 Kafka 用户
|
||||
|
||||
. 在 Kafka 集群的详情页面，进入 **Kafka 用户**页签，点击**创建**开始创建 Kafka 用户。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.1/kafka-user.png[vector,100%]
|
||||
|
||||
. 按下图所示设置用户权限。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.1/user-permission.png[vector, 70%]
|
||||
|
||||
|
||||
=== 获取证书
|
||||
|
||||
==== 查看证书相关信息
|
||||
|
||||
为了与 Kafka 通信，需要配置相关的证书及文件，具体为 <cluster>-cluster-ca-cert，以及上一个步骤中创建的用户的 user.p12 字段及密码，详细信息可在{ks_product_left} Web 控制台界面上查询，如下所示。
|
||||
|
||||
|
||||
. 点击页面上方的**工作台 > 集群管理**，进入 host 集群。
|
||||
. 在左侧导航栏选择**配置 > 保密字典**。
|
||||
. 在**保密字典**页面，搜索 `cluster-ca-cert`，点击 Kafka 集群对应的保密字典进入详情页面，查看 **ca-crt** 字段的信息。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.1/ca-crt.png[vector,100%]
|
||||
+
|
||||
. 在**保密字典**页面，搜索已创建的 Kafka 用户的名称，点击其对应的保密字典进入详情页面，查看 **user.p12** 及 **user.password** 字段的信息。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.1/user-password.png[vector,100%]
|
||||
|
||||
==== 生成证书
|
||||
|
||||
. 在 Kafka 所在集群的节点上，执行以下命令。
|
||||
+
|
||||
====
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
**kafka cluster** 为 Kafka 集群的名称，**kafka namespace** 为 Kafka 所在的 namespace，**kafka user** 为之前创建的 Kafka 用户。
|
||||
|===
|
||||
|
||||
[,bash]
|
||||
----
|
||||
export kafka_cluster=< kafka cluster >
|
||||
export kafka_namespace=< kafka namespace >
|
||||
export kafka_user=< kafka user >
|
||||
echo -e "apiVersion: v1\ndata:" > kafka-ca.yaml
|
||||
echo " ca.crt: $(kubectl get secret -n $kafka_namespace ${kafka_cluster}-cluster-ca-cert \
|
||||
-o jsonpath='{.data.ca\.crt}')" >> kafka-ca.yaml
|
||||
echo -e "kind: Secret\nmetadata:\n name: kafka-agent-cluster-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Agent\n \
|
||||
namespace: kubesphere-logging-system\ntype: Opaque" >> kafka-ca.yaml
|
||||
echo "---" >> kafka-ca.yaml
|
||||
echo -e "apiVersion: v1\ndata:" >> kafka-ca.yaml
|
||||
echo " user.p12: $(kubectl get secret -n $kafka_namespace ${kafka_user} \
|
||||
-o jsonpath='{.data.user\.p12}')" >> kafka-ca.yaml
|
||||
echo -e "kind: Secret\nmetadata:\n name: kafka-agent-user-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Agent\n \
|
||||
namespace: kubesphere-logging-system\ntype: Opaque" >> kafka-ca.yaml
|
||||
----
|
||||
|
||||
此命令会生成 **kafka-ca.yaml** 文件，包含 **kafka-agent-cluster-ca** 以及 **kafka-agent-user-ca** 两个 secret 文件，分别含有上一个步骤中的 ca.crt 以及 user.p12 信息。示例如下：
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
apiVersion: v1
|
||||
data:
|
||||
ca.crt: xxx
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: kafka-agent-cluster-ca
|
||||
labels:
|
||||
logging.whizard.io/certification: 'true'
|
||||
logging.whizard.io/vector-role: Agent
|
||||
namespace: kubesphere-logging-system
|
||||
type: Opaque
|
||||
---
|
||||
apiVersion: v1
|
||||
data:
|
||||
user.p12: xxxx
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: kafka-agent-user-ca
|
||||
labels:
|
||||
logging.whizard.io/certification: 'true'
|
||||
logging.whizard.io/vector-role: Agent
|
||||
namespace: kubesphere-logging-system
|
||||
----
|
||||
====
|
||||
|
||||
. 将 **kafka-ca.yaml** 文件复制到需要收集日志数据的集群节点上，执行以下命令。
|
||||
+
|
||||
--
|
||||
[,bash]
|
||||
----
|
||||
kubectl apply -f kafka-ca.yaml
|
||||
----
|
||||
|
||||
此命令会在 **kubesphere-logging-system** 项目下创建 **kafka-agent-cluster-ca** 以及 **kafka-agent-user-ca** 两个 secret 文件。vector-config 会自动加载这两个 secret，并且在 vector 中配置相关证书。
|
||||
--
|
||||
|
||||
== 创建 Kafka 日志接收器
|
||||
|
||||
[,bash]
|
||||
----
|
||||
cat <<EOF | kubectl apply -f -
|
||||
kind: Secret
|
||||
apiVersion: v1
|
||||
metadata:
|
||||
name: vector-agent-auditing-sink-kafka
|
||||
namespace: kubesphere-logging-system
|
||||
labels:
|
||||
logging.whizard.io/component: auditing
|
||||
logging.whizard.io/enable: 'true'
|
||||
logging.whizard.io/vector-role: Agent
|
||||
annotations:
|
||||
kubesphere.io/creator: admin
|
||||
stringData:
|
||||
sink.yaml: >-
|
||||
sinks:
|
||||
kafka_auditing:
|
||||
type: "kafka"
|
||||
topic: "vector-{{ .cluster }}-auditing"
|
||||
# 逗号分隔的 Kafka bootstrap servers 如："10.14.22.123:9092,10.14.23.332:9092"
|
||||
bootstrap_servers: "172.31.73.214:32239"
|
||||
librdkafka_options:
|
||||
security.protocol: "ssl"
|
||||
ssl.endpoint.identification.algorithm: "none"
|
||||
ssl.ca.location: "/etc/vector/custom/certification/ca.crt"
|
||||
ssl.keystore.location: "/etc/vector/custom/certification/user.p12"
|
||||
ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o"
|
||||
encoding:
|
||||
codec: "json"
|
||||
inputs:
|
||||
- auditing_remapped
|
||||
batch:
|
||||
max_events: 100
|
||||
timeout_secs: 10
|
||||
type: Opaque
|
||||
|
||||
---
|
||||
kind: Secret
|
||||
apiVersion: v1
|
||||
metadata:
|
||||
name: vector-agent-events-sink-kafka
|
||||
namespace: kubesphere-logging-system
|
||||
labels:
|
||||
logging.whizard.io/component: events
|
||||
logging.whizard.io/enable: 'true'
|
||||
logging.whizard.io/vector-role: Agent
|
||||
annotations:
|
||||
kubesphere.io/creator: admin
|
||||
stringData:
|
||||
sink.yaml: >-
|
||||
sinks:
|
||||
kafka_events:
|
||||
type: "kafka"
|
||||
topic: "vector-{{ .cluster }}-events"
|
||||
bootstrap_servers: "172.31.73.214:32239"
|
||||
librdkafka_options:
|
||||
security.protocol: "ssl"
|
||||
ssl.endpoint.identification.algorithm: "none"
|
||||
ssl.ca.location: "/etc/vector/custom/certification/ca.crt"
|
||||
ssl.keystore.location: "/etc/vector/custom/certification/user.p12"
|
||||
ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o"
|
||||
encoding:
|
||||
codec: "json"
|
||||
inputs:
|
||||
- kube_events_remapped
|
||||
batch:
|
||||
max_events: 100
|
||||
timeout_secs: 10
|
||||
type: Opaque
|
||||
|
||||
---
|
||||
kind: Secret
|
||||
apiVersion: v1
|
||||
metadata:
|
||||
name: vector-agent-logs-sink-kafka
|
||||
namespace: kubesphere-logging-system
|
||||
labels:
|
||||
logging.whizard.io/component: logs
|
||||
logging.whizard.io/enable: 'true'
|
||||
logging.whizard.io/vector-role: Agent
|
||||
annotations:
|
||||
kubesphere.io/creator: admin
|
||||
stringData:
|
||||
sink.yaml: >-
|
||||
sinks:
|
||||
kafka_logs:
|
||||
type: "kafka"
|
||||
topic: "vector-{{ .cluster }}-logs"
|
||||
bootstrap_servers: "172.31.73.214:32239"
|
||||
librdkafka_options:
|
||||
security.protocol: "ssl"
|
||||
ssl.endpoint.identification.algorithm: "none"
|
||||
ssl.ca.location: "/etc/vector/custom/certification/ca.crt"
|
||||
ssl.keystore.location: "/etc/vector/custom/certification/user.p12"
|
||||
ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o"
|
||||
encoding:
|
||||
codec: "json"
|
||||
inputs:
|
||||
- kube_logs_remapped
|
||||
- systemd_logs_remapped
|
||||
batch:
|
||||
max_events: 100
|
||||
timeout_secs: 10
|
||||
type: Opaque
|
||||
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: vector-aggregator-notification-history-sink-kafka
|
||||
namespace: kubesphere-logging-system
|
||||
labels:
|
||||
logging.whizard.io/component: "notification-history"
|
||||
logging.whizard.io/vector-role: Aggregator
|
||||
logging.whizard.io/enable: "true"
|
||||
stringData:
|
||||
sink.yaml: >-
|
||||
sinks:
|
||||
kafka_notification_history:
|
||||
type: "kafka"
|
||||
topic: "vector-{{ .cluster }}-notification-history"
|
||||
bootstrap_servers: "172.31.73.214:32239"
|
||||
librdkafka_options:
|
||||
security.protocol: "ssl"
|
||||
ssl.endpoint.identification.algorithm: "none"
|
||||
ssl.ca.location: "/etc/vector/custom/certification/ca.crt"
|
||||
ssl.keystore.location: "/etc/vector/custom/certification/user.p12"
|
||||
ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o"
|
||||
encoding:
|
||||
codec: "json"
|
||||
inputs:
|
||||
- notification_history_remapped
|
||||
batch:
|
||||
max_events: 100
|
||||
timeout_secs: 10
|
||||
type: Opaque
|
||||
EOF
|
||||
----
|
||||
|
||||
|
|
@ -1,171 +0,0 @@
|
|||
---
|
||||
title: "步骤 2：使用 Vector 从 Kafka 读取数据"
|
||||
weight: 02
|
||||
---
|
||||
|
||||
== 部署 vector aggregator
|
||||
|
||||
在 Kafka 所在集群，执行以下命令创建 vector namespace，并在该 namespace 下部署 vector-aggregator。
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
* 请勿将 vector aggregator 部署到 kubesphere-logging-system namespace， 以免与{ks_product_both}内置的 vector aggregator 冲突。
|
||||
|
||||
* 请联系{ks_product_both}交付服务专家获取 vector aggregator 的 helm 包。
|
||||
|===
|
||||
|
||||
[,bash]
|
||||
----
|
||||
helm install vector-aggregator aggregator-0.30.0.tgz -n vector --create-namespace --set vectorConfig.image.tag=v0.2.1 --set image.tag=0.36.0-debian
|
||||
----
|
||||
|
||||
所需镜像：
|
||||
|
||||
[,bash]
|
||||
----
|
||||
docker.io/timberio/vector:0.36.0-debian
|
||||
docker.io/kubesphere/kubectl:v1.26.13
|
||||
docker.io/kubesphere/vector-config:v0.2.1
|
||||
----
|
||||
|
||||
== 获取证书
|
||||
|
||||
. 在 Kafka 所在集群的节点上，执行以下命令。
|
||||
+
|
||||
====
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|
||||
|
|
||||
**kafka cluster** 为 Kafka 集群的名称，**kafka namespace** 为 Kafka 所在的 namespace，**kafka user** 为之前创建的 Kafka 用户。
|
||||
|===
|
||||
|
||||
[,bash]
|
||||
----
|
||||
export kafka_cluster=< kafka cluster >
|
||||
export kafka_namespace=< kafka namespace >
|
||||
export kafka_user=< kafka user >
|
||||
echo -e "apiVersion: v1\ndata:" > kafka-aggregator-ca.yaml
|
||||
echo " ca.crt: $(kubectl get secret -n $kafka_namespace ${kafka_cluster}-cluster-ca-cert \
|
||||
-o jsonpath='{.data.ca\.crt}')" >> kafka-aggregator-ca.yaml
|
||||
echo -e "kind: Secret\nmetadata:\n name: kafka-aggregator-cluster-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Aggregator\n \
|
||||
namespace: vector\ntype: Opaque" >> kafka-aggregator-ca.yaml
|
||||
echo "---" >> kafka-aggregator-ca.yaml
|
||||
echo -e "apiVersion: v1\ndata:" >> kafka-aggregator-ca.yaml
|
||||
echo " user.p12: $(kubectl get secret -n $kafka_namespace ${kafka_user} \
|
||||
-o jsonpath='{.data.user\.p12}')" >> kafka-aggregator-ca.yaml
|
||||
echo -e "kind: Secret\nmetadata:\n name: kafka-aggregator-user-ca\n labels:\n logging.whizard.io/certification: 'true'\n logging.whizard.io/vector-role: Aggregator\n \
|
||||
namespace: vector\ntype: Opaque" >> kafka-aggregator-ca.yaml
|
||||
----
|
||||
|
||||
此命令会生成 **kafka-aggregator-ca.yaml** 文件，包含 **kafka-aggregator-cluster-ca** 以及 **kafka-aggregator-user-ca** 两个 secret 文件，分别含有上一个步骤中的 ca.crt 以及 user.p12 信息。
|
||||
示例如下：
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
apiVersion: v1
|
||||
data:
|
||||
ca.crt: xxx
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: kafka-aggregator-cluster-ca
|
||||
labels:
|
||||
logging.whizard.io/certification: 'true'
|
||||
logging.whizard.io/vector-role: Aggregator
|
||||
namespace: vector
|
||||
type: Opaque
|
||||
---
|
||||
apiVersion: v1
|
||||
data:
|
||||
user.p12: xxx
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: kafka-aggregator-user-ca
|
||||
labels:
|
||||
logging.whizard.io/certification: 'true'
|
||||
logging.whizard.io/vector-role: Aggregator
|
||||
namespace: vector
|
||||
type: Opaque
|
||||
----
|
||||
|
||||
====
|
||||
|
||||
== 配置 vector-aggregator，将消息发送至 OpenSearch
|
||||
|
||||
创建 vector 配置，在 bootstrap_servers 填入相应的 Kafka 集群地址，在 sink:kafka_to_opensearch:endpoints 填入相应的 OpenSearch 地址。
|
||||
|
||||
[,bash]
|
||||
----
|
||||
cat <<EOF | kubectl apply -f -
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: vector-aggregator-opensearch
|
||||
namespace: vector
|
||||
labels:
|
||||
logging.whizard.io/vector-role: Aggregator
|
||||
logging.whizard.io/enable: "true"
|
||||
stringData:
|
||||
kafka-pipeline.yaml: >-
|
||||
sources:
|
||||
kafka_source:
|
||||
type: "kafka"
|
||||
group_id: "ks"
|
||||
topics: [ "^(vector)-.+" ]
|
||||
bootstrap_servers: "172.31.53.102:32476"
|
||||
librdkafka_options:
|
||||
security.protocol: "ssl"
|
||||
ssl.endpoint.identification.algorithm: "none"
|
||||
ssl.ca.location: "/etc/vector/custom/certification/ca.crt"
|
||||
ssl.keystore.location: "/etc/vector/custom/certification/user.p12"
|
||||
ssl.keystore.password: "yj5nwJLVqyII1ZHZCW2RQwJcyjKo3B9o"
|
||||
max.poll.interval.ms: "600000"
|
||||
partition.assignment.strategy: roundrobin
|
||||
decoding:
|
||||
codec: json
|
||||
session_timeout_ms: 20000
|
||||
socket_timeout_ms: 90000
|
||||
transforms:
|
||||
kafka_remapped:
|
||||
inputs:
|
||||
- kafka_source
|
||||
source: |-
|
||||
.event.original = encode_json(.)
|
||||
ts = parse_timestamp!(.timestamp, format: "%+")
|
||||
.timestamp = format_timestamp!(ts, format: "%+", timezone: "local")
|
||||
.topictime = to_unix_timestamp(ts, unit: "milliseconds")
|
||||
.logstamp = from_unix_timestamp!(.topictime, unit: "milliseconds")
|
||||
.logdate = .timestamp
|
||||
.idxdate = format_timestamp!(ts, format: "%Y.%m.%d", timezone: "local")
|
||||
tmp = split!(.topic, "-")
|
||||
.index = join!(remove!(tmp, [0]), "-")
|
||||
type: remap
|
||||
sinks:
|
||||
kafka_to_opensearch:
|
||||
api_version: v8
|
||||
auth:
|
||||
password: admin
|
||||
strategy: basic
|
||||
user: admin
|
||||
batch:
|
||||
timeout_secs: 5
|
||||
buffer:
|
||||
max_events: 10000
|
||||
endpoints:
|
||||
- https://<opensearch-url>:<port>
|
||||
tls:
|
||||
verify_certificate: false
|
||||
type: elasticsearch
|
||||
inputs:
|
||||
- kafka_remapped
|
||||
bulk:
|
||||
index: "{{ .index }}-%Y.%m.%d"
|
||||
request:
|
||||
timeout_sec: 180
|
||||
type: Opaque
|
||||
EOF
|
||||
----
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
title: "步骤 3：配置 WhizardTelemetry 平台服务"
|
||||
weight: 03
|
||||
---
|
||||
|
||||
== 修改 whizard-telemetry-config
|
||||
|
||||
如果使用外置 OpenSearch 数据库，需要修改配置文件 whizard-telemetry-config。
|
||||
|
||||
. 在集群左侧导航栏选择**配置 > 配置字典**。
|
||||
|
||||
. 在**配置字典**页面，查找 **whizard-telemetry-config**，点击右侧的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，然后在下拉列表中选择**编辑 yaml**。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.1/whizard-telemetry-config.png[vector,100%]
|
||||
|
||||
. 修改 `notification:history:endpoints`、`logging:endpoints`、`auditing:endpoints` 和 `events:endpoints` 为 OpenSearch 地址，点击**确定**。
|
||||
+
|
||||
image:/images/ks-qkcp/zh/v4.1/edit-endpoint.png[vector,100%]
|
||||
|
||||
== 在 KSE 界面查询日志
|
||||
|
||||
部署完成后，可以从 OpenSearch 查询到日志，如图所示。
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/log.png[vector,100%]
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
title: "Vector 日志 ETL 方案 - 从 Kafka 到 OpenSearch"
|
||||
keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理"
|
||||
description: "介绍 Vector 日志 ETL 方案。"
|
||||
weight: 13
|
||||
layout: "second"
|
||||
---
|
||||
|
||||
== 总体方案
|
||||
|
||||
image:/images/ks-qkcp/zh/v4.1/vector-solution.png[vector, 100%]
|
||||
|
|
@ -1,30 +1,30 @@
|
|||
---
|
||||
title: "WhizardTelemetry 数据流水线"
|
||||
keywords: "Kubernetes, {ks_product}, 平台设置, 通知管理"
|
||||
description: "介绍如何使用 WhizardTelemetry 数据流水线。"
|
||||
weight: 1.5
|
||||
title: "WhizardTelemetry Data Pipeline"
|
||||
keywords: "Kubernetes, {ks_product-en}, platform settings, notification management"
|
||||
description: "Learn how to use the WhizardTelemetry Data Pipeline."
|
||||
weight: 02
|
||||
layout: "second"
|
||||
---
|
||||
|
||||
|
||||
WhizardTelemetry 数据流水线是 WhizardTelemetry 可观测平台中提供可观测性数据的收集、转换和路由能力的扩展组件。
|
||||
The WhizardTelemetry Data Pipeline is an extension that provides capabilities to collect, transform, and route observability data.
|
||||
|
||||
|
||||
//attention
|
||||
[.admon.attention,cols="a"]
|
||||
|===
|
||||
| 注意
|
||||
| Note
|
||||
|
||||
|
|
||||
* WhizardTelemetry 数据流水线是 WhizardTelemetry 日志、WhizardTelemetry 事件、WhizardTelemetry 审计、WhizardTelemetry 通知等共同依赖的扩展组件，因此在安装上述几个扩展组件之前必须先安装 WhizardTelemetry 数据流水线扩展组件，否则日志、通知、审计、事件等功能无法正常使用！
|
||||
* The WhizardTelemetry Data Pipeline is a common dependency for WhizardTelemetry Logging, WhizardTelemetry Events, WhizardTelemetry Auditing, WhizardTelemetry Notification, etc., so it must be installed before the above extensions, otherwise, the logging, notification, auditing, and event functions will not work properly!
|
||||
|
||||
* WhizardTelemetry 可观测平台支持从 OpenSearch 查询日志、审计、事件、通知历史等数据，因此需要在 WhizardTelemetry 数据流水线扩展组件里统一配置接收日志、审计、事件、通知历史等数据的 OpenSearch 服务的信息，可以是用户自行搭建的 OpenSearch 服务，也可以是通过 OpenSearch 分布式检索与分析引擎这个扩展组件安装的 OpenSearch 服务。
|
||||
* The WhizardTelemetry Observability Platform supports querying logs, audits, events, notification history, etc., from OpenSearch, so you need to configure the OpenSearch service information for receiving logs, audits, events, notification history, etc., in the WhizardTelemetry Data Pipeline. It can be a user-built OpenSearch service or an OpenSearch service installed by the “OpenSearch Distributed Search and Analytics Engine” extension.
|
||||
|===
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|Note
|
||||
|
||||
|
|
||||
有关组件配置的更多信息，请参阅扩展中心“WhizardTelemetry 数据流水线”扩展组件的详情页说明。
|
||||
For more information about extension configuration, see the details page of the "WhizardTelemetry Data Pipeline" extension in the Extensions Center.
|
||||
|===
|
||||
|
|
@ -1,25 +1,25 @@
|
|||
---
|
||||
title: "配置日志管理"
|
||||
keywords: "Kubernetes, {ks_product}, 日志"
|
||||
description: "介绍如何配置“WhizardTelemetry 日志”扩展组件。"
|
||||
title: "Configure Log Management"
|
||||
keywords: "Kubernetes, {ks_product-en}, logging"
|
||||
description: "This section introduces how to configure the 'WhizardTelemetry Logging' extension."
|
||||
weight: 01
|
||||
---
|
||||
|
||||
WhizardTelemetry 日志支持通过配置扩展组件实现收集指定日志、按项目创建日志索引等功能。
|
||||
WhizardTelemetry Logging supports configuring extensions to collect specified logs and create log indices by project.
|
||||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|Note
|
||||
|
||||
|
|
||||
更多配置信息，请参阅扩展中心 “WhizardTelemetry 日志”扩展组件的详情页说明。
|
||||
For more configuration information, see the details page of the "WhizardTelemetry Logging" extension in the Extensions Center.
|
||||
|===
|
||||
|
||||
== 收集指定日志
|
||||
== Collect Specified Logs
|
||||
|
||||
WhizardTelemetry 日志支持设置过滤条件，以收集包含或排除指定 namespace 的日志，可减少日志数量。
|
||||
WhizardTelemetry Logging supports setting filter conditions to collect logs that include or exclude specified namespaces, which can reduce the number of logs.
|
||||
|
||||
在 WhizardTelemetry 日志的扩展组件配置中，编辑如下参数：
|
||||
Edit the following parameters in the configuration of the WhizardTelemetry Logging extension:
|
||||
|
||||
[,yaml]
|
||||
----
|
||||
|
|
@ -32,22 +32,23 @@ vector-logging:
|
|||
excludeNamespaces: []
|
||||
----
|
||||
|
||||
* extraLabelSelector：只收集带此标签的 pod 的日志。
|
||||
* extraNamespaceLabelSelector：只收集带此标签的 namespace 下的 pod 日志。
|
||||
* includeNamespaces：只收集指定 namespace 下的 pod 日志。
|
||||
* excludeNamespaces：不收集指定 namespace 下的 pod 日志。
|
||||
* extraLabelSelector: Only collect logs from pods with this label.
|
||||
* extraNamespaceLabelSelector: Only collect logs from pods in namespaces with this label.
|
||||
* includeNamespaces: Only collect logs from pods in the specified namespaces.
|
||||
* excludeNamespaces: Do not collect logs from pods in the specified namespaces.
|
||||
|
||||
== 按照 namespace 创建日志索引
|
||||
== Create Log Indices by Namespace
|
||||
|
||||
WhizardTelemetry 日志支持为每个项目（namespace）创建一个索引，既可确定某个 namespace 的日志占用空间，方便整改业务，又便于进行日志分析。
|
||||
WhizardTelemetry Logging supports creating an index for each project (namespace), which can determine the log space occupied by a namespace, facilitate business rectification, and facilitate log analysis.
|
||||
|
||||
=== Prerequisites
|
||||
|
||||
版本要求：WhizardTelemetry 日志 >= 1.2.0，WhizardTelemetry 平台服务 >= 1.1.0。
|
||||
Version requirements:
|
||||
WhizardTelemetry Logging >= 1.2.0, WhizardTelemetry Platform Service >= 1.1.0.
|
||||
|
||||
=== Steps
|
||||
|
||||
. 修改 WhizardTelemetry 日志扩展组件配置。无需修改 prefix 中的参数。
|
||||
. Modify the configuration of the WhizardTelemetry Logging extension. No need to modify the parameters in prefix.
|
||||
+
|
||||
[,yaml]
|
||||
----
|
||||
|
|
@ -59,7 +60,7 @@ vector-logging:
|
|||
timestring: "%Y.%m.%d"
|
||||
----
|
||||
|
||||
. 修改 WhizardTelemetry 平台服务扩展组件配置。无需修改 indexPrefix 中的参数。
|
||||
. Modify the configuration of the WhizardTelemetry Platform Service extension. No need to modify the parameters in indexPrefix.
|
||||
+
|
||||
[,yaml]
|
||||
----
|
||||
|
|
@ -73,4 +74,4 @@ whizard-telemetry:
|
|||
- https://opensearch-cluster-data.kubesphere-logging-system:9200
|
||||
indexPrefix: "{{ .cluster }}-{{ .kubernetes.namespace_name }}-logs"
|
||||
timestring: "%Y.%m.%d"
|
||||
----
|
||||
----
|
||||
|
|
@ -1,52 +1,52 @@
|
|||
---
|
||||
title: "使用容器日志查询工具"
|
||||
keywords: "Kubernetes, {ks_product}, 集群管理, 工具箱, 查询容器日志"
|
||||
description: "介绍如何使用容器日志查询工具。"
|
||||
title: "Use the Container Log Query Tool"
|
||||
keywords: "Kubernetes, {ks_product-en}, cluster management, toolbox, query container logs"
|
||||
description: "This section introduces how to use the container log search tool."
|
||||
weight: 01
|
||||
---
|
||||
|
||||
本节介绍如何查询容器日志。
|
||||
|
||||
容器日志：从容器标准输出获取的日志。容器日志的内容由容器中运行的应用程序决定。
|
||||
This section introduces how to query container logs.
|
||||
|
||||
Container logs: Logs obtained from the container's standard output. The content of container logs is determined by the application running in the container.
|
||||
|
||||
== Prerequisites
|
||||
|
||||
* 您需要获得平台、集群、企业空间或项目的资源查看权限，以查看特定范围的日志。
|
||||
* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**扩展组件。
|
||||
* You should have resource viewing permissions for the platform, cluster, workspace, or project to view logs within a specific scope.
|
||||
|
||||
* **WhizardTelemetry Logging** should have been installed and enabled.
|
||||
|
||||
== Steps
|
||||
|
||||
. 以具有相关资源查看权限的用户登录{ks_product_left} Web 控制台。
|
||||
. Log in to the {ks_product-en} web console with a user who has the resource viewing permissions.
|
||||
|
||||
. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**容器日志查询**。
|
||||
. Hover the cursor over image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] at the bottom right of the page, then select **Container Log Search** from the menu.
|
||||
|
||||
. 在弹出的对话框，设置搜索条件查询日志。
|
||||
. In the pop-up dialog, set the search conditions to query logs.
|
||||
+
|
||||
--
|
||||
* 如果有多个集群，点击**集群**下拉列表可查询特定集群中的日志。
|
||||
* If there are multiple clusters, click the **Cluster** dropdown list to query logs in a specific cluster.
|
||||
|
||||
* 点击搜索框，设置搜索条件，然后按 **Enter** 可查看符合特定条件的日志。您可以同时设置多个搜索条件。
|
||||
* Click the search box, set the search conditions, then press **Enter** to view logs that meet specific conditions. You can set multiple search conditions at the same time.
|
||||
|
||||
* 在查询结果页面可查看日志的时间分布图，点击柱状图，切换到该时间段的日志列表。点击image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18]可开启/停止实时数据刷新，点击**日志导出**下拉列表可选择正序或倒序导出容器日志，点击**刷新频率**的时间可选择数据的刷新频率。
|
||||
* On the query results page, you can view the time distribution chart of the logs. Click the histogram to switch to the log list for that time period. Click image:/images/ks-qkcp/zh/icons/start-dark.svg[start-dark,18,18]/image:/images/ks-qkcp/zh/icons/stop-dark-white.svg[stop-dark-white,18,18] to start/stop real-time data refresh, click the **Log Export** dropdown list to select ascending or descending order to export container logs, click the **Refresh Rate** time to select the data refresh frequency.
|
||||
|
||||
* 在查询结果列表右上角点击image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18]可定制列表中显示的信息。
|
||||
* Click image:/images/ks-qkcp/zh/icons/cogwheel.svg[cogwheel,18,18] in the upper right corner of the query results list to customize the information displayed in the list.
|
||||
|
||||
* 点击查询结果中的日志条目，查看日志的详细信息。
|
||||
* Click on a log entry in the query results to view the detailed information of the log.
|
||||
--
|
||||
|
||||
== 查询 Calico 日志
|
||||
== Query Calico Logs
|
||||
|
||||
“WhizardTelemetry 日志”扩展组件默认收集 Calico 的日志，包含 Calico pod ip 的分配和释放信息，可限定查询条件查询 Calico 日志。
|
||||
The "WhizardTelemetry Logging" extension collects Calico logs by default, including information about the allocation and release of Calico pod IPs. You can set query conditions to query Calico logs.
|
||||
|
||||
. 将光标悬停在页面右下角的image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18]图标，然后在菜单中选择**容器日志查询**。
|
||||
. Hover the cursor over the image:/images/ks-qkcp/zh/icons/hammer.svg[hammer,18,18] icon at the bottom right of the page, then select **Container Log Search** from the menu.
|
||||
|
||||
. 在弹出的对话框，设置搜索条件查询 Calico 日志。
|
||||
. In the pop-up dialog, set the search conditions to query Calico logs.
|
||||
+
|
||||
--
|
||||
namespace: kube-system
|
||||
namespace: `kube-system`
|
||||
|
||||
pod: <node name>
|
||||
pod: `<node name>`
|
||||
|
||||
container: calico-cni
|
||||
--
|
||||
container: `calico-cni`
|
||||
--
|
||||
|
|
@ -1,33 +1,32 @@
|
|||
---
|
||||
title: "启用日志收集"
|
||||
description: "介绍如何修改扩展组件的配置，以启用日志收集功能。"
|
||||
title: "Enable Log Collection"
|
||||
description: "This section introduces how to modify the configuration of the extension to enable the log collection feature."
|
||||
weight: 01
|
||||
---
|
||||
|
||||
本节介绍如何修改“WhizardTelemetry 日志”扩展组件的配置，以启用日志收集功能。
|
||||
This section introduces how to modify the configuration of the "WhizardTelemetry Logging" extension to enable the log collection feature.
|
||||
//note
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|Note
|
||||
|
||||
|
|
||||
启用后，项目左侧导航栏的**项目设置**菜单下将显⽰**日志收集**选项。
|
||||
After enabling, the **Log Collection** option will be displayed under the **Project Settings** menu in the left navigation pane.
|
||||
|===
|
||||
|
||||
|
||||
== Prerequisites
|
||||
|
||||
* 您需要在{ks_product_both}平台具有 **platform-admin** 角色。有关更多信息，请参阅link:../../../../../05-users-and-roles/01-users/[用户]和link:../../../../../05-users-and-roles/02-platform-roles/[平台角色]。
|
||||
* You should have the **platform-admin** role on the {ks_product-en} platform. For more information, see link:../../../../../05-users-and-roles/01-users/[Users] and link:../../../../../05-users-and-roles/02-platform-roles/[Platform Roles].
|
||||
|
||||
* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**扩展组件。
|
||||
* **WhizardTelemetry Logging** should have been installed and enabled.
|
||||
|
||||
== Steps
|
||||
|
||||
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。
|
||||
. 点击**扩展中心**。
|
||||
. 点击已安装的 **WhizardTelemetry 日志**扩展组件，进入组件详情页，点击**管理**。
|
||||
. 点击组件图标下的image:/images/ks-qkcp/zh/icons/more.svg[more,18,18]，选择**扩展组件配置**。
|
||||
. 在扩展组件配置文件中，将 **logsidecar-injector.enabled** 参数设置为 **true**，然后保存文件。
|
||||
. Log in to the {ks_product-en} web console with a user who has the **platform-admin** role.
|
||||
. Click **Extensions Center**.
|
||||
. Click the installed **WhizardTelemetry Logging** extension to enter the details page.
|
||||
. Click image:/images/ks-qkcp/zh/icons/more.svg[more,18,18] under the icon, and select **Extension Config**.
|
||||
. In the extension configuration file, set the `logsidecar-injector.enabled` parameter to `true`, then save the file.
|
||||
+
|
||||
--
|
||||
[,yaml]
|
||||
|
|
@ -38,11 +37,11 @@ logsidecar-injector:
|
|||
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|Note
|
||||
|
||||
|
|
||||
由于控制此参数更新的 job 只会在 host 集群运行，因此如果想仅开启或关闭某些 member 集群的落盘日志收集功能，只设置 member 集群的 logsidecar-injector.enabled 不会生效。每次修改此参数都需要同时修改 host 集群的参数，以此来触发参数更新。
|
||||
Since the job that updates this parameter only runs on the host cluster, setting `logsidecar-injector.enabled` in member clusters will not take effect if you only want to enable or disable the log collection feature for certain member clusters. Each time you modify this parameter, you need to modify the parameter in the host cluster at the same time to trigger the parameter update.
|
||||
|
||||
例如，当需要将某个 member 集群的日志收集功能关闭，只需要在该 member 集群的配置中设置 logsidecar-injector.enabled: false，然后在 host 集群的配置中设置 logsidecar-injector.updateVersion: 1。后续再进行同样操作只需要更新 logsidecar-injector.updateVersion，即可触发更新。
|
||||
For example, when you need to turn off the log collection feature of a certain member cluster, just set `logsidecar-injector.enabled: false` in the configuration of that member cluster, and then add `logsidecar-injector.updateVersion: 1` in the configuration of the host cluster. For subsequent operations, you only need to update `logsidecar-injector.updateVersion` to trigger the update.
|
||||
|===
|
||||
--
|
||||
|
|
@ -1,32 +1,29 @@
|
|||
---
|
||||
title: "在项目中启用日志收集"
|
||||
keywords: "Kubernetes, {ks_product}, 项目管理, 项目设置, 日志收集, 启用日志收集"
|
||||
description: "介绍如何启用日志收集。"
|
||||
title: "Enable Log Collection in a Project"
|
||||
keywords: "Kubernetes, {ks_product-en}, project management, project settings, log collection, enable log collection"
|
||||
description: "This section introduces how to enable log collection."
|
||||
weight: 02
|
||||
---
|
||||
|
||||
:ks_permission: **Project Settings Management**
|
||||
:ks_navigation: **Project Settings > Log Collection**
|
||||
|
||||
:ks_permission: **项目设置管理**
|
||||
:ks_navigation: **项目设置 > 日志收集**
|
||||
|
||||
|
||||
本节介绍如何在项目中启用日志收集。
|
||||
This section introduces how to enable log collection in a project.
|
||||
//note
|
||||
[.admon.note,cols="a"]
|
||||
|===
|
||||
|说明
|
||||
|Note
|
||||
|
||||
|
|
||||
启用后，在项目中创建工作负载和任务时，**存储设置**页签的**收集卷上日志**功能将可用。
|
||||
After enabling, the **Collect Logs on Volumes** feature will be available on the **Storage Settings** tab when creating workloads and Jobs in the project.
|
||||
|===
|
||||
|
||||
|
||||
== Prerequisites
|
||||
|
||||
* {empty}
|
||||
include::../../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[]
|
||||
|
||||
* {ks_product_right}平台需要安装并启用 **WhizardTelemetry 日志**扩展组件，并已link:../01-enable-logsidecar/[启用日志收集]。
|
||||
* **WhizardTelemetry Logging** should have been installed and enabled, and link:../01-enable-logsidecar/[the log collection feature have been enabled].
|
||||
|
||||
== Steps
|
||||
|
||||
|
|
@ -38,17 +35,17 @@ include::../../../../../../_ks_components-en/oper-navigate.adoc[]
|
|||
|
||||
+
|
||||
|
||||
. 在**收集卷上日志**区域，点击切换开关将功能状态设置为**已启用**。
|
||||
. In the **Collect Logs on Volumes** area, click the switch to set the status to **Enabled**.
|
||||
|
||||
// Note
|
||||
include::../../../../../../_ks_components-en/admonitions/note.adoc[]
|
||||
|
||||
ifeval::["{file_output_type}" == "html"]
|
||||
启用日志收集后，您需要重启容器组才能对现有的容器组生效。有关更多信息，请参阅link:../../../../../09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload/[重新创建工作负载]、link:../../../../../09-project-management/03-application-workloads/04-jobs/05-rerun-a-job/[重新运行任务]或link:../../../../../09-project-management/03-application-workloads/06-pods/05-delete-pods/[删除容器组]。
|
||||
After enabling log collection, you need to restart the existing pods to make the change take effect. For more information, see link:../../../../../09-project-management/03-application-workloads/03-workloads/05-re-create-a-workload/[Recreate Workloads], link:../../../../../09-project-management/03-application-workloads/04-jobs/05-rerun-a-job/[Re-run Jobs], or link:../../../../../09-project-management/03-application-workloads/06-pods/05-delete-pods/[Delete Pods].
|
||||
endif::[]
|
||||
|
||||
ifeval::["{file_output_type}" == "pdf"]
|
||||
启用日志收集后，您需要重启容器组才能对现有的容器组生效。有关更多信息，请参阅《{ks_product_right}项目管理指南》的“应用负载”章节，重新创建工作负载、重新运行任务或删除容器组。
|
||||
After enabling log collection, you need to restart the existing pods to make the change take effect. For more information, see the “Application Workloads” chapter of the {ks_product-en} Project Management Guide to recreate a workload, re-run a job, or delete pods.
|
||||
endif::[]
|
||||
|
||||
include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
include::../../../../../../_ks_components-en/admonitions/admonEnd.adoc[]
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue