Feat: refine o11y docs

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
Jianbo Sun 2022-11-03 16:25:27 +08:00
parent d967e663a9
commit 904abd8470
32 changed files with 144 additions and 56 deletions

View File

@ -1,5 +1,5 @@
---
title: Dashboard
title: Customize Dashboard
---
In KubeVela, leveraging the power of Kubernetes Aggregated API layer, it is easy for users to manipulate dashboards on Grafana and make customizations to application visualizations.

View File

@ -1,5 +1,5 @@
---
title: Installation
title: Enable O11y Addons
---
:::tip

View File

@ -1,5 +1,5 @@
---
title: Integration
title: Integration O11y Service
---
Sometimes, you might already have Prometheus & Grafana instances. They might be built by other tools, or come from cloud providers. Follow the below guide to integrate with existing systems.

View File

@ -1,5 +1,5 @@
---
title: Logging
title: Log Collection
---
The application logs are very important for users to find and locate problems especially in production environment.

View File

@ -1,5 +1,5 @@
---
title: Metrics
title: Metrics Collection
---
## Exposing Metrics in your Application

View File

@ -1,5 +1,5 @@
---
title: Out of the Box
title: Out-of-Box Dashboards
---
By default, a series of dashboards are pre-installed with the `grafana` addon and provide basic panels for viewing observability data. If you follow the [installation guide](./installation), you should be able to use these dashboards without further configurations.

View File

@ -2,9 +2,13 @@
title: Automated Observability
---
Observability is critical for infrastructures and applications. Without observability system, it is hard to identify what happens when system broke down. On contrary, a strong observabilty system can not only provide confidences for operators but can also help developers quickly locate the performance bottleneck or the weak points inside the whole system.
Observability is critical for infrastructures and applications. Without observability system, it is hard to identify what happens when system broke down. On contrary, a strong observability system can not only provide confidences for operators but can also help developers quickly locate the performance bottleneck or the weak points inside the whole system.
To help users build their own observability system from scratch, KubeVela provides a list of addons, including
KubeVela has made the observability as first class citizen, it includes the following three aspects.
## Build observability infrastructure automatically
To help users build their own observability system from scratch with just one click, KubeVela provides a list of addons, including
**Metrics**
- `prometheus-server`: A server records metrics in time series with flexible queries supported.
@ -17,18 +21,36 @@ To help users build their own observability system from scratch, KubeVela provid
**Dashboard**
- `grafana`: A web application that provides analytics and interactive visualizations.
After these addons enabled, out-of-box dashboard will be generated with real time data collecting.
> More addons for alerting & tracing will be introduced in later versions.
## Application Observability
OAM, as a unified application model, can adopt observability easily as operational traits. As a result, KubeVela also provides several traits for application observability. Once end users added these traits in their app, the data will be collected, delivered and finally shown on the grafana dashboard.
![app-o11y](../../resources/app-o11y.png)
More than that, you can easily define your own observability traits with CUE.
## Observability as Code
The ability of KubeVela to support the application observability is all completed through the IaC (Infrastructure as Code) method, which also means that **KubeVela has glued from the collection of indicators (including logs), analysis, enrichment, storage, data source registration, all the way to visualization by using IaC**.
Based on the IaC system powered by CUE, KubeVela has encapsulated common functions such as creating data sources, creating large disks, and importing large disks. You can use them directly without learning the details. If you want to do some customization, you can also orchestrate your process in a similar way through CUE, and customize the observability for your platform.
In the following documents, we will expand the above in detail one by one.
## What's Next
- [**Installation**](./o11y/installation): Guide for how to install observability addons in your KubeVela system.
- [**Installation of Observability Addons**](./o11y/installation): Guide for how to install observability addons in your KubeVela system.
- [**Out of the Box**](./o11y/out-of-the-box): Guide for how to use pre-installed dashboards to monitor your system and applications.
- [**Out-of-Box Observability**](./o11y/out-of-the-box): Guide for how to use pre-installed dashboards to monitor your system and applications.
- [**Metrics**](./o11y/metrics): Guide for customizing the process of collecting metrics for your application.
- [**Customize Metrics**](./o11y/metrics): Guide for customizing the process of collecting metrics for your application.
- [**Logging**](./o11y/logging): Guide for how to customize the log collecting rules for your application.
- [**Customize Logging**](./o11y/logging): Guide for how to customize the log collecting rules for your application.
- [**Dashboard**](./o11y/dashboard): Guide for creating your customized dashboards for applications.
- [**Customize Dashboard**](./o11y/dashboard): Guide for creating your customized dashboards for applications.
- [**Integration**](./o11y/integration): Guide for integrating your existing infrastructure to KubeVela, when you already have Prometheus or Grafana before installing addons.
- [**Integrate Existing Observability Service**](./o11y/integration): Guide for integrating your existing infrastructure to KubeVela, when you already have Prometheus or Grafana before installing addons.

