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 [email protected]: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 [email protected]: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 [email protected]: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 [email protected]: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 [email protected]: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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
