From d98115dd9adcda306395f61a31bda62e83f672f8 Mon Sep 17 00:00:00 2001
From: Juvenn Woo <machese@gmail.com>
Date: Sat, 24 Aug 2024 16:55:44 +0800
Subject: [PATCH] metric-api: Add config options doc
---
docs/configuration/experimental/index.md | 5 +++--
docs/configuration/experimental/index.zh.md | 12 +++++++-----
docs/configuration/experimental/metric-api.md | 6 ++++--
docs/configuration/experimental/metric-api.zh.md | 6 ++++--
4 files changed, 18 insertions(+), 11 deletions(-)
diff --git a/docs/configuration/experimental/index.md b/docs/configuration/experimental/index.md
index a1a515cf..e4ce8a47 100644
--- a/docs/configuration/experimental/index.md
+++ b/docs/configuration/experimental/index.md
@@ -2,7 +2,7 @@
!!! quote "Changes in sing-box 1.8.0"
- :material-plus: [cache_file](#cache_file)
+ :material-plus: [cache_file](#cache_file)
:material-alert-decagram: [clash_api](#clash_api)
### Structure
@@ -23,4 +23,5 @@
|--------------|----------------------------|
| `cache_file` | [Cache File](./cache-file/) |
| `clash_api` | [Clash API](./clash-api/) |
-| `v2ray_api` | [V2Ray API](./v2ray-api/) |
\ No newline at end of file
+| `metric_api` | [Metric API](./metric-api/) |
+| `v2ray_api` | [V2Ray API](./v2ray-api/) |
diff --git a/docs/configuration/experimental/index.zh.md b/docs/configuration/experimental/index.zh.md
index 01246c44..908a9541 100644
--- a/docs/configuration/experimental/index.zh.md
+++ b/docs/configuration/experimental/index.zh.md
@@ -2,7 +2,7 @@
!!! quote "sing-box 1.8.0 中的更改"
- :material-plus: [cache_file](#cache_file)
+ :material-plus: [cache_file](#cache_file)
:material-alert-decagram: [clash_api](#clash_api)
### 结构
@@ -12,6 +12,7 @@
"experimental": {
"cache_file": {},
"clash_api": {},
+ "metrics": {},
"v2ray_api": {}
}
}
@@ -19,8 +20,9 @@
### 字段
-| 键 | 格式 |
-|--------------|--------------------------|
+| 键 | 格式 |
+|--------------|------------------------------|
| `cache_file` | [缓存文件](./cache-file/) |
-| `clash_api` | [Clash API](./clash-api/) |
-| `v2ray_api` | [V2Ray API](./v2ray-api/) |
\ No newline at end of file
+| `clash_api` | [Clash API](./clash-api/) |
+| `metric_api` | [Metric API](./metric-api/) |
+| `v2ray_api` | [V2Ray API](./v2ray-api/) |
diff --git a/docs/configuration/experimental/metric-api.md b/docs/configuration/experimental/metric-api.md
index 1573cf10..f8d9c131 100644
--- a/docs/configuration/experimental/metric-api.md
+++ b/docs/configuration/experimental/metric-api.md
@@ -3,8 +3,10 @@
```json
{
- "listen": ":8080",
- "path": "/metrics"
+ "metrics": {
+ "listen": ":8080",
+ "path": "/metrics"
+ }
}
```
diff --git a/docs/configuration/experimental/metric-api.zh.md b/docs/configuration/experimental/metric-api.zh.md
index 67e8c312..6ff2cf61 100644
--- a/docs/configuration/experimental/metric-api.zh.md
+++ b/docs/configuration/experimental/metric-api.zh.md
@@ -3,8 +3,10 @@
```json
{
- "listen": ":8080",
- "path": "/metrics"
+ "metrics": {
+ "listen": ":8080",
+ "path": "/metrics"
+ }
}
```