常見訪問日志類型 · ENVOY 智能代理中文參考文檔

## 常見訪問日志類型 Envoy訪問日志記錄的是在一段固定的時間內通過Envoy進行入站的交互，典型場景包括單個請求/響應交互（例如HTTP），流（例如通過HTTP 2/gRPC）或連接代理（例如TCP等）。訪問日志包含協議指定的`protobuf`消息中定義的字段。除非另有明確聲明，否則所有字段都描述Envoy與連接的客戶端之間的下游交互。描述上游交互的字段將在其名稱中明確包含上游。 - [filter.accesslog.AccessLog](#filteraccesslogaccesslog) - [filter.accesslog.AccessLogFilter](#filteraccesslogaccesslogfilter) - [filter.accesslog.ComparisonFilter](#filteraccesslogcomparisonfilter) - [filter.accesslog.ComparisonFilter.Op (Enum)](#filteraccesslogcomparisonfilterop-enum) - [filter.accesslog.StatusCodeFilter](#filteraccesslogstatuscodefilter) - [filter.accesslog.DurationFilter](#filteraccesslogdurationfilter) - [filter.accesslog.NotHealthCheckFilter](#filteraccesslognothealthcheckfilter) - [filter.accesslog.TraceableFilter](#filteraccesslogtraceablefilter) - [filter.accesslog.RuntimeFilter](#filteraccesslogruntimefilter) - [filter.accesslog.AndFilter](#filteraccesslogandfilter) - [filter.accesslog.OrFilter](#filteraccesslogorfilter) - [filter.accesslog.FileAccessLog](#filteraccesslogfileaccesslog) ### filter.accesslog.AccessLog [filter.accesslog.AccessLog proto]() ``` { "name": "...", "filter": "{...}", "config": "{...}" } ``` - **name** ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) 要實例化的訪問日志實現的名稱。該名稱必須與靜態注冊的訪問日志匹配。當前的內置記錄器為：1）“envoy.file_access_log” - **filter** ([filter.accesslog.AccessLogFilter](#filteraccesslogaccesslogfilter)) 在寫入訪問日志時需要使用的過濾器。 - **config** ([Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)) 依賴實例化訪問日志的自定義配置。內置的配置包括：1）`“envoy.file_access_log”：FileAccessLog` ### filter.accesslog.AccessLogFilter [filter.accesslog.AccessLogFilter proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L261) ``` { "status_code_filter": "{...}", "duration_filter": "{...}", "not_health_check_filter": "{...}", "traceable_filter": "{...}", "runtime_filter": "{...}", "and_filter": "{...}", "or_filter": "{...}" } ``` 注意：必須正確設置`status_code_filter`，`duration_filter`，`not_health_check_filter`，`traceable_filter`，`runtime_filter`，`and_filter`，`or_filter`其中一個。 - **status_code_filter** ([filter.accesslog.StatusCodeFilter](#filteraccesslogstatuscodefilter)) 狀態碼過濾器。 - **duration_filter** ([filter.accesslog.DurationFilter](#filteraccesslogdurationfilter)) 時長過濾器。 - **not_health_check_filter** ([filter.accesslog.NotHealthCheckFilter](#filteraccesslognothealthcheckfilter)) 不健康檢查過濾器。 - **traceable_filter** ([filter.accesslog.TraceableFilter](#filteraccesslogtraceablefilter)) 可追蹤過濾器。 - **runtime_filter** ([filter.accesslog.RuntimeFilter](#filteraccesslogruntimefilter)) 運行時過濾器。 - **and_filter** ([filter.accesslog.AndFilter](#filteraccesslogandfilter)) 于過濾器。 - **or_filter** ([filter.accesslog.OrFilter](#filteraccesslogorfilter)) 或過濾器。 ### filter.accesslog.ComparisonFilter [filter.accesslog.ComparisonFilter proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L289) 整數比較過濾器。 ``` { "op": "...", "value": "{...}" } ``` - **op** ([filter.accesslog.ComparisonFilter.Op](#filteraccesslogcomparisonfilterop)) 比較運算符。 - **value** ([RuntimeUInt32](#runtimeuint32)) 與之比較的值。 ### filter.accesslog.ComparisonFilter.Op (Enum) [filter.accesslog.ComparisonFilter.Op proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L290) - **EQ** (DEFAULT) 相等`=` - **GE** 大于等于`>=` ### filter.accesslog.StatusCodeFilter [filter.accesslog.StatusCodeFilter proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L306) HTTP響應/狀態代碼的過濾器。 ``` { "comparison": "{...}" } ``` - **comparison** ([filter.accesslog.ComparisonFilter](#filteraccesslogcomparisonfilter), REQUIRED) 對比。 ### filter.accesslog.DurationFilter [filter.accesslog.DurationFilter proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L312) 請求持續總時間，以毫秒為單位過濾。 ``` { "comparison": "{...}" } ``` - **comparison** ([filter.accesslog.ComparisonFilter](#), REQUIRED) 對比。 ### filter.accesslog.NotHealthCheckFilter [filter.accesslog.NotHealthCheckFilter proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L319) 篩選不健康檢查請求。由健康檢查過濾器標記。 ``` {} ``` ### filter.accesslog.TraceableFilter [filter.accesslog.TraceableFilter proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L324) 篩選可追蹤的請求。請參閱跟蹤概述，以獲取有關請求如何可跟蹤的更多信息。 ``` {} ``` ### filter.accesslog.RuntimeFilter [filter.accesslog.RuntimeFilter proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L333) 過濾器用于隨機抽樣請求。在`x-request-id`頭部存在的情況下采樣抽取。如果存在`x-request-id`，則過濾器將根據運行時Key/value和從`x-request-id`提取值并在多個主機上持續采樣。如果缺失，過濾器將根據運行時Key/value隨機抽樣。 ``` { "runtime_key": "..." } ``` - **runtime_key** ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar), REQUIRED) 運行時key，以獲取要采樣的請求的百分比。此運行時值控制在0-100范圍內，默認為0。 ### filter.accesslog.AndFilter [filter.accesslog.AndFilter proto](https://github.com/envoyproxy/data-plane-api/blob/master/api/filter/accesslog/accesslog.proto#L342) 對過濾器中每個過濾器的結果執行邏輯“和”運算。過濾器將按順序進行評估，如果其中一個返回false，則過濾器立即返回false。 ``` { "filters": [] } ``` - **filters** ([filter.accesslog.AccessLogFilter](#filteraccesslogaccesslogfilter), REQUIRED) ### filter.accesslog.OrFilter [filter.accesslog.OrFilter proto]() 對每個單獨的過濾器的結果執行邏輯“或”操作。過濾器將按順序進行評估，如果其中一個返回true，則過濾器立即返回true。 ``` { "filters": [] } ``` - **filters** ([filter.accesslog.AccessLogFilter](#filteraccesslogaccesslogfilter), REQUIRED) ### filter.accesslog.FileAccessLog [filter.accesslog.FileAccessLog proto]() 將日志條目直接寫入文件的`AccessLog`的自定義配置。內置配置為`envoy.file_access_log AccessLog`。 ``` { "path": "...", "format": "..." } ``` - **path** ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar), REQUIRED) 要寫入訪問日志條目的本地文件的路徑。 - **format** ([string](https://developers.google.com/protocol-buffers/docs/proto#scalar)) 訪問日志的格式。Envoy支持自定義訪問日志格式以及默認格式。 ## 返回 - [上一級](../Filters.md) - [首頁目錄](../../README.md)