Logging translation updated.

Signed-off-by: Felixnoo <felixliu@yunify.com>
This commit is contained in:
Felixnoo 2020-12-18 16:21:52 +08:00
parent 03013d4bdc
commit adfc2d61bf
4 changed files with 101 additions and 117 deletions

View File

@ -1,6 +1,6 @@
---
title: "KubeSphere 日志系统"
keywords: "Kubernetes, Elasticsearch, KubeSphere, Logging, logs"
keywords: "Kubernetes, Elasticsearch, KubeSphere, 日志系统, 日志"
description: "如何启用 KubeSphere 日志系统"
linkTitle: "KubeSphere 日志系统"
@ -9,162 +9,146 @@ weight: 6400
## 什么是 KubeSphere 日志系统
KubeSphere 为日志收集、查询和管理提供了一个强大的、整体的、易于使用的日志系统。它涵盖了不同层次的日志,包括租户、基础设施资源和应用。用户可以从项目、工作量、Pod 和关键字等不同维度对日志进行搜索。与 Kibana 相比KubeSphere 基于租户的日志系统具有更好的隔离性和租户之间的安全性,因为每个租户只能查看自己的日志。除了 KubeSphere 自身的日志系统,容器平台还允许用户添加第三方日志收集器,如 Elasticsearch、Kafka 和 Fluentd。
KubeSphere 为日志收集、查询和管理提供了一个强大的、整体的、易于使用的日志系统。它涵盖了不同层级的日志,包括租户、基础设施资源和应用。用户可以从项目、工作负载、Pod 和关键字等不同维度对日志进行搜索。与 Kibana 相比KubeSphere 基于租户的日志系统中,每个租户只能查看自己的日志,从而可以在租户之间提供更好的隔离性和安全性。除了 KubeSphere 自身的日志系统,容器平台还允许用户添加第三方日志收集器,如 Elasticsearch、Kafka 和 Fluentd。
有关更多信息,请参阅日志、事件和审计系统
有关更多信息,请参见[日志查询](../../toolbox/log-query/)
## 在安装前启用日志系统
### 在 Linux 上安装
当您在 Linux 上安装 KubeSphere 时,需要创建一个配置文件,该文件列出了所有 KubeSphere 组件。
当您在 Linux 上安装 KubeSphere 时,首先需要创建一个配置文件,该文件列出了所有 KubeSphere 组件。
1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程,您创建了一个默认文件 **config-sample.yaml**。通过执行以下命令修改该文件:
1. 基于[在 Linux 上安装 KubeSphere](.../.../installing-on-linux/introduction/multioverview/) 的教程,您需要创建一个默认文件 `config-sample.yaml`。通过执行以下命令修改该文件:
```bash
vi config-sample.yaml
```
```bash
vi config-sample.yaml
```
{{< notice note >}}
{{< notice note >}}
如果您采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/),则不需要创建 `config-sample.yaml` 文件因为可以直接创建集群。一般来说All-in-one 模式是为那些刚接触 KubeSphere 并希望熟悉系统的用户而准备的。如果您想在这个模式下启用日志系统(比如用于测试),请参考[下面的部分](#在安装后启用日志系统),查看如何在安装后启用日志系统。
{{</ notice >}}
如果采用 [All-in-one 安装](.../.../quick-start/all-in-one-on-linux/),则不需要创建 `config-sample.yaml` 文件因为可以直接创建集群。一般来说All-in-one 模式是为那些刚刚接触 KubeSphere 并希望熟悉系统的用户准备的。如果您想在这个模式下启用日志系统(比如出于测试的目的),可以参考下面的部分,看看安装后如何启用日志系统。
{{</ notice >}}
{{< notice warning >}}
如果你采用[多节点安装](.../.../install-on-linux/introduction/multioverview/),并且使用符号链接作为 Docker 根目录,请确保所有节点遵循完全相同的符号链接。日志代理在 DaemonSet 中部署到节点上。容器日志路径的任何差异都可能导致该节点的收集失败。
{{</ notice >}}
{{< notice warning >}}
如果您采用[多节点安装](.../.../install-on-linux/introduction/multioverview/),并且使用符号链接作为 Docker 根目录,请确保所有节点遵循完全相同的符号链接。日志代理在守护进程集中部署到节点上。容器日志路径的任何差异都可能导致该节点的收集失败。
{{</ notice >}}
2. 在该文件中,搜寻到 `logging`,并将 `enabled``false` 改为 `true`。完成后保存文件。
```bash
logging:
enabled: true # Change "false" to "true"
```
```yaml
logging:
enabled: true # Change "false" to "true"
```
{{< notice note >}}
{{< notice note >}}
默认情况下如果启用了日志系统KubeKey 将在内部安装 Elasticsearch。对于生产环境如果您想启用日志系统强烈建议在 `config-sample.yaml` 中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。在安装前提供以下信息后KubeKey 将直接整合您的外部 Elasticsearch不再安装内部 Elasticsearch。
{{</ notice >}}
默认情况下如果启用了审计功能KubeKey 将在内部安装 Elasticsearch。对于生产环境如果你想启用日志系统强烈建议你在 **config-sample.yaml** 中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。一旦你在安装前提供以下信息KubeKey 将直接整合你的外部 Elasticsearch而不是安装一个内部 Elasticsearch。
{{</ notice >}}
```bash
es: # Storage backend for logging, tracing, events and auditing.
elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number
elasticsearchDataReplicas: 1 # total number of data nodes
elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes
elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes
logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default.
elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
externalElasticsearchUrl: # The URL of external Elasticsearch
externalElasticsearchPort: # The port of external Elasticsearch
```
```yaml
es: # Storage backend for logging, tracing, events and auditing.
elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number
elasticsearchDataReplicas: 1 # total number of data nodes
elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes
elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes
logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default.
elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
externalElasticsearchUrl: # The URL of external Elasticsearch
externalElasticsearchPort: # The port of external Elasticsearch
```
3. 使用配置文件创建一个集群:
```bash
./kk create cluster -f config-sample.yaml
```
```bash
./kk create cluster -f config-sample.yaml
```
### 在 Kubernetes 上安装
在 Kubernetes 上安装 KubeSphere 时,需要下载文件 [cluster-configuration.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/cluster-configuration.yaml) 进行集群设置。如果要安装日志系统,不要直接使用 `kubectl apply -f` 对这个文件进行设置
[在 Kubernetes 上安装 KubeSphere](../../installing-on-kubernetes/introduction/overview/) 的教程中说明了在 Kubernetes 上安装 KubeSphere 的流程,不过,需要事先在 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中启用日志系统(可选服务组件)
1. 参照[在 Kubernetes 上安装 KubeSphere](.../.../installing-on-kubernetes/introduction/overview/) 的教程,先对文件 [kubesphere-installer.yaml](https://raw.githubusercontent.com/kubesphere/ks-installer/master/deploy/kubesphere-installer.yaml) 执行 `kubectl apply -f`。之后,为了启用日志,创建一个本地文件 `cluster-configuration.yaml`
1. 下载 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件,然后打开并开始编辑
```bash
vi cluster-configuration.yaml
```
```bash
vi cluster-configuration.yaml
```
2. 将 [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/cluster-configuration.yaml) 文件中的所有内容复制到刚才创建的本地文件中。
3. 在这个本地 `cluster-configuration.yaml` 文件中,搜寻到 `logging`,并将 `enabled``false` 改为 `true`,启用它们。完成后保存文件。
2. 在该本地 `cluster-configuration.yaml` 文件中,搜寻到 `logging`,并将 `enabled``false` 改为 `true`,以启用日志系统。完成后保存文件。
```bash
logging:
enabled: true # Change "false" to "true"
```
```yaml
logging:
enabled: true # Change "false" to "true"
```
{{< notice note >}}
{{< notice note >}}
默认情况下如果启用了日志系统KubeKey 将在内部安装 Elasticsearch。对于生产环境如果您想启用日志系统强烈建议在 `config-sample.yaml` 中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。在安装前提供以下信息后KubeKey 将直接整合您的外部 Elasticsearch不再安装内部 Elasticsearch。
{{</ notice >}}
默认情况下如果启用了日志功能ks-installer 会在内部安装 Elasticsearch。对于生产环境如果你想启用日志系统强烈建议你在 **cluster-configuration.yaml** 中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。当你在安装前提供以下信息时ks-installer 将直接整合你的外部 Elasticsearch而不是安装内部 Elasticsearch。
```yaml
es: # Storage backend for logging, tracing, events and auditing.
elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number
elasticsearchDataReplicas: 1 # total number of data nodes
elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes
elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes
logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default.
elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
externalElasticsearchUrl: # The URL of external Elasticsearch
externalElasticsearchPort: # The port of external Elasticsearch
```
{{</ notice >}}
3. 执行以下命令开始安装:
```bash
es: # Storage backend for logging, tracing, events and auditing.
elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number
elasticsearchDataReplicas: 1 # total number of data nodes
elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes
elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes
logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default.
elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
externalElasticsearchUrl: # The URL of external Elasticsearch
externalElasticsearchPort: # The port of external Elasticsearch
```
```bash
kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.0.0/kubesphere-installer.yaml
4. 执行以下命令开始安装:
kubectl apply -f cluster-configuration.yaml
```
```bash
kubectl apply -f cluster-configuration.yaml
```
## 在安装后启用事件
## 在安装后启用日志系统
1. 以 `admin` 身份登录控制台。点击左上角的**平台管理**,选择**集群管理**。
![集群管理](/images/docs/zh-cn/enable-pluggable-components/kubesphere-logging-system/clusters-management.png)
![集群管理](https://ap3.qingstor.com/kubesphere-website/docs/20200828111130.png)
2. 点击**自定义资源 CRD**,在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。
2. 点击 **自定义资源 CRD**,在搜索栏中输入 `clusterconfiguration`。点击结果查看其详细页面。
{{< notice info >}}
自定义资源定义CRD允许用户在不增加额外 API 服务器的情况下创建一种新的资源类型,用户可以像使用其他 Kubernetes 原生对象一样使用这些自定义资源。
{{</ notice >}}
{{< notice info >}}
3. 在**资源列表**中,点击 `ks-installer` 右边的三个点,选择**编辑配置文件**。
![编辑 yaml](/images/docs/zh-cn/enable-pluggable-components/kubesphere-logging-system/edit-yaml.PNG)
自定义资源定义CRD允许用户在不增加另一个 API 服务器的情况下创建一种新的资源类型。他们可以像其他任何本地 Kubernetes 对象一样使用这些资源
4. 在该 YAML 文件中,搜寻到 `logging`,将 `enabled``false` 改为 `true`。完成后,点击右下角的**更新**,保存配置
{{</ notice >}}
```yaml
logging:
enabled: true # Change "false" to "true"
```
3. 在**资源列表**中,点击 `ks-installer` 右边的三个点,选择**编辑 YAML**。
{{< notice note >}}
默认情况下如果启用了日志系统KubeKey 将在内部安装 Elasticsearch。对于生产环境如果您想启用日志系统强烈建议在该 YAML 文件中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。在安装前提供以下信息后KubeKey 将直接整合您的外部 Elasticsearch不再安装内部 Elasticsearch。
{{</ notice >}}
![编辑 YAML](https://ap3.qingstor.com/kubesphere-website/docs/20200827182002.png)
```yaml
es: # Storage backend for logging, tracing, events and auditing.
elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number
elasticsearchDataReplicas: 1 # total number of data nodes
elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes
elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes
logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default.
elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
externalElasticsearchUrl: # The URL of external Elasticsearch
externalElasticsearchPort: # The port of external Elasticsearch
```
4. 在这个 YAML 文件中,搜寻到 `logging`,将 `enabled``false` 改为 `true`。完成后,点击右下角的**更新**,保存配置。
5. 您可以使用 Web Kubectl 工具执行以下命令来检查安装过程:
```bash
logging:
enabled: true # Change "false" to "true"
```
```bash
kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f
```
{{< notice note >}}
默认情况下如果启用了日志系统Elasticsearch 将在内部安装。对于生产环境,如果你想启用日志,强烈建议你在这个 YAML 文件中设置以下值,尤其是 `externalElasticsearchUrl``externalElasticsearchPort`。一旦你提供了以下信息KubeSphere 将直接整合你的外部 Elasticsearch而不是安装一个内部 Elasticsearch。
{{</ notice >}}
```bash
es: # Storage backend for logging, tracing, events and auditing.
elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number
elasticsearchDataReplicas: 1 # total number of data nodes
elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes
elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes
logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default.
elkPrefix: logstash # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log
externalElasticsearchUrl: # The URL of external Elasticsearch
externalElasticsearchPort: # The port of external Elasticsearch
```
5. 您可以通过执行以下命令,使用 Web Kubectl 工具来检查安装过程:
```bash
kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f
```
{{< notice tip >}}
您可以通过点击控制台右下角的锤子图标找到 Kubectl 工具。
{{</ notice >}}
{{< notice tip >}}
您可以通过点击控制台右下角的锤子图标找到 Web Kubectl 工具。
{{</ notice >}}
## 验证组件的安装
@ -172,9 +156,9 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=
{{< tab "在仪表板中验证组件的安装" >}}
进入**服务组件**,检查 Logging 的状态。你可能会看到如下图片:
进入**服务组件**,检查 **Logging** 的状态,可以看到如下类似图片:
![logging](https://ap3.qingstor.com/kubesphere-website/docs/20200829104152.png)
![日志系统](/images/docs/zh-cn/enable-pluggable-components/kubesphere-logging-system/logging.PNG)
{{</ tab >}}
@ -186,7 +170,7 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=
kubectl get pod -n kubesphere-logging-system
```
如果组件运行成功,输出结果可能如下:
如果组件运行成功,输出结果如下:
```bash
NAME READY STATUS RESTARTS AGE

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB