Skip to content

Commit d728190

Browse files
author
haibin.lhb
committed
docs: document SLS/ARMS endpoint overrides and logging examples in README (CN/EN)
- Add CLI/env/@file examples for --sls-endpoints and --arms-endpoints - Mention template fallback and CMS reusing SLS endpoints - Show log lines indicating region/endpoint/source Change-Id: I9a130f23e42c920ec2b34ca638715538dd0a23f2 Co-developed-by: Cursor <[email protected]>
1 parent 360cfe2 commit d728190

File tree

2 files changed

+84
-1
lines changed

2 files changed

+84
-1
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,3 +211,44 @@ python -m mcp_server_aliyun_observability --transport sse --access-key-id <your_
211211

212212
![image](./images/chatwise_demo.png)
213213

214+
215+
### 端点映射与全局配置(SLS/ARMS)
216+
217+
支持在启动时覆盖各区域的服务端点,并在运行时打印实际生效的区域与端点(source=explicit/mapping/template)。
218+
219+
- SLS 端点映射(CLI)
220+
```
221+
python -m mcp_server_aliyun_observability \
222+
--transport streamable-http --transport-port 8083 \
223+
--sls-endpoints "cn-shanghai=cn-hangzhou.log.aliyuncs.com"
224+
```
225+
226+
- ARMS 端点映射(CLI)
227+
```
228+
python -m mcp_server_aliyun_observability --arms-endpoints "cn-shanghai=arms.internal"
229+
```
230+
231+
- 环境变量方式(优先级低于 CLI)
232+
```
233+
SLS_ENDPOINTS="cn-shanghai=cn-hangzhou.log.aliyuncs.com" \
234+
ARMS_ENDPOINTS="cn-shanghai=arms.internal" \
235+
python -m mcp_server_aliyun_observability --transport sse
236+
```
237+
238+
- 从文件加载(@file),文件可为 JSON 对象或纯文本 pairs
239+
```
240+
echo '{"cn-shanghai":"cn-hangzhou.log.aliyuncs.com"}' > sls_endpoints.json
241+
python -m mcp_server_aliyun_observability --sls-endpoints @sls_endpoints.json
242+
```
243+
244+
- 默认回退模板(未命中映射时):
245+
- SLS: `{region}.log.aliyuncs.com`
246+
- ARMS: `arms.{region}.aliyuncs.com`
247+
248+
- CMS 说明:CMS 工具内部使用 SLS 客户端,自动复用 `--sls-endpoints` 的映射,无需单独 cms 配置。
249+
250+
- 日志示例(控制台与文件均会输出):
251+
```
252+
SLS endpoint resolved: region=cn-shanghai, endpoint=cn-hangzhou.log.aliyuncs.com, source=mapping
253+
ARMS endpoint resolved: region=cn-shanghai, endpoint=arms.cn-shanghai.aliyuncs.com, source=template
254+
```

README_EN.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,4 +210,46 @@ python -m mcp_server_aliyun_observability --transport sse --access-key-id <your_
210210

211211
![image](./images/chatwise_inter.png)
212212

213-
![image](./images/chatwise_demo.png)
213+
![image](./images/chatwise_demo.png)
214+
215+
216+
### Endpoint Overrides and Global Settings (SLS/ARMS)
217+
218+
You can override service endpoints per region at startup. The server logs the effective region/endpoint and its source (explicit/mapping/template) when a client is created.
219+
220+
- SLS endpoint overrides (CLI)
221+
```
222+
python -m mcp_server_aliyun_observability \
223+
--transport streamable-http --transport-port 8083 \
224+
--sls-endpoints "cn-shanghai=cn-hangzhou.log.aliyuncs.com"
225+
```
226+
227+
- ARMS endpoint overrides (CLI)
228+
```
229+
python -m mcp_server_aliyun_observability --arms-endpoints "cn-shanghai=arms.internal"
230+
```
231+
232+
- Environment variables (lower precedence than CLI)
233+
```
234+
SLS_ENDPOINTS="cn-shanghai=cn-hangzhou.log.aliyuncs.com" \
235+
ARMS_ENDPOINTS="cn-shanghai=arms.internal" \
236+
python -m mcp_server_aliyun_observability --transport sse
237+
```
238+
239+
- Load from file (@file). File can be a JSON object or plain pairs text
240+
```
241+
echo '{"cn-shanghai":"cn-hangzhou.log.aliyuncs.com"}' > sls_endpoints.json
242+
python -m mcp_server_aliyun_observability --sls-endpoints @sls_endpoints.json
243+
```
244+
245+
- Template fallback when no mapping matched:
246+
- SLS: `{region}.log.aliyuncs.com`
247+
- ARMS: `arms.{region}.aliyuncs.com`
248+
249+
- CMS note: CMS tools internally reuse the SLS client, so it automatically respects `--sls-endpoints`.
250+
251+
- Example logs (to console and file):
252+
```
253+
SLS endpoint resolved: region=cn-shanghai, endpoint=cn-hangzhou.log.aliyuncs.com, source=mapping
254+
ARMS endpoint resolved: region=cn-shanghai, endpoint=arms.cn-shanghai.aliyuncs.com, source=template
255+
```

0 commit comments

Comments
 (0)