This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new d45a1ecd992 Remove doc `observability` from special-api in
shardingsphere-jdbc. (#19820)
d45a1ecd992 is described below
commit d45a1ecd9925d6353024444466cd2eaf464d089f
Author: Raigor <[email protected]>
AuthorDate: Wed Aug 3 21:35:17 2022 +0800
Remove doc `observability` from special-api in shardingsphere-jdbc. (#19820)
* Remove doc `observability` from special-api in shardingsphere-jdbc.
* Delete useless pictures of observability
---
.../special-api/observability/_index.cn.md | 7 --
.../special-api/observability/_index.en.md | 7 --
.../special-api/observability/agent.cn.md | 75 ------------------
.../special-api/observability/agent.en.md | 75 ------------------
.../observability/apm-integration.cn.md | 88 ---------------------
.../observability/apm-integration.en.md | 88 ---------------------
docs/document/static/img/apm/5x_executeSQL.png | Bin 20229 -> 0 bytes
.../static/img/apm/5x_executeSQL_Logs_err.png | Bin 18772 -> 0 bytes
.../static/img/apm/5x_executeSQL_Tags_err.png | Bin 20473 -> 0 bytes
docs/document/static/img/apm/5x_parse.png | Bin 16784 -> 0 bytes
docs/document/static/img/apm/5x_topology.png | Bin 11340 -> 0 bytes
docs/document/static/img/apm/5x_trace.png | Bin 31048 -> 0 bytes
docs/document/static/img/apm/5x_trace_err.png | Bin 34902 -> 0 bytes
13 files changed, 340 deletions(-)
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/_index.cn.md
deleted file mode 100644
index 5f993e02093..00000000000
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/_index.cn.md
+++ /dev/null
@@ -1,7 +0,0 @@
-+++
-title = "可观察性"
-weight = 4
-chapter = true
-+++
-
-介绍如何使用可观察性探针和集成第三方应用。
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/_index.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/_index.en.md
deleted file mode 100644
index 01dd7c44fee..00000000000
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/_index.en.md
+++ /dev/null
@@ -1,7 +0,0 @@
-+++
-title = "Observability"
-weight = 4
-chapter = true
-+++
-
-Introduce how to use agent and integrate 3rd party with observability.
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/agent.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/agent.cn.md
deleted file mode 100644
index cbb03f0e30a..00000000000
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/agent.cn.md
+++ /dev/null
@@ -1,75 +0,0 @@
-+++
-title = "使用探针"
-weight = 1
-+++
-
-## 如何获取
-
-### 本地构建
-
-```
- > cd shardingsphere/shardingsphere-agent
- > mvn clean install
-```
-
-### 远程下载（暂未发布）
-
-```
- > weget http://xxxxx/shardingsphere-agent.tar.gz
- > tar -zxvcf shardingsphere-agent.tar.gz
-```
-
-## 配置
-
-找到 `agent.yaml` 文件：
-
-```yaml
-applicationName: shardingsphere-agent
-ignoredPluginNames: # 忽略的插件集合
- - Opentracing
- - Jaeger
- - Zipkin
- - Prometheus
- - OpenTelemetry
- - Logging
-
-plugins:
- Prometheus:
- host: "localhost"
- port: 9090
- props:
- JVM_INFORMATION_COLLECTOR_ENABLED : "true"
- Jaeger:
- host: "localhost"
- port: 5775
- props:
- SERVICE_NAME: "shardingsphere-agent"
- JAEGER_SAMPLER_TYPE: "const"
- JAEGER_SAMPLER_PARAM: "1"
- JAEGER_REPORTER_LOG_SPANS: "true"
- JAEGER_REPORTER_FLUSH_INTERVAL: "1"
- Zipkin:
- host: "localhost"
- port: 9411
- props:
- SERVICE_NAME: "shardingsphere-agent"
- URL_VERSION: "/api/v2/spans"
- Opentracing:
- props:
- OPENTRACING_TRACER_CLASS_NAME:
"org.apache.skywalking.apm.toolkit.opentracing.SkywalkingTracer"
- OpenTelemetry:
- props:
- otel.resource.attributes: "service.name=shardingsphere-agent" #
多个配置用','分隔
- otel.traces.exporter: "zipkin"
- Logging:
- props:
- LEVEL: "INFO"
-```
-
-## 启动
-
-在启动脚本中添加参数：
-
-```
--javaagent:\absolute path\shardingsphere-agent.jar
-```
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/agent.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/agent.en.md
deleted file mode 100644
index 28731cd2144..00000000000
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/agent.en.md
+++ /dev/null
@@ -1,75 +0,0 @@
-+++
-title = "Use Agent"
-weight = 1
-+++
-
-## Build
-
-### Local Build
-
-```
- > cd shardingsphere/shardingsphere-agent
- > mvn clean install
-```
-
-### Download (Not Released Yet)
-
-```
- > weget http://xxxxx/shardingsphere-agent.tar.gz
- > tar -zxvcf shardingsphere-agent.tar.gz
-```
-
-## Configuration
-
-Found `agent.yaml` file:
-
-```yaml
-applicationName: shardingsphere-agent
-ignoredPluginNames: # A collection of ignored plugins
- - Opentracing
- - Jaeger
- - Zipkin
- - Prometheus
- - OpenTelemetry
- - Logging
-
-plugins:
- Prometheus:
- host: "localhost"
- port: 9090
- props:
- JVM_INFORMATION_COLLECTOR_ENABLED : "true"
- Jaeger:
- host: "localhost"
- port: 5775
- props:
- SERVICE_NAME: "shardingsphere-agent"
- JAEGER_SAMPLER_TYPE: "const"
- JAEGER_SAMPLER_PARAM: "1"
- JAEGER_REPORTER_LOG_SPANS: "true"
- JAEGER_REPORTER_FLUSH_INTERVAL: "1"
- Zipkin:
- host: "localhost"
- port: 9411
- props:
- SERVICE_NAME: "shardingsphere-agent"
- URL_VERSION: "/api/v2/spans"
- Opentracing:
- props:
- OPENTRACING_TRACER_CLASS_NAME:
"org.apache.skywalking.apm.toolkit.opentracing.SkywalkingTracer"
- OpenTelemetry:
- props:
- otel.resource.attributes: "service.name=shardingsphere-agent" # Multiple
configurations can be split by ','
- otel.traces.exporter: "zipkin"
- Logging:
- props:
- LEVEL: "INFO"
-```
-
-## Startup
-
-Add arguments in startup script.
-
-```
--javaagent:\absolute path\shardingsphere-agent.jar
-```
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/apm-integration.cn.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/apm-integration.cn.md
deleted file mode 100644
index ac6a8b1bf0c..00000000000
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/apm-integration.cn.md
+++ /dev/null
@@ -1,88 +0,0 @@
-+++
-title = "应用性能监控集成"
-weight = 2
-+++
-
-## 使用方法
-
-### 使用 OpenTracing 协议
-
-* 方法1：通过读取系统参数注入 APM 系统提供的 Tracer 实现类
-
-启动时添加参数
-
-```
--Dorg.apache.shardingsphere.tracing.opentracing.tracer.class=org.apache.skywalking.apm.toolkit.opentracing.SkywalkingTracer
-```
-
-调用初始化方法
-
-```java
-ShardingTracer.init();
-```
-
-* 方法2：通过参数注入 APM 系统提供的 Tracer 实现类。
-
-```java
-ShardingTracer.init(new SkywalkingTracer());
-```
-
-*注意：使用 SkyWalking 的 OpenTracing 探针时，不能同时使用 Apache ShardingSphere Agent 的
OpenTracing 插件，以防止两种插件互相冲突。*
-
-### 使用 SkyWalking 自动探针
-
-请参考 [SkyWalking
部署手册](https://github.com/apache/skywalking/blob/5.x/docs/cn/Quick-start-CN.md)。
-
-### 使用 OpenTelemetry
-
-在 agent.yaml 中填写好配置即可，例如将 Traces 数据导出到 Zipkin。
-
-```yaml
-OpenTelemetry:
- props:
- otel.resource.attributes: "service.name=shardingsphere-agent"
- otel.traces.exporter: "zipkin"
- otel.exporter.zipkin.endpoint: "http://127.0.0.1:9411/api/v2/spans";
-```
-
-## 效果展示
-
-无论使用哪种方式，都可以方便的将 APM 信息展示在对接的系统中，以下以 SkyWalking 为例。
-
-### 应用架构
-
-使用 ShardingSphere-Proxy 访问两个数据库 `192.168.0.1:3306` 和
`192.168.0.2:3306`，且每个数据库中有两个分表。
-
-### 拓扑图展示
-
-
-
-从图中看，用户访问 18 次 ShardingSphere-Proxy
应用，每次每个数据库访问了两次。这是由于每次访问涉及到每个库中的两个分表，所以每次访问了四张表。
-
-### 跟踪数据展示
-
-
-
-从跟踪图中可以能够看到 SQL 解析和执行的情况。
-
-`/Sharding-Sphere/parseSQL/`: 表示本次 SQL 的解析性能。
-
-
-
-`/Sharding-Sphere/executeSQL/`: 表示具体执行的实际 SQL 的性能。
-
-
-
-### 异常情况展示
-
-
-
-从跟踪图中可以能够看到发生异常的节点。
-
-`/Sharding-Sphere/executeSQL/`: 表示执行 SQL 异常的结果。
-
-
-
-`/Sharding-Sphere/executeSQL/`: 表示执行 SQL 异常的日志。
-
-
diff --git
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/apm-integration.en.md
b/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/apm-integration.en.md
deleted file mode 100644
index 4e9b2994b30..00000000000
---
a/docs/document/content/user-manual/shardingsphere-jdbc/special-api/observability/apm-integration.en.md
+++ /dev/null
@@ -1,88 +0,0 @@
-+++
-title = "APM Integration"
-weight = 2
-+++
-
-## Usage
-
-### Use OpenTracing
-
-* Method 1: inject Tracer provided by APM system through reading system
parameters
-
-Add startup arguments
-
-```
--Dorg.apache.shardingsphere.tracing.opentracing.tracer.class=org.apache.skywalking.apm.toolkit.opentracing.SkywalkingTracer
-```
-
-Call initialization method.
-
-```java
-ShardingTracer.init();
-```
-
-* Method 2: inject Tracer provided by APM through parameter.
-
-```java
-ShardingTracer.init(new SkywalkingTracer());
-```
-
-*Notice: when using SkyWalking OpenTracing agent, the OpenTracing plug-in of
Apache ShardingSphere Agent cannot be used at the same time to prevent the two
plug-ins from conflicting with each other.*
-
-### Use SkyWalking's Automatic Agent
-
-Please refer to [SkyWalking
Manual](https://github.com/apache/skywalking/blob/5.x/docs/en/Quick-start.md).
-
-### Use OpenTelemetry
-
-Just fill in the configuration in `agent.yaml`. For example, export Traces
data to Zipkin.
-
-```yaml
-OpenTelemetry:
- props:
- otel.resource.attributes: "service.name=shardingsphere-agent"
- otel.traces.exporter: "zipkin"
- otel.exporter.zipkin.endpoint: "http://127.0.0.1:9411/api/v2/spans";
-```
-
-## Result Demonstration
-
-No matter in which way, it is convenient to demonstrate APM information in the
connected system. Take SkyWalking for example:
-
-### Application Architecture
-
-Use `ShardingSphere-Proxy` to visit two databases, `192.168.0.1:3306` and
`192.168.0.2:3306`, and there are two tables in each one of them.
-
-### Topology
-
-
-
-It can be seen from the picture that the user has accessed
ShardingSphere-Proxy 18 times, with each database twice each time. It is
because two tables in each database are accessed each time, so there are
totally four tables accessed each time.
-
-### Tracking Data
-
-
-
-SQL parsing and implementation can be seen from the tracing diagram.
-
-`/Sharding-Sphere/parseSQL/` indicates the SQL parsing performance this time.
-
-
-
-`/Sharding-Sphere/executeSQL/` indicates the SQL parsing performance in actual
execution.
-
-
-
-### Exception
-
-
-
-Exception nodes can be seen from the tracing diagram.
-
-`/Sharding-Sphere/executeSQL/` indicates the exception results of SQL.
-
-
-
-`/Sharding-Sphere/executeSQL/` indicates the exception log of SQL execution.
-
-
diff --git a/docs/document/static/img/apm/5x_executeSQL.png
b/docs/document/static/img/apm/5x_executeSQL.png
deleted file mode 100644
index e6eeb0640f1..00000000000
Binary files a/docs/document/static/img/apm/5x_executeSQL.png and /dev/null
differ
diff --git a/docs/document/static/img/apm/5x_executeSQL_Logs_err.png
b/docs/document/static/img/apm/5x_executeSQL_Logs_err.png
deleted file mode 100644
index 46e8d75d837..00000000000
Binary files a/docs/document/static/img/apm/5x_executeSQL_Logs_err.png and
/dev/null differ
diff --git a/docs/document/static/img/apm/5x_executeSQL_Tags_err.png
b/docs/document/static/img/apm/5x_executeSQL_Tags_err.png
deleted file mode 100644
index 5728724978e..00000000000
Binary files a/docs/document/static/img/apm/5x_executeSQL_Tags_err.png and
/dev/null differ
diff --git a/docs/document/static/img/apm/5x_parse.png
b/docs/document/static/img/apm/5x_parse.png
deleted file mode 100644
index d91c53f6cb1..00000000000
Binary files a/docs/document/static/img/apm/5x_parse.png and /dev/null differ
diff --git a/docs/document/static/img/apm/5x_topology.png
b/docs/document/static/img/apm/5x_topology.png
deleted file mode 100644
index 8e8870154fa..00000000000
Binary files a/docs/document/static/img/apm/5x_topology.png and /dev/null differ
diff --git a/docs/document/static/img/apm/5x_trace.png
b/docs/document/static/img/apm/5x_trace.png
deleted file mode 100644
index 7feaa023563..00000000000
Binary files a/docs/document/static/img/apm/5x_trace.png and /dev/null differ
diff --git a/docs/document/static/img/apm/5x_trace_err.png
b/docs/document/static/img/apm/5x_trace_err.png
deleted file mode 100644
index 2692b5ed19d..00000000000
Binary files a/docs/document/static/img/apm/5x_trace_err.png and /dev/null
differ