BIN
docs/resources/app-o11y.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

View File

@ -1,5 +1,5 @@
---
title: 监控大盘
title: 自定义监控大盘
---
在 KubeVela 中,借助 Kubernetes 原生的 Aggregated API LayerKubeVela 用户可以比较轻易地在集群中操作修改 Grafana 上的监控大盘。

View File

@ -1,5 +1,5 @@
---
title: 安装
title: 安装可观测性插件
---
:::tip

View File

@ -1,5 +1,5 @@
---
title: 外部系统集成
title: 外部可观测服务集成
---
有时,你可能已经拥有 Prometheus 和 Grafana 实例。 它们可能由其他工具构建,或者来自云提供商。 按照以下指南与现有系统集成。

View File

@ -1,5 +1,5 @@
---
title: 日志
title: 自定义日志采集
---
应用日志对于发现和排查线上问题至关重要KubeVela 提供了专门的日志收集插件,帮助用户快速地构建应用的日志可观测的能力。本文档将介绍如何对应用日志进行采集,并在 grafana 大盘中对日志进行查看和分析。

View File

@ -1,5 +1,5 @@
---
title: 指标
title: 自定义指标采集
---
## 采集应用指标

View File

@ -1,5 +1,5 @@
---
title: 开箱即用
title: 开箱即用的可观测
---
## 监控大盘

View File

