[shardingsphere] branch master updated: Added simple methods for use in container environments in the observability section (#21418)

[ji...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jianglongtao 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 e83107dc609 Added simple methods for use in container environments in the observability section (#21418)
e83107dc609 is described below

commit e83107dc609a2cf1ba06835e40e0b9fe5f02d3d5
Author: Ling Hengqian <li...@outlook.com>
AuthorDate: Mon Oct 10 00:01:52 2022 +0800

    Added simple methods for use in container environments in the observability section (#21418)
---
 .../observability/_index.cn.md                     | 26 +++++++++++++++++++++
 .../observability/_index.en.md                     | 27 ++++++++++++++++++++++
 2 files changed, 53 insertions(+)

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 e9ca8ed047b..0f0d36c70e3 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
@@ -97,6 +97,8 @@ plugins:
 
 ## ShardingSphere-Proxy 中使用
 
+### 通过非容器环境使用
+
 * 编辑启动脚本
 
 配置 shardingsphere-agent.jar 的绝对路径到 ShardingSphere-Proxy 的 start.sh 启动脚本中，请注意配置自己对应的绝对路径。
@@ -112,6 +114,30 @@ bin/start.sh
 ```
 正常启动后，可以在 ShardingSphere-Proxy 日志中找到 plugin 的加载信息，访问 Proxy 后，可以通过配置的监控地址查看到 `Metric` 和 `Tracing` 的数据。
 
+### 通过容器环境使用
+
+- 假设本地已完成如下的对应配置。
+  - 包含 ShardingSphere-Agent 二进制包解压后的所有文件的文件夹 `./custom/agent/`
+  - 包含 `server.yaml` 等 ShardingSphere-Proxy 的配置文件的文件夹为 `./custom/conf/`
+
+- 此时可通过环境变量 `JVM_OPT` 来配置 ShardingSphere-Agent 的使用。
+  以在 Docker Compose 环境下启动为例，合理的 `docker-compose.yml` 示例如下。
+
+```yaml
+version: "3.8"
+
+services:
+  apache-shardingsphere-proxy:
+    image: apache/shardingsphere-proxy:latest
+    environment:
+      JVM_OPTS: "-javaagent:/agent/shardingsphere-agent.jar"
+      PORT: 3308
+    volumes:
+      - ./custom/agent/:/agent/
+      - ./custom/conf/:/opt/shardingsphere-proxy/conf/
+    ports:
+      - "13308:3308"
+```
 
 ## Metrics
 | 指标名称                              | 类型         | 描述                                                     |
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 df5e7620a33..486c6e560a2 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
@@ -97,6 +97,8 @@ plugins:
 
 ## Usage in ShardingSphere-Proxy
 
+### Using via a non-container environment
+
 * Edit the startup script
 
 Configure the absolute path of shardingsphere-agent.jar to the start.sh startup script of shardingsphere proxy. 
@@ -112,6 +114,31 @@ bin/start.sh
 ```
 After startup, you can find the plugin info in the log of ShardingSphere-Proxy, `Metric` and `Tracing` data can be viewed through the configured monitoring address.
 
+### Use via container environment
+
+- Assume that the following corresponding configurations have been completed locally.
+  - Folder `./custom/agent/` that contains all files after unpacking ShardingSphere-Agent binary package
+  - The folder containing the configuration files of ShardingSphere-Proxy such as `server.yaml` is `./custom/conf/`
+
+- At this point, the use of ShardingSphere-Agent can be configured through the environment variable `JVM_OPT`.
+  Taking starting in the Docker Compose environment as an example, a reasonable `docker-compose.yml` example is as
+  follows.
+
+```yaml
+version: "3.8"
+
+services:
+  apache-shardingsphere-proxy:
+    image: apache/shardingsphere-proxy:latest
+    environment:
+      JVM_OPTS: "-javaagent:/agent/shardingsphere-agent.jar"
+      PORT: 3308
+    volumes:
+      - ./custom/agent:/agent/
+      - ./custom/conf:/opt/shardingsphere-proxy/conf/
+    ports:
+      - "13308:3308"
+```
 
 ## Metrics
 | name                             | type       | description                                                                                              |