管理接口 · ENVOY 智能代理中文參考文檔

## 管理接口 Envoy公開了一個本地管理界面，可以用來查詢和修改服務的不同方面： - [v1 API 參考](../v1APIreference/Administrationinterface.md) - [v2 API 參考](../v2APIreference/Bootstrap.md) ### GET / 打印所有可用的API清單 ### GET /certs 列出所有加載的TLS證書，包括文件名，序列號和到期日期。 ### GET /clusters 列出所有配置的[集群管理器](../Introduction/Architectureoverview/Clustermanager.md)集群。此信息包括每個群集中發現的所有上游主機以及每個主機統計信息。這對服務發現的問題調試很有用。 - **集群管理器信息** `version_info` 字符串，上次加載的[CDS](../Configurationreference/Clustermanager/Clusterdiscoveryservice.md)服務版本信息的字符串。如果envoy沒有安裝CDS，將會讀取`version_info::static`輸出。 - **集群信息** - 所有優先級都設置[熔斷](../Configurationreference/Clustermanager/Circuitbreaking.md)。 - 如果使能了[異常值檢測](../Introduction/Architectureoverview/Outlierdetection.md)，將會呈現[成功率平均值](../Introduction/Architectureoverview/Outlierdetection.md)和[逐出閾值](../Introduction/Architectureoverview/Outlierdetection.md)。如果在最后一個時間間隔內沒有足夠的數據來計算它們，那么這兩個值都將是-1。 - `added_via_api`標志，如果通過靜態配置添加的集群，則為`false`，如果通過CDS API添加，則為`true`。 - **按主機統計** | 名稱 | 類型 | 描述 | | ----------------------- | ----------------------- | ----------------------- | | cx_total | Counter | 連接總數 | | cx_active | Gauge | 總活動連接數 | | cx_connect_fail | Counter | 總連接失敗數 | | rq_total | Counter | 總請求數 | | rq_timeout | Counter | 總請求超時數 | | rq_success | Counter | 帶有非5xx響應的總請求數 | | rq_error | Counter | 帶有5xx響應的總請求數 | | rq_active | Gauge | 總活動請求數 | | healthy | String | 主機的健康狀況。見下文 | | weight | Integer | 負載平衡權重（1-100） | | zone | String | 所在服務區域 | | canary | Boolean | 主機是否是金絲雀（灰度發布）狀態 | | success_rate | Double | 請求成功率（0-100）。如果間隔中沒有足夠的請求量來計算它，則返回-1 | - **主機健康狀況** 由于一個或多個不健康的狀態，主機可能是健康的或不健康的。 如果主機健康，則會輸出`healthy`字符串。如果主機不健康，則會輸出以下一個或多個字符串： **/failed_active_hc**：主機主動健康檢查失敗。 **/failed_outlier_check**：主機未通過異常值檢測檢查。 ### GET /cpuprofiler 啟用或禁用CPU分析器。需要與`gperftools`一起進行編譯。 ### GET /healthcheck/fail 入站健康檢查失敗。這需要使用HTTP健康檢查過濾器。這對于將要關閉服務或完全重新啟動之前，逐出服務非常有用。無論過濾器如何配置，調用此命令都將執行健康檢查失敗的請求。 ### GET /healthcheck/ok 取消`GET /healthcheck/fail`的作用。這需要使用HTTP健康檢查過濾器。 ### GET /hot_restart_version 參見[--hot-restart-version](Commandlineoptions.md) ### GET /logging 在不同的子系統上啟用/禁用不同的日志記錄級別。一般只在開發過程中使用。 ### GET /quitquitquit 干凈地退出服務 ### GET /reset_counters 將所有計數器清零。在調試過程中，這對`GET /stats`很有用。請注意，這不會影響任何發送到`statsd`的數據。它只會影響`GET /stats`本地命令的輸出。 ### GET /routes?route_config_name=\<name> 此接口僅在envoy具有配置RDS的HTTP路由時才可用。如果指定了查詢，則此接口會轉儲所有已配置的HTTP路由表，或者僅轉儲與`route_config_name`查詢匹配的HTTP路由表。 ### GET /server_info 輸出有關運行的服務器的信息。輸出示例如下所示： ``` envoy 267724/RELEASE live 1571 1571 0 ``` 這些字段是： - 進程名稱 - 編譯SHA和生成類型 - 健康檢查狀態（活躍或逐出） - 當前熱重啟時間，以秒為單位 - 正常運行總時間（跨所有熱重啟階段），以秒為單位 - 當前熱重啟的迭代數 ### GET /stats 輸出所有需要的統計數據。這只包計數和測量值。直方圖不會輸出，因為Envoy目前沒有內置直方圖，依賴`statsd`進行匯總。這個命令對本地調試非常有用。瀏覽此處獲取[更多](Statisticsoverview.md)信息。 - **GET /stats?format=json** 以JSON格式的輸出統計信息。這個統計信息支持編程對接。 - **GET /stats?format=prometheus** 以[Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/) v0.0.4格式的輸出。這可以用來與`Prometheus`服務器集成。目前，只有計數器和計量器輸出。直方圖將在未來版本中提供。 ## 返回 - [上一級](../Operationsandadministration.md) - [首頁目錄](../README.md)