@ -4,7 +4,11 @@ title: 自动化可观测性
可观测性对于基础架构和应用程序至关重要。 如果没有可观测性系统,就很难确定系统崩溃时发生了什么。 相反,强大的可观测性系统不仅可以为使用者提供信心,还可以帮助开发人员快速定位整个系统内部的性能瓶颈或薄弱环节。
为了帮助用户构建自己的可观测性系统KubeVela 提供了一些插件,包括:
可观测性是 KubeVela 体系的一等公民,它包括如下三个方面。
## 自动化构建可观测性基础设施
为了帮助用户构建自己的可观测性系统KubeVela 提供了开箱即用可观测性插件,包括:
**指标**
- `prometheus-server`: 以时间序列来记录指标的服务,支持灵活的查询。
@ -17,18 +21,36 @@ title: 自动化可观测性
**监控大盘**
- `grafana`: 提供分析和交互式可视化的 Web 应用程序。
以后的版本中将引入更多用于 alerting 和 tracing 的插件。
当这些插件启动后,就会出现开箱即用的可观测性大盘,展示实时的系统状态。
> 以后的版本中将引入更多用于 alerting 和 tracing 的插件。
## 应用级可观测
KubeVela 的一大特点就是通过一个顶层应用描述YAML来驱动完整的应用交付可观测性能力自然也不例外。对于应用而言其使用体验就是选用日志或者指标对应的运维特征KubeVela 控制器便会自动为其生成对应的监控大盘。
![app-o11y](../../resources/app-o11y.png)
不仅如此,基于 KubeVela 的扩展体系,你也可以为你的平台自定义可观测运维特征。
## 可观测性即代码
KubeVela 支撑应用可观测底层的能力全部通过 IaC Infrastructure as Code的方式完成这也意味着 **KubeVela 打通了从指标(含日志)采集、解析、富化、存储、数据源注册,一直到大盘可视化全链路的 IaC 化**
KubeVela 已经基于这一套 IaC 体系封装了创建数据源、创建大盘、导入大盘等通用的功能,你无需学习其中的细节便可以直接使用。如果你想要做一些自定义,也完全可以类似的通过 IaC 的方式编排你的流程,为你的平台自定义可观测能力。
接下来的文档中,我们将逐一详细展开上述功能。
## 进阶指南
- [**安装**](./o11y/installation): 关于如何在 KubeVela 系统中部署可观测性基础设施。
- [**安装可观测性基础设施**](./o11y/installation): 关于如何在 KubeVela 系统中部署可观测性基础设施。
- [**开箱即用**](./o11y/out-of-the-box): 关于 KubeVela 可观测性基础设施中默认可用的系统及应用监控能力。
- [**开箱即用的可观测大盘**](./o11y/out-of-the-box): 关于 KubeVela 可观测性基础设施中默认可用的系统及应用监控能力。
- [**指标**](./o11y/metrics): 关于如何为你的应用自定义指标采集过程的指南。
- [**自定义指标采集**](./o11y/metrics): 关于如何为你的应用自定义指标采集过程的指南。
- [**日志**](./o11y/logging): 关于如何为你的应用定制日志采集规则的指南。
- [**自定义日志采集**](./o11y/logging): 关于如何为你的应用定制日志采集规则的指南。
- [**监控大盘**](./o11y/dashboard): 关于如何为你的应用配置自定义监控大盘的指南。
- [**自定义监控大盘**](./o11y/dashboard): 关于如何为你的应用配置自定义监控大盘的指南。
- [**外部集成**](./o11y/integration): 关于如何将已有的监控体系集成进 KubeVela 的指南,如果你的系统中已经存在了 Prometheus 或者 Grafana 服务(如自建或云厂商提供),可以阅读该文档了解集成方法。
- [**集成外部的可观测性服务**](./o11y/integration): 关于如何将已有的监控体系集成进 KubeVela 的指南,如果你的系统中已经存在了 Prometheus 或者 Grafana 服务(如自建或云厂商提供),可以阅读该文档了解集成方法。

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

View File

@ -1,5 +1,5 @@
---
title: 监控大盘
title: 自定义监控大盘
---
在 KubeVela 中,借助 Kubernetes 原生的 Aggregated API LayerKubeVela 用户可以比较轻易地在集群中操作修改 Grafana 上的监控大盘。

View File

@ -1,5 +1,5 @@
---
title: 安装
title: 安装可观测性插件
---
:::tip

View File

@ -1,5 +1,5 @@
---
title: 外部系统集成
title: 外部可观测服务集成
---
有时,你可能已经拥有 Prometheus 和 Grafana 实例。 它们可能由其他工具构建,或者来自云提供商。 按照以下指南与现有系统集成。

View File

@ -1,5 +1,5 @@
---
title: 日志
title: 自定义日志采集
---
应用日志对于发现和排查线上问题至关重要KubeVela 提供了专门的日志收集插件,帮助用户快速地构建应用的日志可观测的能力。本文档将介绍如何对应用日志进行采集,并在 grafana 大盘中对日志进行查看和分析。

View File

@ -1,5 +1,5 @@
---
title: 指标
title: 自定义指标采集
---
## 采集应用指标

View File

@ -1,5 +1,5 @@
---
title: 开箱即用
title: 开箱即用的可观测
---
## 监控大盘

View File

