文档

- 重新组织文档结构docs(datas，按数据类型分类 - ource): 更新指标数据源增加指标数据源的详细文档 - 重新组织文档结构说明，包括接口定义、基本信息、，按数据类型分类 - 添加元数据和查询功能 - 添加指标数据源的详细说明，包括新的文档图片，展示指标数据源接口定义、基本信息、元数据和的相关功能 - 简要查询功能 - 新增事件数据介绍事件和日志数据源的源的简介 - 更新日志接口定义和链路数据源的说明
aide-family · Dec 17, 2024 · a9f554e · a9f554e
1 parent 2b6a891
commit a9f554e
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 22 deletions.
diff --git a/docs/2-feature/1-datasource.md b/docs/2-feature/1-datasource.md
@@ -6,46 +6,95 @@ sidebar_position: 1
 
 系统定义了四种数据类型：日志、指标、事件、 链路。 每种数据类型可以有多种数据存储器。 以这种形式，可以轻松实现数据类型的统一查询、分析、告警、可视化等。
 
-## 类型
+## 指标（Metric）
 
-### 日志（Log）
+实现统一的指标查询接口，以支持多种指标存储器。 在平台配置统一的指标策略完成指标类型数据的查询、分析、告警、可视化等。
 
-实现统一的日志查询接口，以支持多种日志存储器。 在平台配置统一的日志策略完成日志类型数据的查询、分析、告警、可视化等。
+[Prometheus](https://prometheus.io/)、[VictoriaMetrics](https://victoriametrics.com/)
 
-### 指标（Metric）
 
-实现统一的指标查询接口，以支持多种指标存储器。 在平台配置统一的指标策略完成指标类型数据的查询、分析、告警、可视化等。
+### 接口定义
 
-### 事件（Event）
+```go
+// MetricDatasource 数据源完整接口定义
+MetricDatasource interface {
+    Step() uint32
+    // Query 查询数据
+    Query(ctx context.Context, expr string, duration int64) ([]*QueryResponse, error)
+    // QueryRange 查询数据
+    QueryRange(ctx context.Context, expr string, start, end int64, step uint32) ([]*QueryResponse, error)
+    // Metadata 查询元数据
+    Metadata(ctx context.Context) (*Metadata, error)
+    // GetBasicInfo 获取数据源信息
+    GetBasicInfo() *BasicInfo
+}
+```
 
-实现统一的事件查询接口，以支持多种事件存储器。 在平台配置统一的事件策略完成事件类型数据的查询、分析、告警、可视化等。
+### 基本信息
+
+![数据源基本信息](./img/datasource-metric-basic.png)
+
+### 元数据
+
+![数据源元数据](./img/datasource-metric-metadata.png)
+
+### 查询
+
+:::tip
+
+查询结果支持图表、表格、JSON三种形式。 PromQL 语法参考 [Prometheus](https://prometheus.io/docs/prometheus/latest/querying/basics/)。
 
-## 存储器
+输入框支持表达式、函数、变量、常量等语法提示，能帮助用户快速构建查询语句。
 
-### prometheus
+:::
 
-[prometheus](https://prometheus.io/)
+* 图表
 
-### victoriametrics
+![数据源查询](./img/datasource-metric-real-query.png)
 
-[victoriametrics](https://victoriametrics.com/)
+> 查询条件说明, 可以选择时间范围、数据稀疏程度， 图表样式
 
-### elasticsearch
+![查询条件说明](./img/datasource-metric-real-query-params.png)
 
-[elasticsearch](https://www.elastic.co/cn/products/elasticsearch)
+* 表格
 
-### loki
+![数据源查询](./img/datasource-metric-real-table.png)
 
-[loki](https://grafana.com/oss/loki/)
+* JSON
 
-### kafka
+![数据源查询](./img/datasource-metric-real-json.png)
 
-[kafka](https://kafka.apache.org/)
+## 事件（Event）
+
+实现统一的事件查询接口，以支持多种事件存储器。 在平台配置统一的事件策略完成事件类型数据的查询、分析、告警、可视化等。
+
+[Kafka](https://kafka.apache.org/)、[RocketMQ](https://rocketmq.apache.org/)、[MQTT](https://mqtt.org/)
+
+```go
+// IMQ mq接口
+type IMQ interface {
+    // Send 发送消息
+    Send(topic string, data []byte) error
+
+    // Receive 接收消息 返回一个接收通道
+    Receive(topic string) <-chan *Msg
+
+    // RemoveReceiver 移除某个topic的接收通道
+    RemoveReceiver(topic string)
+
+    // Close 关闭连接
+    Close()
+}
+```
+
+## 日志（Log）开发中
+
+实现统一的日志查询接口，以支持多种日志存储器。 在平台配置统一的日志策略完成日志类型数据的查询、分析、告警、可视化等。
 
-### rocketmq
+[Elasticsearch](https://www.elastic.co/cn/products/elasticsearch)、[Loki](https://grafana.com/oss/loki/)
 
-[rocketmq](https://rocketmq.apache.org/)
+## 链路（Trace）开发中
 
-### mqtt
+实现统一的链路查询接口，以支持多种链路存储器。 在平台配置统一的链路策略完成链路类型数据的查询、分析、告警、可视化等。
 
-[mqtt](https://mqtt.org/)
+[OpenTelemetry](https://opentelemetry.io/)、[Jaeger](https://www.jaegertracing.io/)
diff --git a/docs/2-feature/img/datasource-metric-basic.png b/docs/2-feature/img/datasource-metric-basic.png
diff --git a/docs/2-feature/img/datasource-metric-metadata.png b/docs/2-feature/img/datasource-metric-metadata.png
diff --git a/docs/2-feature/img/datasource-metric-real-json.png b/docs/2-feature/img/datasource-metric-real-json.png
diff --git a/docs/2-feature/img/datasource-metric-real-query-params.png b/docs/2-feature/img/datasource-metric-real-query-params.png
diff --git a/docs/2-feature/img/datasource-metric-real-query.png b/docs/2-feature/img/datasource-metric-real-query.png
diff --git a/docs/2-feature/img/datasource-metric-real-table.png b/docs/2-feature/img/datasource-metric-real-table.png