tcjlj/OpenFlare
1
0
Fork 0
mirror of https://github.com/Rain-kl/OpenFlare.git synced 2026-10-02 23:06:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 观测重构 changelog 与 Swagger 同步

Browse Source 
补充 unreleased 变更说明，并重新生成 Swagger 以匹配去兼容层后的 API。
This commit is contained in:
ryan
2026-07-18 11:53:11 +08:00
parent 71ce028f91
commit 802d516f5b
5 changed files with 153 additions and 360 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/swagger.json
+51 -134
View File
@@ -8375,7 +8375,7 @@
"SessionCookie": []
}
],
"description": "从用户提供的 HTTP(S) 链接下载部署包并创建部署记录；服务端使用浏览器伪装请求头拉取，需要管理员权限",
"description": "从用户提供的 HTTP(S) 链接下载部署包并创建部署记录；服务端使用浏览器伪装请求头拉取，允许内网地址与不安全 TLS 证书，需要管理员权限",
"consumes": [
"application/json"
],
@@ -13309,7 +13309,7 @@
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeAccessLog"
}
},
"buffered_observability": {
"buffered": {
"type": "array",
"items": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.BufferedObservabilityRecord"
@@ -13318,6 +13318,9 @@
"current_version": {
"type": "string"
},
"edge_health": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeEdgeHealth"
},
"ext_version": {
"type": "string"
},
@@ -13327,6 +13330,9 @@
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeHealthEvent"
}
},
"host_metrics": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeMetricSnapshot"
},
"ip": {
"type": "string"
},
@@ -13342,20 +13348,14 @@
"openresty_message": {
"type": "string"
},
"openresty_observation": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeOpenrestyObservation"
},
"openresty_status": {
"type": "string"
},
"profile": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeSystemProfile"
},
"snapshot": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeMetricSnapshot"
},
"traffic_report": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeTrafficReport"
"schema_version": {
"type": "integer"
},
"version": {
"type": "string"
@@ -14197,17 +14197,14 @@
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeAccessLog"
}
},
"openresty_observation": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeOpenrestyObservation"
},
"snapshot": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeMetricSnapshot"
},
"traffic_report": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeTrafficReport"
},
"window_started_at_unix": {
"captured_at_unix": {
"type": "integer"
},
"edge_health": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeEdgeHealth"
},
"host_metrics": {
"$ref": "#/definitions/github_com_Rain-kl_Wavelet_pkg_protocol.NodeMetricSnapshot"
}
}
},
@@ -14215,6 +14212,7 @@
"type": "object",
"properties": {
"bytes_sent": {
"description": "body bytes = 已提供数据",
"type": "integer"
},
"host": {
@@ -14229,11 +14227,36 @@
"remote_addr": {
"type": "string"
},
"request_length": {
"description": "接收数据",
"type": "integer"
},
"request_time_ms": {
"description": "optional",
"type": "integer"
},
"status_code": {
"type": "integer"
}
}
},
"github_com_Rain-kl_Wavelet_pkg_protocol.NodeEdgeHealth": {
"type": "object",
"properties": {
"captured_at_unix": {
"type": "integer"
},
"connections": {
"type": "integer"
},
"message": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"github_com_Rain-kl_Wavelet_pkg_protocol.NodeHealthEvent": {
"type": "object",
"properties": {
@@ -14292,23 +14315,6 @@
}
}
},
"github_com_Rain-kl_Wavelet_pkg_protocol.NodeOpenrestyObservation": {
"type": "object",
"properties": {
"captured_at_unix": {
"type": "integer"
},
"openresty_connections": {
"type": "integer"
},
"openresty_rx_bytes": {
"type": "integer"
},
"openresty_tx_bytes": {
"type": "integer"
}
}
},
"github_com_Rain-kl_Wavelet_pkg_protocol.NodeSystemProfile": {
"type": "object",
"properties": {
@@ -14347,47 +14353,6 @@
}
}
},
"github_com_Rain-kl_Wavelet_pkg_protocol.NodeTrafficReport": {
"type": "object",
"properties": {
"error_count": {
"type": "integer"
},
"request_count": {
"type": "integer"
},
"source_countries": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"status_codes": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"top_domains": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
},
"unique_visitor_count": {
"type": "integer"
},
"window_ended_at_unix": {
"type": "integer"
},
"window_started_at_unix": {
"type": "integer"
}
}
},
"github_com_Rain-kl_Wavelet_pkg_protocol.PagesDeploymentHashResponse": {
"type": "object",
"properties": {
@@ -15156,44 +15121,6 @@
}
}
},
"model.OpenFlareRequestReport": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"error_count": {
"type": "integer"
},
"id": {
"type": "integer"
},
"node_id": {
"type": "string"
},
"request_count": {
"type": "integer"
},
"source_countries_json": {
"type": "string"
},
"status_codes_json": {
"type": "string"
},
"top_domains_json": {
"type": "string"
},
"unique_visitor_count": {
"type": "integer"
},
"window_ended_at": {
"type": "string"
},
"window_started_at": {
"type": "string"
}
}
},
"model.PushChannel": {
"type": "object",
"properties": {
@@ -15866,12 +15793,6 @@
"relay_dashboard": {
"$ref": "#/definitions/observability.RelayDashboardSnapshot"
},
"traffic_reports": {
"type": "array",
"items": {
"$ref": "#/definitions/model.OpenFlareRequestReport"
}
},
"trends": {
"$ref": "#/definitions/observability.NodeTrends"
}
@@ -16454,18 +16375,20 @@
"bucket_started_at": {
"type": "string"
},
"bytes_provided": {
"description": "sum(bytes_sent)",
"type": "integer"
},
"bytes_received": {
"description": "sum(request_length)",
"type": "integer"
},
"network_rx_bytes": {
"type": "integer"
},
"network_tx_bytes": {
"type": "integer"
},
"openresty_rx_bytes": {
"type": "integer"
},
"openresty_tx_bytes": {
"type": "integer"
},
"reported_nodes": {
"type": "integer"
}
@@ -16521,12 +16444,6 @@
"openresty_connections": {
"type": "integer"
},
"openresty_rx_bytes": {
"type": "integer"
},
"openresty_tx_bytes": {
"type": "integer"
},
"storage_total_bytes": {
"type": "integer"
},