You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by "manasagar (via GitHub)" <gi...@apache.org> on 2026/01/15 19:53:10 UTC
[PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
manasagar opened a new pull request, #37751:
URL: https://github.com/apache/shardingsphere/pull/37751
…g-sphere-jdbc
Fixes For #37654 .
Changes proposed in this pull request:
-
---
Before committing this PR, I'm sure that I have checked the following options:
- [x] My code follows the [code of conduct](https://shardingsphere.apache.org/community/en/involved/conduct/code/) of this project.
- [x] I have self-reviewed the commit code.
- [x] I have (or in comment I request) added corresponding labels for the pull request.
- [x] I have passed maven check locally : `./mvnw clean install -B -T1C -Dmaven.javadoc.skip -Dmaven.jacoco.skip -e`.
- [x] I have made corresponding changes to the documentation.
- [ ] I have added corresponding unit tests for my changes.
- [ ] I have updated the Release Notes of the current development version. For more details, see [Update Release Note](https://shardingsphere.apache.org/community/en/involved/contribute/contributor/)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "linghengqian (via GitHub)" <gi...@apache.org>.
linghengqian commented on code in PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751#discussion_r2698346272
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,96 @@
++++
+title = "Docker"
+weight = 5
++++
+# Docker
+
+## Local Build
+
+ShardingSphere Agent has a `Dockerfile` available for easy distribution. You can execute the following command to build a Docker Image,
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+## Community Build
+
+Since ShardingSphere 5.5.2, ShardingSphere Agent has released community builds at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+This Docker Image is not part of the ASF distribution, but is provided for convenience.
+
+If you add the following statement in a custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+## Nightly Build
+
+ShardingSphere Agent has a nightly built Docker Image at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+## Using Dockerfile
+
+Introduce a typical scenario,
+
+1. Assume that the Jaeger All in One Docker Container is deployed through the following Bash command,
+
+```shell
+docker network create example-net
+docker run --rm -d \
+ --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ --network example-net \
+ jaegertracing/all-in-one:1.62.0
+```
+
+2. Assume `./custom-agent.yaml` contains the configuration of ShardingSphere Agent, and the content may be as follows,
+
+```yaml
+plugins:
+ tracing:
+ OpenTelemetry:
+ props:
+ otel.service.name: "example"
+ otel.exporter.otlp.traces.endpoint: "http://jaeger:4318"
+```
+
+3. Assuming `./target/example.jar` is an Uber JAR of Spring Boot that will use ShardingSphere Agent,
+ you can use the ShardingSphere Agent in the nightly built Docker Image for a JAR like `example.jar` through a `Dockerfile` like the following.
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+If you build the Docker Image of `ghcr.io/apache/shardingsphere-agent:latest` locally, the `Dockerfile` may be as follows,
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+4. Enjoy it,
+
+```shell
+docker build -t example/gs-spring-boot-docker:latest .
+docker run --network example-net example/gs-spring-boot-docker:latest
+```
+
+
Review Comment:
Just keep one blank line. I think that's fine.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "linghengqian (via GitHub)" <gi...@apache.org>.
linghengqian merged PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "manasagar (via GitHub)" <gi...@apache.org>.
manasagar commented on code in PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751#discussion_r2698328214
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,96 @@
++++
+title = "Docker"
+weight = 5
++++
+# Docker
+
+## Local Build
+
+ShardingSphere Agent has a `Dockerfile` available for easy distribution. You can execute the following command to build a Docker Image,
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+## Community Build
+
+Since ShardingSphere 5.5.2, ShardingSphere Agent has released community builds at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+This Docker Image is not part of the ASF distribution, but is provided for convenience.
+
+If you add the following statement in a custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+## Nightly Build
+
+ShardingSphere Agent has a nightly built Docker Image at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+## Using Dockerfile
+
+Introduce a typical scenario,
+
+1. Assume that the Jaeger All in One Docker Container is deployed through the following Bash command,
+
+```shell
+docker network create example-net
+docker run --rm -d \
+ --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ --network example-net \
+ jaegertracing/all-in-one:1.62.0
+```
+
+2. Assume `./custom-agent.yaml` contains the configuration of ShardingSphere Agent, and the content may be as follows,
+
+```yaml
+plugins:
+ tracing:
+ OpenTelemetry:
+ props:
+ otel.service.name: "example"
+ otel.exporter.otlp.traces.endpoint: "http://jaeger:4318"
+```
+
+3. Assuming `./target/example.jar` is an Uber JAR of Spring Boot that will use ShardingSphere Agent,
+ you can use the ShardingSphere Agent in the nightly built Docker Image for a JAR like `example.jar` through a `Dockerfile` like the following.
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+If you build the Docker Image of `ghcr.io/apache/shardingsphere-agent:latest` locally, the `Dockerfile` may be as follows,
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+4. Enjoy it,
+
+```shell
+docker build -t example/gs-spring-boot-docker:latest .
+docker run --network example-net example/gs-spring-boot-docker:latest
+```
+
+
Review Comment:
So am I supposed to add two lines or is it fine that I add only one
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "linghengqian (via GitHub)" <gi...@apache.org>.
linghengqian commented on code in PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751#discussion_r2696469866
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.cn.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### 本地构建
+
+ShardingSphere Agent 存在可用的 `Dockerfile` 用于方便分发。可执行如下命令以构建 Docker Image，
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+此后若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 社区构建
+
+自 ShardingSphere 5.5.2 开始，ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 发布社区构建。
+此 Docker Image 不属于 ASF 分发产物之一，只是为了方便而提供。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### 夜间构建
+
+ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 存在夜间构建的 Docker Image。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 通过 Dockerfile 使用
+
+引入一个典型场景，
+
+1. 假设通过如下的 Bash 命令部署了 Jaeger All in One 的 Docker Container,
+
+```shell
+docker network create example-net
+docker run --rm -d \
+ --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ --network example-net \
+ jaegertracing/all-in-one:1.62.0
+```
+
+2. 假设 `./custom-agent.yaml` 包含 ShardingSphere Agent 的配置，内容可能如下，
+
+```yaml
+plugins:
+ tracing:
+ OpenTelemetry:
+ props:
+ otel.service.name: "example"
+ otel.exporter.otlp.traces.endpoint: "http://jaeger:4318"
+```
+
+3. 假设`./target/example.jar` 是一个即将使用 ShardingSphere Agent 的 Spring Boot 的 Uber JAR，
+ 可通过类似如下的 `Dockerfile` 来为类似 `example.jar` 的 JAR 使用夜间构建的 Docker Image 中的 ShardingSphere Agent。
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+如果是通过本地构建 `ghcr.io/apache/shardingsphere-agent:latest` 的 Docker Image，`Dockerfile` 可能如下，
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
Review Comment:
This change is meaningless; the use of ghcr.io is intentional.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "linghengqian (via GitHub)" <gi...@apache.org>.
linghengqian commented on code in PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751#discussion_r2696470938
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### Local Build
+
+ShardingSphere Agent has a `Dockerfile` available for easy distribution. You can execute the following command to build a Docker Image,
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### Community Build
+
+Since ShardingSphere 5.5.2, ShardingSphere Agent has released community builds at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+This Docker Image is not part of the ASF distribution, but is provided for convenience.
+
+If you add the following statement in a custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### Nightly Build
+
+ShardingSphere Agent has a nightly built Docker Image at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### Using Dockerfile
+
+Introduce a typical scenario,
+
+1. Assume that the Jaeger All in One Docker Container is deployed through the following Bash command,
+
+```shell
+docker network create example-net
+docker run --rm -d \
+ --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ --network example-net \
+ jaegertracing/all-in-one:1.62.0
+```
+
+2. Assume `./custom-agent.yaml` contains the configuration of ShardingSphere Agent, and the content may be as follows,
+
+```yaml
+plugins:
+ tracing:
+ OpenTelemetry:
+ props:
+ otel.service.name: "example"
+ otel.exporter.otlp.traces.endpoint: "http://jaeger:4318"
+```
+
+3. Assuming `./target/example.jar` is an Uber JAR of Spring Boot that will use ShardingSphere Agent,
+ you can use the ShardingSphere Agent in the nightly built Docker Image for a JAR like `example.jar` through a `Dockerfile` like the following.
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+If you build the Docker Image of `ghcr.io/apache/shardingsphere-agent:latest` locally, the `Dockerfile` may be as follows,
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
Review Comment:
This change is meaningless; the use of ghcr.io is intentional.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751#discussion_r2696465368
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.cn.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### 本地构建
+
+ShardingSphere Agent 存在可用的 `Dockerfile` 用于方便分发。可执行如下命令以构建 Docker Image，
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+此后若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 社区构建
+
+自 ShardingSphere 5.5.2 开始，ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 发布社区构建。
+此 Docker Image 不属于 ASF 分发产物之一，只是为了方便而提供。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### 夜间构建
+
+ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 存在夜间构建的 Docker Image。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
Review Comment:
Inconsistent heading level. The "本地构建", "社区构建", "夜间构建", and "通过 Dockerfile 使用" sections use heading level 4 (####), but they should use heading level 2 (##) to be consistent with the document structure and maintain proper heading hierarchy.
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.cn.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
Review Comment:
Weight conflict detected. Both the "Docker" page and "Metrics" page have weight = 3, which will cause navigation ordering issues. The Docker page should have a different weight value to maintain proper page ordering in the documentation navigation.
```suggestion
weight = 4
```
##########
docs/document/content/user-manual/shardingsphere-agent/_index.en.md:
##########
@@ -0,0 +1,49 @@
++++
+pre = "<b>4.6. </b>"
+title = "ShardingSphere-Agent"
+weight = 6
+chapter = true
++++
+
+# Agent
+
+The agent helps collect observability metrics, provides support for logging, and integrates with popular tracing and monitoring solutions like JVM metrics, Prometheus, and OpenTelemetry.
+
+
+### Compile source code
+
+Download Apache ShardingSphere from GitHub,Then compile.
Review Comment:
Missing space after comma. Should be "GitHub, Then" instead of "GitHub,Then".
```suggestion
Download Apache ShardingSphere from GitHub, Then compile.
```
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### Local Build
+
+ShardingSphere Agent has a `Dockerfile` available for easy distribution. You can execute the following command to build a Docker Image,
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### Community Build
+
+Since ShardingSphere 5.5.2, ShardingSphere Agent has released community builds at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+This Docker Image is not part of the ASF distribution, but is provided for convenience.
+
+If you add the following statement in a custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### Nightly Build
+
+ShardingSphere Agent has a nightly built Docker Image at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### Using Dockerfile
+
+Introduce a typical scenario,
+
+1. Assume that the Jaeger All in One Docker Container is deployed through the following Bash command,
+
+```shell
+docker network create example-net
+docker run --rm -d \
+ --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ --network example-net \
+ jaegertracing/all-in-one:1.62.0
+```
+
+2. Assume `./custom-agent.yaml` contains the configuration of ShardingSphere Agent, and the content may be as follows,
+
+```yaml
+plugins:
+ tracing:
+ OpenTelemetry:
+ props:
+ otel.service.name: "example"
+ otel.exporter.otlp.traces.endpoint: "http://jaeger:4318"
+```
+
+3. Assuming `./target/example.jar` is an Uber JAR of Spring Boot that will use ShardingSphere Agent,
+ you can use the ShardingSphere Agent in the nightly built Docker Image for a JAR like `example.jar` through a `Dockerfile` like the following.
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+If you build the Docker Image of `ghcr.io/apache/shardingsphere-agent:latest` locally, the `Dockerfile` may be as follows,
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
Review Comment:
The Dockerfile examples for both the nightly built and locally built scenarios are identical (lines 73-77 and 82-86), which appears to be incorrect. The locally built scenario should reference a different base image or demonstrate a different use case to justify having two separate examples.
##########
docs/document/content/user-manual/shardingsphere-agent/metrics/_index.en.md:
##########
@@ -0,0 +1,19 @@
++++
+title = "Metrics"
+weight = 3
++++
+
+# Metrics
+
+| Name | Type | Description |
+|:--------------------------------------|:----------|:-------------------------------------------------------------------------------------------------------|
+| build_info | GAUGE | Build information |
+| parsed_sql_total | COUNTER | Total count of parsed by type (INSERT, UPDATE, DELETE, SELECT, DDL, DCL, DAL, TCL, RQL, RDL, RAL, RUL) |
+| routed_sql_total | COUNTER | Total count of routed by type (INSERT, UPDATE, DELETE, SELECT) |
+| routed_result_total | COUNTER | Total count of routed result (data source routed, table routed) |
+| jdbc_state | GAUGE | Status information of ShardingSphere-JDBC. 0 is OK; 1 is CIRCUIT BREAK; 2 is LOCK |
+| jdbc_meta_data_info | GAUGE | Meta data information of ShardingSphere-JDBC |
+| jdbc_statement_execute_total | GAUGE | Total number of statements executed |
+| jdbc_statement_execute_errors_total | GAUGE | Total number of statement execution errors |
+| jdbc_statement_execute_latency_millis | HISTOGRAM | Statement execution latency |
+| jdbc_transactions_total | GAUGE | Total number of transactions, classify by commit and rollback |
Review Comment:
Inconsistency between English and Chinese documentation. The English version lists "jdbc_statement_execute_total", "jdbc_statement_execute_errors_total", and "jdbc_transactions_total" as GAUGE type, but the Chinese version correctly lists them as COUNTER type. Based on the metric names ending with "_total" and their descriptions indicating cumulative counts, they should be COUNTER type in both versions.
```suggestion
| jdbc_statement_execute_total | COUNTER | Total number of statements executed |
| jdbc_statement_execute_errors_total | COUNTER | Total number of statement execution errors |
| jdbc_statement_execute_latency_millis | HISTOGRAM | Statement execution latency |
| jdbc_transactions_total | COUNTER | Total number of transactions, classify by commit and rollback |
```
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
Review Comment:
Weight conflict detected. Both the "Docker" page and "Metrics" page have weight = 3, which will cause navigation ordering issues. The Docker page should have a different weight value to maintain proper page ordering in the documentation navigation.
```suggestion
weight = 4
```
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### Local Build
+
+ShardingSphere Agent has a `Dockerfile` available for easy distribution. You can execute the following command to build a Docker Image,
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### Community Build
+
+Since ShardingSphere 5.5.2, ShardingSphere Agent has released community builds at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+This Docker Image is not part of the ASF distribution, but is provided for convenience.
+
+If you add the following statement in a custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### Nightly Build
+
+ShardingSphere Agent has a nightly built Docker Image at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### Using Dockerfile
Review Comment:
Inconsistent heading level. The "Local Build", "Community Build", "Nightly Build", and "Using Dockerfile" sections use heading level 4 (####), but they should use heading level 2 (##) to be consistent with the document structure and maintain proper heading hierarchy.
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.cn.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### 本地构建
+
+ShardingSphere Agent 存在可用的 `Dockerfile` 用于方便分发。可执行如下命令以构建 Docker Image，
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+此后若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 社区构建
+
+自 ShardingSphere 5.5.2 开始，ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 发布社区构建。
+此 Docker Image 不属于 ASF 分发产物之一，只是为了方便而提供。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### 夜间构建
+
+ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 存在夜间构建的 Docker Image。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 通过 Dockerfile 使用
+
+引入一个典型场景，
+
+1. 假设通过如下的 Bash 命令部署了 Jaeger All in One 的 Docker Container,
+
+```shell
+docker network create example-net
+docker run --rm -d \
+ --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ --network example-net \
+ jaegertracing/all-in-one:1.62.0
+```
+
+2. 假设 `./custom-agent.yaml` 包含 ShardingSphere Agent 的配置，内容可能如下，
+
+```yaml
+plugins:
+ tracing:
+ OpenTelemetry:
+ props:
+ otel.service.name: "example"
+ otel.exporter.otlp.traces.endpoint: "http://jaeger:4318"
+```
+
+3. 假设`./target/example.jar` 是一个即将使用 ShardingSphere Agent 的 Spring Boot 的 Uber JAR，
+ 可通过类似如下的 `Dockerfile` 来为类似 `example.jar` 的 JAR 使用夜间构建的 Docker Image 中的 ShardingSphere Agent。
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+如果是通过本地构建 `ghcr.io/apache/shardingsphere-agent:latest` 的 Docker Image，`Dockerfile` 可能如下，
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
Review Comment:
The Dockerfile examples for both the nightly built and locally built scenarios are identical (lines 71-75 and 80-84), which appears to be incorrect. The locally built scenario should reference a different base image or demonstrate a different use case to justify having two separate examples.
```suggestion
如果是通过本地构建 `ghcr.io/apache/shardingsphere-agent:latest` 的 Docker Image，并将其打上本地标签（例如 `shardingsphere-agent:latest`），`Dockerfile` 可能如下，
```dockerfile
FROM shardingsphere-agent:latest
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "linghengqian (via GitHub)" <gi...@apache.org>.
linghengqian commented on code in PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751#discussion_r2697127297
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,96 @@
++++
+title = "Docker"
+weight = 5
++++
+# Docker
+
+## Local Build
+
+ShardingSphere Agent has a `Dockerfile` available for easy distribution. You can execute the following command to build a Docker Image,
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+## Community Build
+
+Since ShardingSphere 5.5.2, ShardingSphere Agent has released community builds at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+This Docker Image is not part of the ASF distribution, but is provided for convenience.
+
+If you add the following statement in a custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+## Nightly Build
+
+ShardingSphere Agent has a nightly built Docker Image at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+## Using Dockerfile
+
+Introduce a typical scenario,
+
+1. Assume that the Jaeger All in One Docker Container is deployed through the following Bash command,
+
+```shell
+docker network create example-net
+docker run --rm -d \
+ --name jaeger \
+ -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
+ --network example-net \
+ jaegertracing/all-in-one:1.62.0
+```
+
+2. Assume `./custom-agent.yaml` contains the configuration of ShardingSphere Agent, and the content may be as follows,
+
+```yaml
+plugins:
+ tracing:
+ OpenTelemetry:
+ props:
+ otel.service.name: "example"
+ otel.exporter.otlp.traces.endpoint: "http://jaeger:4318"
+```
+
+3. Assuming `./target/example.jar` is an Uber JAR of Spring Boot that will use ShardingSphere Agent,
+ you can use the ShardingSphere Agent in the nightly built Docker Image for a JAR like `example.jar` through a `Dockerfile` like the following.
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+If you build the Docker Image of `ghcr.io/apache/shardingsphere-agent:latest` locally, the `Dockerfile` may be as follows,
+
+```dockerfile
+FROM ghcr.io/apache/shardingsphere-agent:latest
+COPY ./target/example.jar /app.jar
+COPY ./custom-agent.yaml /usr/agent/conf/agent.yaml
+ENTRYPOINT ["java","-javaagent:/usr/agent/shardingsphere-agent.jar","-jar","/app.jar"]
+```
+
+4. Enjoy it,
+
+```shell
+docker build -t example/gs-spring-boot-docker:latest .
+docker run --network example-net example/gs-spring-boot-docker:latest
+```
+
+
Review Comment:
In fact, each document only needs to have one blank line at the end; multiple blank lines are not necessary, just like any other document.
This section actually contains three blank lines, but GitHub's diff UI will swallow one of them.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "linghengqian (via GitHub)" <gi...@apache.org>.
linghengqian commented on code in PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751#discussion_r2696476155
##########
docs/document/content/user-manual/shardingsphere-agent/_index.en.md:
##########
@@ -0,0 +1,49 @@
++++
+pre = "<b>4.6. </b>"
+title = "ShardingSphere-Agent"
+weight = 6
+chapter = true
++++
+
+# Agent
+
+The agent helps collect observability metrics, provides support for logging, and integrates with popular tracing and monitoring solutions like JVM metrics, Prometheus, and OpenTelemetry.
+
+
+### Compile source code
Review Comment:
`###` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### Local Build
+
+ShardingSphere Agent has a `Dockerfile` available for easy distribution. You can execute the following command to build a Docker Image,
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### Community Build
Review Comment:
`####` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### Local Build
Review Comment:
`####` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.cn.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### 本地构建
+
+ShardingSphere Agent 存在可用的 `Dockerfile` 用于方便分发。可执行如下命令以构建 Docker Image，
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+此后若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 社区构建
+
+自 ShardingSphere 5.5.2 开始，ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 发布社区构建。
+此 Docker Image 不属于 ASF 分发产物之一，只是为了方便而提供。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### 夜间构建
Review Comment:
`####` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/_index.en.md:
##########
@@ -0,0 +1,49 @@
++++
+pre = "<b>4.6. </b>"
+title = "ShardingSphere-Agent"
+weight = 6
+chapter = true
++++
+
+# Agent
+
+The agent helps collect observability metrics, provides support for logging, and integrates with popular tracing and monitoring solutions like JVM metrics, Prometheus, and OpenTelemetry.
+
+
+### Compile source code
+
+Download Apache ShardingSphere from GitHub,Then compile.
+
+```shell
+git clone --depth 1 https://github.com/apache/shardingsphere.git
+cd shardingsphere
+mvn clean install -DskipITs -DskipTests -P-dev,release,all
+```
+
+Agent artifact is `distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz`
+
+### Directory structure
Review Comment:
`###` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.cn.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### 本地构建
+
+ShardingSphere Agent 存在可用的 `Dockerfile` 用于方便分发。可执行如下命令以构建 Docker Image，
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+此后若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 社区构建
Review Comment:
`####` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/_index.en.md:
##########
@@ -0,0 +1,49 @@
++++
+pre = "<b>4.6. </b>"
+title = "ShardingSphere-Agent"
+weight = 6
+chapter = true
++++
+
+# Agent
+
+The agent helps collect observability metrics, provides support for logging, and integrates with popular tracing and monitoring solutions like JVM metrics, Prometheus, and OpenTelemetry.
+
+
+### Compile source code
+
+Download Apache ShardingSphere from GitHub,Then compile.
+
+```shell
+git clone --depth 1 https://github.com/apache/shardingsphere.git
+cd shardingsphere
+mvn clean install -DskipITs -DskipTests -P-dev,release,all
+```
+
+Agent artifact is `distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz`
+
+### Directory structure
+
+Create agent directory, and unzip agent distribution package to the directory.
+
+```shell
+mkdir agent
+tar -zxvf apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz -C agent
+cd agent
+tree
+├── LICENSE
+├── NOTICE
+├── conf
+│ └── agent.yaml
+├── plugins
+│ ├── lib
+│ │ ├── shardingsphere-agent-metrics-core-${latest.release.version}.jar
+│ │ └── shardingsphere-agent-plugin-core-${latest.release.version}.jar
+│ ├── logging
+│ │ └── shardingsphere-agent-logging-file-${latest.release.version}.jar
+│ ├── metrics
+│ │ └── shardingsphere-agent-metrics-prometheus-${latest.release.version}.jar
+│ └── tracing
+│ ├── shardingsphere-agent-tracing-opentelemetry-${latest.release.version}.jar
+└── shardingsphere-agent-${latest.release.version}.jar
+```
Review Comment:
Please leave a blank line at the end of topic. See https://shardingsphere.apache.org/community/en/involved/conduct/document/ .
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.cn.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### 本地构建
Review Comment:
`####` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.cn.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### 本地构建
+
+ShardingSphere Agent 存在可用的 `Dockerfile` 用于方便分发。可执行如下命令以构建 Docker Image，
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+此后若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 社区构建
+
+自 ShardingSphere 5.5.2 开始，ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 发布社区构建。
+此 Docker Image 不属于 ASF 分发产物之一，只是为了方便而提供。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### 夜间构建
+
+ShardingSphere Agent 在 https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent 存在夜间构建的 Docker Image。
+
+若在自定义 `Dockerfile` 中添加以下语句，这会将 ShardingSphere Agent 的目录复制到 `/shardingsphere-agent/` 。
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### 通过 Dockerfile 使用
Review Comment:
`####` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/usage/docker/_index.en.md:
##########
@@ -0,0 +1,94 @@
++++
+title = "Docker"
+weight = 3
++++
+# Docker
+
+#### Local Build
+
+ShardingSphere Agent has a `Dockerfile` available for easy distribution. You can execute the following command to build a Docker Image,
+
+```shell
+git clone git@github.com:apache/shardingsphere.git
+cd ./shardingsphere/
+./mvnw -am -pl distribution/agent -P-dev,release,all,docker -T1C -DskipTests clean package
+```
+
+If you add the following statement in your custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:latest /usr/agent/ /shardingsphere-agent/
+```
+
+#### Community Build
+
+Since ShardingSphere 5.5.2, ShardingSphere Agent has released community builds at https://github.com/apache/shardingsphere/pkgs/container/shardingsphere-agent .
+This Docker Image is not part of the ASF distribution, but is provided for convenience.
+
+If you add the following statement in a custom `Dockerfile`, it will copy the ShardingSphere Agent directory to `/shardingsphere-agent/`.
+
+```dockerfile
+COPY --from=ghcr.io/apache/shardingsphere-agent:5.5.2 /usr/agent/ /shardingsphere-agent/
+```
+
+#### Nightly Build
Review Comment:
`####` needs to be changed to `##`.
##########
docs/document/content/user-manual/shardingsphere-agent/_index.cn.md:
##########
@@ -0,0 +1,47 @@
++++
+pre = "<b>4.6. </b>"
+title = "ShardingSphere-Agent"
+weight = 6
+chapter = true
++++
+
+# Agent
+
+该代理程序有助于收集可观测性指标，提供日志记录支持，并与流行的跟踪和监控解决方案集成，例如 JVM 指标、Prometheus 和 OpenTelemetry。
+
+### 源码编译
+
+从 Github 下载 Apache ShardingSphere 源码，对源码进行编译，操作命令如下。
+
+```shell
+git clone --depth 1 https://github.com/apache/shardingsphere.git
+cd shardingsphere
+mvn clean install -DskipITs -DskipTests -P-dev,release,all
+```
+Agent 制品 `distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz`
+
+### 目录说明
Review Comment:
Similarly, `###` needs to be changed to `##`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] modified docs to bring sharding-sphere-agent to same level as shardin… [shardingsphere]
Posted by "linghengqian (via GitHub)" <gi...@apache.org>.
linghengqian commented on code in PR #37751:
URL: https://github.com/apache/shardingsphere/pull/37751#discussion_r2697136143
##########
docs/document/content/user-manual/shardingsphere-agent/_index.en.md:
##########
@@ -0,0 +1,49 @@
++++
+pre = "<b>4.6. </b>"
+title = "ShardingSphere-Agent"
+weight = 6
+chapter = true
++++
+
+# Agent
+
+The agent helps collect observability metrics, provides support for logging, and integrates with popular tracing and monitoring solutions like JVM metrics, Prometheus, and OpenTelemetry.
+
+
+### Compile source code
+
+Download Apache ShardingSphere from GitHub,Then compile.
Review Comment:
The part after the comma should be `then`, not `Then`. There's also a missing space here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@shardingsphere.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org