Add addon observability docs (#166)

* Add addon observability docs

Also added the menu for addons

* add addon command guide

* address comments

* fix display issue and localization

* fix title isue

* address comments
This commit is contained in:
Zheng Xi Zhou 2021-08-19 20:38:27 +08:00 committed by GitHub
parent 00ce8f376e
commit e4ee8355ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 136 additions and 1 deletions

View File

@ -0,0 +1,5 @@
---
title: Observability
---
Working in progress.

View File

@ -150,5 +150,9 @@
"sidebar.docs.category.Cloud Services": {
"message": "云服务",
"description": "The label for category Cloud Services in sidebar docs"
},
"sidebar.docs.category.Addons": {
"message": "插件系统",
"description": "The extended add-ons"
}
}

View File

@ -0,0 +1,121 @@
---
title: 可观测性 Observability
---
可观测性插件Observability addon基于 metrics、logging、tracing 数据,可以为 KubeVela core 提供系统级别的监控,也可以为应用提供业务级别的监控。
下面详细介绍可观测能力,以及如何启用可观测性插件,并查看各种监控数据。
## 可观测能力介绍
KubeVela 可观测能力是通过 [Grafana](https://grafana.com/) 展示的,提供系统级别和应用级别的数据监控。
### 第一种用法KubeVela Core 系统级别可观测性
- KubeVela Core 资源使用情况监控
1CPU、内存等使用量和使用率数据
![](../../resources/observability-system-level-summary-of-source-usages.png)
2CPU、内存随着时间变化如过去三小时的使用量和使用率、已经每秒网络带宽的图形化展示
![](../../resources/observability-system-level-summary-of-source-usages-chart.png)
- 第二种用法KubeVela Core 日志监控
1日志统计
可观测页面会显示KubeVela Core 日志总量,已经默认情况下,`error` 出现的数量、频率、出现的所有日志概览和详情。
![](../../resources/observability-system-level-logging-statistics.png)
还会展示随着时间变化,`error` 日志出现的总量、频率等。
![](../../resources/observability-system-level-logging-statistics2.png)
2日志过滤
在最上方填写关键词,还可以过滤日志。
![](../../resources/observability-system-level-logging-search.png)
## 安装插件
可观测性插件是通过 `vela addon` 命令安装的。因为本插件依赖了 PrometheusPrometheus 依赖 StorageClass
不同 Kubernetes 发行版StorageClass 会有一定的差异,所以,在不同的 Kubernetes 发行版, 安装命令也有一些差异。
### 自建/常规集群
执行如下命令安装可观测性插件KinD 等测试集群的安装步骤同理。
```shell
$ vela addon enable observability alertmanager-pvc-enabled=false server-pvc-enabled=false grafana-domain=example.com
```
### 云服务商提供的 Kubernetes 集群
以阿里云 ACK 为例介绍。
```shell
$ vela addon enable observability alertmanager-pvc-class=alicloud-disk-available alertmanager-pvc-size=20Gi server-pvc-class=alicloud-disk-available server-pvc-size=20Gi grafana-domain=grafana.c276f4dac730c47b8b8988905e3c68fcf.cn-hongkong.alicontainer.com
```
其中,各个参数含义如下:
- alertmanager-pvc-class
Prometheus alert manager 需要的 pvc 的类型,也就是 StorageClass在阿里云上可选的 StorageClass 有:
```shell
$ kubectl get storageclass
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
alicloud-disk-available alicloud/disk Delete Immediate true 6d
alicloud-disk-efficiency alicloud/disk Delete Immediate true 6d
alicloud-disk-essd alicloud/disk Delete Immediate true 6d
alicloud-disk-ssd alicloud/disk Delete Immediate true 6d
```
此处取值 `alicloud-disk-available`
- alertmanager-pvc-size
Prometheus alert manager 需要的 pvc 的大小,在阿里云上,最小的 PV 是 20GB所以此处取值 20Gi。
- server-pvc-class
Prometheus server 需要的 pvc 的类型,同 `alertmanager-pvc-class`
- server-pvc-size
Prometheus server 需要的 pvc 的大小,同 `alertmanager-pvc-size`
- grafana-domain
Grafana 的域名,可以使用您自定义的域名,也可以使用 ACK 提供的集群级别的泛域名,`*.c276f4dac730c47b8b8988905e3c68fcf.cn-hongkong.alicontainer.com`
如本处取值 `grafana.c276f4dac730c47b8b8988905e3c68fcf.cn-hongkong.alicontainer.com`
对于其他云服务商提供的,请参考上面示例配置。
## 查看监控数据
### 自建/常规集群
```shell
$ kubectl get svc grafana -n observability
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
grafana ClusterIP 192.168.42.243 <none> 80/TCP 177m
$ sudo k port-forward service/grafana -n observability 80:80
Password:
Forwarding from 127.0.0.1:80 -> 3000
Forwarding from [::1]:80 -> 3000
```
通过浏览器访问 [http://127.0.0.1/dashboards](http://127.0.0.1/dashboards),点击相应的 Dashboard ,查看前面介绍的各种监控数据。
![](../../resources/observability-system-level-dashboards.png)
### 云服务商提供的 Kubernetes 集群
直接访问上面设置的 grafana domain如 [http://grafana.c276f4dac730c47b8b8988905e3c68fcf.cn-hongkong.alicontainer.com/](http://grafana.c276f4dac730c47b8b8988905e3c68fcf.cn-hongkong.alicontainer.com/) ,查看前面介绍的各种监控数据。

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 874 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 249 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 253 KiB

View File

@ -78,7 +78,12 @@ module.exports = {
},
{
'Policies': [
'end-user/policies/envbinding'
'end-user/policies/envbinding',
]
},
{
'Addons': [
'end-user/addons/observability',
]
},
{