@ -4,7 +4,11 @@ title: 自动化可观测性
可观测性对于基础架构和应用程序至关重要。 如果没有可观测性系统,就很难确定系统崩溃时发生了什么。 相反,强大的可观测性系统不仅可以为使用者提供信心,还可以帮助开发人员快速定位整个系统内部的性能瓶颈或薄弱环节。
为了帮助用户构建自己的可观测性系统KubeVela 提供了一些插件,包括:
可观测性是 KubeVela 体系的一等公民,它包括如下三个方面。
## 自动化构建可观测性基础设施
为了帮助用户构建自己的可观测性系统KubeVela 提供了开箱即用可观测性插件,包括:
**指标**
- `prometheus-server`: 以时间序列来记录指标的服务,支持灵活的查询。
@ -17,18 +21,36 @@ title: 自动化可观测性
**监控大盘**
- `grafana`: 提供分析和交互式可视化的 Web 应用程序。
以后的版本中将引入更多用于 alerting 和 tracing 的插件。
当这些插件启动后,就会出现开箱即用的可观测性大盘,展示实时的系统状态。
> 以后的版本中将引入更多用于 alerting 和 tracing 的插件。
## 应用级可观测
KubeVela 的一大特点就是通过一个顶层应用描述YAML来驱动完整的应用交付可观测性能力自然也不例外。对于应用而言其使用体验就是选用日志或者指标对应的运维特征KubeVela 控制器便会自动为其生成对应的监控大盘。
![app-o11y](../../resources/app-o11y.png)
不仅如此,基于 KubeVela 的扩展体系,你也可以为你的平台自定义可观测运维特征。
## 可观测性即代码
KubeVela 支撑应用可观测底层的能力全部通过 IaC Infrastructure as Code的方式完成这也意味着 **KubeVela 打通了从指标(含日志)采集、解析、富化、存储、数据源注册,一直到大盘可视化全链路的 IaC 化**
KubeVela 已经基于这一套 IaC 体系封装了创建数据源、创建大盘、导入大盘等通用的功能,你无需学习其中的细节便可以直接使用。如果你想要做一些自定义,也完全可以类似的通过 IaC 的方式编排你的流程,为你的平台自定义可观测能力。
接下来的文档中,我们将逐一详细展开上述功能。
## 进阶指南
- [**安装**](./o11y/installation): 关于如何在 KubeVela 系统中部署可观测性基础设施。
- [**安装可观测性基础设施**](./o11y/installation): 关于如何在 KubeVela 系统中部署可观测性基础设施。
- [**开箱即用**](./o11y/out-of-the-box): 关于 KubeVela 可观测性基础设施中默认可用的系统及应用监控能力。
- [**开箱即用的可观测大盘**](./o11y/out-of-the-box): 关于 KubeVela 可观测性基础设施中默认可用的系统及应用监控能力。
- [**指标**](./o11y/metrics): 关于如何为你的应用自定义指标采集过程的指南。
- [**自定义指标采集**](./o11y/metrics): 关于如何为你的应用自定义指标采集过程的指南。
- [**日志**](./o11y/logging): 关于如何为你的应用定制日志采集规则的指南。
- [**自定义日志采集**](./o11y/logging): 关于如何为你的应用定制日志采集规则的指南。
- [**监控大盘**](./o11y/dashboard): 关于如何为你的应用配置自定义监控大盘的指南。
- [**自定义监控大盘**](./o11y/dashboard): 关于如何为你的应用配置自定义监控大盘的指南。
- [**外部集成**](./o11y/integration): 关于如何将已有的监控体系集成进 KubeVela 的指南,如果你的系统中已经存在了 Prometheus 或者 Grafana 服务(如自建或云厂商提供),可以阅读该文档了解集成方法。
- [**集成外部的可观测性服务**](./o11y/integration): 关于如何将已有的监控体系集成进 KubeVela 的指南,如果你的系统中已经存在了 Prometheus 或者 Grafana 服务(如自建或云厂商提供),可以阅读该文档了解集成方法。

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

View File

@ -1,5 +1,5 @@
---
title: Dashboard
title: Customize Dashboard
---
In KubeVela, leveraging the power of Kubernetes Aggregated API layer, it is easy for users to manipulate dashboards on Grafana and make customizations to application visualizations.

View File

@ -1,5 +1,5 @@
---
title: Installation
title: Enable O11y Addons
---
:::tip

View File

@ -1,5 +1,5 @@
---
title: Integration
title: Integration O11y Service
---
Sometimes, you might already have Prometheus & Grafana instances. They might be built by other tools, or come from cloud providers. Follow the below guide to integrate with existing systems.

View File

