通過CEL語言自訂訪問日誌過濾規則 - Alibaba Cloud Service Mesh

訪問日誌是瞭解業務和Service Mesh運行狀態的重要觀測渠道。在訪問量較大的業務情境中，按照特定條件過濾日誌，可以節約Sidecar的效能開銷，並專註於關鍵日誌內容。ASM支援使用CEL（Common Expression Language）語言設定日誌過濾規則。本文介紹ASM AccessLog CEL過濾的使用方法和CEL支援的欄位，協助您自訂配置過濾規則。

過濾規則

CEL運算式返回為真的訪問日誌將被輸出，反之不會輸出。

情境樣本

樣本一：僅輸出響應狀態代碼為400以上的訪問日誌

response.code >= 400

response.code表示HTTP Response的HTTP Status。當HTTP Status≥400時，運算式為真，輸出該請求的訪問日誌。

樣本二：僅輸出請求URI中包含login字樣的訪問日誌

request.url_path.contains('login')

request.url_path表示HTTP Request的路徑（不包含query串）。
contains是CEL標準的字串方法，返回布爾值，用於判斷字串是否包含給定的子串。當request.url_path包含login子串時，運算式為真，輸出該請求的訪問日誌。

樣本三：使用邏輯與、邏輯或進行多個條件判斷

邏輯與（&&）
```
request.url_path.contains('login') && request.headers['x-user-type'] == 'dev'
```
- request.url_path表示HTTP Request的路徑（不包含query串）。
- request.headers表示請求中的要求標頭，類型為map<string, string>。
- 當請求的url_path包含login，且請求攜帶了x-user-type要求標頭，且該要求標頭的value為dev時，輸出該請求的訪問日誌。
邏輯或（||）
```
request.url_path.contains('login') || request.url_path.contains('logout')
```
- request.url_path表示HTTP Request的路徑（不包含query串）。
- 當請求的url_path包含login或者logout時，輸出該請求的訪問日誌。

CEL支援的欄位說明

請求屬性

屬性	類型	說明
request.path	string	URL的路徑部分。
request.url_path	string	URL的路徑部分，但不包含query串。
request.host	string	URL的主機名稱部分。
request.scheme	string	URL中的Scheme部分，例如HTTP、HTTPS。
request.method	string	要求方法，例如GET、POST。
request.headers	map<string, string>	所有請求Header的map。
request.referer	string	請求中Refer頭的值。
request.useragent	string	請求攜帶的User-Agent要求標頭的值。
request.time	timestamp	收到請求的首個位元組的時間戳記。
request.id	string	請求攜帶的x-request-id要求標頭的值。
request.protocol	string	請求協議，例如HTTP/1.0、HTTP/1、HTTP/2或HTTP/3。
request.query	string	URL中的query串部分，例如name1=value1&name2=value2。
request.duration	duration	請求花費的總時間長度。
request.size	int	請求體的大小，如果Content-Length要求標頭存在，則使用它的值。
request.total_size	int	包含要求標頭的完整請求大小。

響應屬性

屬性	類型	說明
response.code	int	請求響應的HTTP狀態代碼。
response.code_details	string	響應狀態代碼的描述資訊。
response.flags	int	除響應HTTP狀態代碼之外的額外資訊，以Bit Vector形式編碼。
response.grpc_status	int	響應的GRPC狀態代碼。
response.headers	map<string, string>	所有響應Header的map。
response.trailers	map<string, string>	所有響應中攜帶的Trailer的map。
response.size	int	響應體大小。
response.total_size	int	包含回應標頭的完整響應大小。

下遊屬性

屬性	類型	說明
source.address	string	下遊串連用戶端的地址。
source.port	int	下遊串連用戶端的連接埠。
destination.address	string	下遊串連的目標地址。
destination.port	int	下遊串連的目標連接埠。
connection.id	uint	下遊串連的ID。
connection.mtls	bool	是否在下遊串連上啟用了TLS以及下遊串連是否攜帶了認證。
connection.requested_server_name	string	下遊TLS串連請求的伺服器名稱。
connection.tls_version	string	下遊串連的TLS版本。
connection.subject_local_certificate	string	下遊串連服務端認證的Subject欄位。
connection.subject_peer_certificate	string	下遊串連用戶端認證的Subject欄位。
connection.dns_san_local_certificate	string	下遊TLS串連中服務端認證的SAN欄位中的第一個DNS條目。
connection.dns_san_peer_certificate	string	下遊TLS串連中用戶端認證的SAN欄位中的第一個DNS條目。
connection.uri_san_local_certificate	string	下遊TLS串連中服務端認證的SAN欄位中的第一個URI條目。
connection.uri_san_peer_certificate	string	下遊TLS串連中用戶端認證的SAN欄位中的第一個URI條目。
connection.sha256_peer_certificate_digest	string	下遊TLS串連中用戶端認證的SHA256雜湊串。
connection.transport_failure_reason	string	傳輸失敗的原因，例如certificate validation failed。

上遊屬性

屬性	類型	說明
upstream.address	string	上遊串連的目標地址。
upstream.port	int	上遊串連的目標連接埠。
upstream.tls_version	string	上遊串連的TLS版本。
upstream.subject_local_certificate	string	上遊串連使用的用戶端認證的Subject欄位的值。
upstream.subject_peer_certificate	string	上遊串連使用的服務端認證的Subject欄位的值。
upstream.dns_san_local_certificate	string	上遊串連用戶端認證中的SAN欄位中的第一個DNS條目。
upstream.dns_san_peer_certificate	string	上遊串連服務端認證中的SAN欄位中的第一個DNS條目。
upstream.uri_san_local_certificate	string	上遊串連用戶端認證中的SAN欄位中的第一個URI條目。
upstream.uri_san_peer_certificate	string	上遊串連服務端認證中的SAN欄位中的第一個URI條目。
upstream.sha256_peer_certificate_digest	string	下遊TLS串連中服務端認證的SHA256雜湊串。
upstream.local_address	string	上遊串連的用戶端本地地址。
upstream.transport_failure_reason	string	上遊傳輸失敗原因，例如certificate validation failed。