This is an automated email from the ASF dual-hosted git repository.
sunnianjun 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 4b76b625f5d update agent doc (#23316)
4b76b625f5d is described below
commit 4b76b625f5db3d7c61783ba92b695b83fee836a0
Author: jiangML <[email protected]>
AuthorDate: Wed Jan 4 10:36:27 2023 +0800
update agent doc (#23316)
---
.../observability/_index.cn.md | 33 +++++++++++-----------
.../observability/_index.en.md | 33 +++++++++++-----------
2 files changed, 34 insertions(+), 32 deletions(-)
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/observability/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-proxy/observability/_index.cn.md
index 20244ff6f05..155157c3b25 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/observability/_index.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/observability/_index.cn.md
@@ -12,7 +12,7 @@ git clone --depth 1
https://github.com/apache/shardingsphere.git
cd shardingsphere
mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true
-Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests -Prelease
```
-agent 包输出目录为
shardingsphere-agent/shardingsphere-agent-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz
+agent 包输出目录为
agent/distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz
## agent 配置
@@ -26,25 +26,26 @@ tar -zxvf
apache-shardingsphere-${latest.release.version}-shardingsphere-agent-b
cd agent
tree
.
-└── apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin
- ├── LICENSE
- ├── NOTICE
- ├── conf
- │ ├── agent.yaml
- │ └── logback.xml
- ├── plugins
- │ ├── shardingsphere-agent-logging-file-${latest.release.version}.jar
- │ ├──
shardingsphere-agent-metrics-prometheus-${latest.release.version}.jar
- │ ├── shardingsphere-agent-tracing-jaeger-${latest.release.version}.jar
- │ ├──
shardingsphere-agent-tracing-opentelemetry-${latest.release.version}.jar
- │ ├──
shardingsphere-agent-tracing-opentracing-${latest.release.version}.jar
- │ └── shardingsphere-agent-tracing-zipkin-${latest.release.version}.jar
- └── shardingsphere-agent-${latest.release.version}.jar
+├── LICENSE
+├── NOTICE
+├── conf
+│ └── agent.yaml
+├── lib
+│ ├── shardingsphere-agent-metrics-core-${latest.release.version}.jar
+│ └── shardingsphere-agent-plugin-core-${latest.release.version}.jar
+├── plugins
+│ ├── shardingsphere-agent-logging-file-${latest.release.version}.jar
+│ ├── shardingsphere-agent-metrics-prometheus-${latest.release.version}.jar
+│ ├── shardingsphere-agent-tracing-jaeger-${latest.release.version}.jar
+│ ├──
shardingsphere-agent-tracing-opentelemetry-${latest.release.version}.jar
+│ ├── shardingsphere-agent-tracing-opentracing-${latest.release.version}.jar
+│ └── shardingsphere-agent-tracing-zipkin-${latest.release.version}.jar
+└── shardingsphere-agent-${latest.release.version}.jar
```
* 配置说明
-`META-INF/conf/agent.yaml` 用于管理 agent 配置。
+`conf/agent.yaml` 用于管理 agent 配置。
内置插件包括 Jaeger、OpenTracing、Zipkin、OpenTelemetry、Log 及 Prometheus。
默认不开启任何插件。
diff --git
a/docs/document/content/user-manual/shardingsphere-proxy/observability/_index.en.md
b/docs/document/content/user-manual/shardingsphere-proxy/observability/_index.en.md
index 27baacd3c99..31f8a509799 100644
---
a/docs/document/content/user-manual/shardingsphere-proxy/observability/_index.en.md
+++
b/docs/document/content/user-manual/shardingsphere-proxy/observability/_index.en.md
@@ -13,7 +13,7 @@ cd shardingsphere
mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true
-Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests -Prelease
```
-Output directory:
shardingsphere-agent/shardingsphere-agent-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz
+Artifact is
agent/distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz
## Agent configuration
@@ -27,25 +27,26 @@ tar -zxvf
apache-shardingsphere-${latest.release.version}-shardingsphere-agent-b
cd agent
tree
.
-└── apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin
- ├── LICENSE
- ├── NOTICE
- ├── conf
- │ ├── agent.yaml
- │ └── logback.xml
- ├── plugins
- │ ├── shardingsphere-agent-logging-file-${latest.release.version}.jar
- │ ├──
shardingsphere-agent-metrics-prometheus-${latest.release.version}.jar
- │ ├── shardingsphere-agent-tracing-jaeger-${latest.release.version}.jar
- │ ├──
shardingsphere-agent-tracing-opentelemetry-${latest.release.version}.jar
- │ ├──
shardingsphere-agent-tracing-opentracing-${latest.release.version}.jar
- │ └── shardingsphere-agent-tracing-zipkin-${latest.release.version}.jar
- └── shardingsphere-agent-${latest.release.version}.jar
+├── LICENSE
+├── NOTICE
+├── conf
+│ └── agent.yaml
+├── lib
+│ ├── shardingsphere-agent-metrics-core-${latest.release.version}.jar
+│ └── shardingsphere-agent-plugin-core-${latest.release.version}.jar
+├── plugins
+│ ├── shardingsphere-agent-logging-file-${latest.release.version}.jar
+│ ├── shardingsphere-agent-metrics-prometheus-${latest.release.version}.jar
+│ ├── shardingsphere-agent-tracing-jaeger-${latest.release.version}.jar
+│ ├──
shardingsphere-agent-tracing-opentelemetry-${latest.release.version}.jar
+│ ├── shardingsphere-agent-tracing-opentracing-${latest.release.version}.jar
+│ └── shardingsphere-agent-tracing-zipkin-${latest.release.version}.jar
+└── shardingsphere-agent-${latest.release.version}.jar
```
* Configuration file
-`META-INF/conf/agent.yaml` is used to manage agent configuration.
+`conf/agent.yaml` is used to manage agent configuration.
Built-in plugins include Jaeger, OpenTracing, Zipkin, OpenTelemetry, Log and
Prometheus.
No plugin is enabled by default.