@ -1,5 +1,5 @@
---
title: Logging
title: Log Collection
---
The application logs are very important for users to find and locate problems especially in production environment.

View File

@ -1,5 +1,5 @@
---
title: Metrics
title: Metrics Collection
---
## Exposing Metrics in your Application

View File

@ -1,5 +1,5 @@
---
title: Out of the Box
title: Out-of-Box Dashboards
---
By default, a series of dashboards are pre-installed with the `grafana` addon and provide basic panels for viewing observability data. If you follow the [installation guide](./installation), you should be able to use these dashboards without further configurations.

View File

@ -2,9 +2,13 @@
title: Automated Observability
---
Observability is critical for infrastructures and applications. Without observability system, it is hard to identify what happens when system broke down. On contrary, a strong observabilty system can not only provide confidences for operators but can also help developers quickly locate the performance bottleneck or the weak points inside the whole system.
Observability is critical for infrastructures and applications. Without observability system, it is hard to identify what happens when system broke down. On contrary, a strong observability system can not only provide confidences for operators but can also help developers quickly locate the performance bottleneck or the weak points inside the whole system.
To help users build their own observability system from scratch, KubeVela provides a list of addons, including
KubeVela has made the observability as first class citizen, it includes the following three aspects.
## Build observability infrastructure automatically
To help users build their own observability system from scratch with just one click, KubeVela provides a list of addons, including
**Metrics**
- `prometheus-server`: A server records metrics in time series with flexible queries supported.
@ -17,18 +21,36 @@ To help users build their own observability system from scratch, KubeVela provid
**Dashboard**
- `grafana`: A web application that provides analytics and interactive visualizations.
After these addons enabled, out-of-box dashboard will be generated with real time data collecting.
> More addons for alerting & tracing will be introduced in later versions.
## Application Observability
OAM, as a unified application model, can adopt observability easily as operational traits. As a result, KubeVela also provides several traits for application observability. Once end users added these traits in their app, the data will be collected, delivered and finally shown on the grafana dashboard.
![app-o11y](../../resources/app-o11y.png)
More than that, you can easily define your own observability traits with CUE.
## Observability as Code
The ability of KubeVela to support the application observability is all completed through the IaC (Infrastructure as Code) method, which also means that **KubeVela has glued from the collection of indicators (including logs), analysis, enrichment, storage, data source registration, all the way to visualization by using IaC**.
Based on the IaC system powered by CUE, KubeVela has encapsulated common functions such as creating data sources, creating large disks, and importing large disks. You can use them directly without learning the details. If you want to do some customization, you can also orchestrate your process in a similar way through CUE, and customize the observability for your platform.
In the following documents, we will expand the above in detail one by one.
## What's Next
- [**Installation**](./o11y/installation): Guide for how to install observability addons in your KubeVela system.
- [**Installation of Observability Addons**](./o11y/installation): Guide for how to install observability addons in your KubeVela system.
- [**Out of the Box**](./o11y/out-of-the-box): Guide for how to use pre-installed dashboards to monitor your system and applications.
- [**Out-of-Box Observability**](./o11y/out-of-the-box): Guide for how to use pre-installed dashboards to monitor your system and applications.
- [**Metrics**](./o11y/metrics): Guide for customizing the process of collecting metrics for your application.
- [**Customize Metrics**](./o11y/metrics): Guide for customizing the process of collecting metrics for your application.
- [**Logging**](./o11y/logging): Guide for how to customize the log collecting rules for your application.
- [**Customize Logging**](./o11y/logging): Guide for how to customize the log collecting rules for your application.
- [**Dashboard**](./o11y/dashboard): Guide for creating your customized dashboards for applications.
- [**Customize Dashboard**](./o11y/dashboard): Guide for creating your customized dashboards for applications.
- [**Integration**](./o11y/integration): Guide for integrating your existing infrastructure to KubeVela, when you already have Prometheus or Grafana before installing addons.
- [**Integrate Existing Observability Service**](./o11y/integration): Guide for integrating your existing infrastructure to KubeVela, when you already have Prometheus or Grafana before installing addons.

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB