Application Real-Time Monitoring Service：Golang應用自訂配置

前提條件

已為應用安裝探針，具體操作，請參見應用監控接入概述。

功能入口

1. 登入ARMS控制台，在左側導覽列選擇應用監控 > 應用列表。

2. 在應用列表頁面頂部選擇目標地區，然後單擊目標應用程式名稱。

   說明

   語言列的表徵圖含義如下：

   ：接入應用監控的Java應用。

   ：接入應用監控的Golang應用。

   ：接入應用監控的Python應用。

   -：接入Managed Service for OpenTelemetry的應用。

3. 在上方導覽列選擇应用配置 > 自定义配置。

4. 設定自訂配置參數，設定完成後，單擊儲存。

採樣設定

在採樣設定地區，可以為調用鏈設定採樣策略。Golang應用目前僅支援通過固定採樣率採樣，同時支援按介面名、介面首碼、介面尾碼配置全採樣。

採樣率百分比預設為10，調大採樣率會消耗額外的系統資源，建議保持預設值。全採樣介面名僅支援1.5.2及以上版本探針。設定完成後，單擊儲存或儲存並批量複製到其它應用。

探針開關設定

在探針開關設定地區，可以控制應用監控的啟停並調整各外掛程式開關。

開啟暫停應用監控後計費也將同步暫停。外掛程式開關地區包含 dubbo-plugin、mysql-plugin、redis-plugin、grpc-plugin、kafka-client-plugin 等多個外掛程式，其中 hertz-plugin、opentelemetry-plugin、opentracing-plugin 動態修改後需重啟才生效。修改後單擊儲存，或通過批量複製到其他應用將配置同步至其他應用。

Runtime開關設定

在Runtime開關設定地區，可以開啟或關閉Runtime監控功能。更多資訊，請參見Runtime監控。

設定完成後，單擊儲存，或單擊儲存並批量複製到其它應用將配置同步到其他應用。

應用日誌關聯配置

在應用日誌關聯配置地區，可以設定應用關聯的日誌源資訊，將SpanId、TraceId列印到對應的日誌中。更多資訊，請參見Golang應用業務日誌關聯調用鏈TraceId。

開啟自動關聯業務日誌與TraceId開關後，在Log Service綁定地區選取項目地區、Project名稱、關聯類別型（日誌庫（Logstore）或資料集（StoreView））、Logstore名稱及關聯索引，完成後單擊儲存。如需將配置同步至其他應用，可單擊批量複製到其他應用。

URL收斂設定

在URL收斂設定地區，可以開啟或關閉收斂功能的開關，並設定收斂閾值、收斂規則。URL收斂是指將具有相似性的一系列URL作為一個單獨的個體展示，例如將前半部分都為/service/demo/的一系列URL集中展示。收斂閾值是指要進行URL收斂的最低數量條件，例如當閾值為100時，則符合規則Regex的URL數量達到100才會對它們進行收斂。更多資訊，請參見ARMS收斂機制說明。

收斂規則為Regex格式，樣本：/service/(.*?)/demo，多個規則之間以英文逗號分隔。設定完成後，單擊儲存或儲存並批量複製到其它應用。

持續剖析設定

在持續剖析設定地區，可以開啟或關閉總開關、CPU熱點、記憶體熱點和代碼熱點功能。更多資訊，請參見Golang應用持續剖析。

此外還支援配置協程熱點（需要1.6.0及以上版本）、阻塞分析和互斥鎖分析（需要1.6.1及以上版本）功能的開關。設定完成後單擊儲存，也可單擊批量複製到其他應用將配置同步。

介面調用配置

在介面調用配置地區，可以設定慢調用閾值、HTTP狀態代碼白名單、無效介面調用過濾等。

此外還可配置開啟列印http請求body和開啟列印http請求header開關（需1.5.0及以上版本）、http body長度（預設1024，需1.4.0及以上版本）、HTTP返回結果中包含TraceId開關（在response header中以eagleeye-traceid體現）、開啟列印http返回body和開啟列印http返回header開關（需1.5.1及以上版本）、http返回body的長度（預設1024），以及http請求header key寫入span和http返回header key寫入span文本域。

• 慢調用閾值：預設為500，當介面回應時間大於該閾值的時候，該介面會被標記為慢調用。

• HTTP狀態代碼白名單：

  預設情況下，HTTP 狀態代碼大於 400 會被歸類為錯誤調用。如果您不希望某類狀態代碼被歸類為錯誤，可以設定白名單來忽略這類錯誤。

  僅對應用監控當前支援的 HTTP 架構產生影響。

  影響資料：HTTP 服務端/用戶端的錯誤數指標（arms_http_requests_error_count、arms_http_client_requests_error_count、arms_app_requests_error_count）、Span 狀態。

  影響功能：應用概覽、提供服務、依賴服務頁簽中的錯誤數，調用鏈分析頁面的 Span 狀態、錯誤數警示。

  內容格式：填寫單一狀態代碼，多個狀態代碼用英文半形逗號（,）分隔，不支援模糊比對。

  樣本：403,502

  預設值：空

• 無效介面調用過濾：

  如果您不希望在提供服務頁簽看到這類調用，可以輸入不需要查看調用情況的介面名，探針將不會上報相關介面產生的觀測資料，從而將其從介面調用頁面隱去。

  影響資料：介面對應的所有指標、Span 都會被忽略。

  影響功能：應用概覽、提供服務、依賴服務頁簽對應介面的所有指標，調用鏈分析頁面的 Span 數量、對應介面的調用量、錯誤數、慢調用警示。

  內容格式：使用字串或 AntPath 運算式匹配無效介面全名，多個規則請使用英文半形逗號（,）分隔。（預設值的 AntPath 運算式寫法是為了相容存量資料，不建議刪除，新增配置請拼接在原有規則之後）。

  樣本：/api/test/*,/api/playground/create

  預設值：/**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg,/**/*.pdf,/**/*.xlsx,/**/*.txt,/**/*.docs,/**/*.gif,/**/*.csv

• 開啟列印HTTP請求Body：開啟後會在HTTP Client的Span中增加http.request.body欄位表示請求的Body，預設列印的長度是1024。

• 開啟列印HTTP請求Header：開啟後會在HTTP Client的Span中增加http.request.header欄位表示請求的Header。

• HTTP Body長度：HTTP請求Body的長度，預設列印的長度是1024。

• HTTP返回結果中包含TraceId：開啟後會在返回的Header中添加TraceId，Key是Eagleeye-TraceId。

• 開啟列印HTTP返回Body：開啟後會在HTTP Server的Span中增加http.response.body欄位表示返回的Body。

• 開啟列印HTTP返回Header：開啟後會在HTTP Server的Span中增加http.response.header欄位表示返回的Header。

• HTTP返回Body的長度：HTTP返回Body的長度，預設列印的長度是1024。

• HTTP請求Header Key寫入Span：填寫Header中出現的Key，多個可以用英文半形逗號分隔，填寫後會在HTTP Client的Span中增加http.request.header.key 欄位。

• HTTP返回Header Key寫入Span：填寫Header中出現的Key，多個可以用英文半形逗號分隔，填寫後會在HTTP Server的Span中增加http.response.header.key 欄位。

異常進階過濾配置

• 採集外掛程式異常：是否採集外掛程式異常。

• 異常過濾白名單：如果不希望在異常分析頁簽看到這類異常，可以輸入不需要統計為異常的異常名稱，從而將其從異常分析頁面隱去。

關閉採集外掛程式異常開關可避免同一個異常被記錄多次。異常過濾白名單中可輸入多個英文逗號（,）分隔的異常名稱，例如 *mysql.MySQLError；白名單命中的異常不影響 span 中記錄該異常，該功能在 2.3.1 及以上版本可用。

資料庫調用配置

在資料庫調用配置地區，可以設定慢SQL閾值、採集SQL最大保留長度，並設定是否展示SQL中的變數綁定值以及常量值。

• 展示SQL中的變數綁定值：捕獲PreparedStatement參數綁定的變數值，無需重啟應用即可生效。

• 展示SQL中的常量值：僅對SQL截斷，不做額外處理，無需重啟應用即可生效。

慢SQL閾值預設為500 ms，超過該閾值的查詢將被標記為慢SQL；採集SQL最大保留長度預設為1024，超出部分將被截斷；展示SQL中的變數綁定值僅支援MySQL。設定完成後單擊儲存或儲存並批量複製到其它應用。

調用鏈透傳通訊協定設定

在調用鏈透傳通訊協定設定地區，您可以根據自己的需求選擇使用的Trace協議。預設使用W3C協議，可以選擇Zipkin、Jaeger、EagleEye。

1.4.0及以上版本支援切換傳播協議。傳播模式支援優先和強制兩種：優先模式先讀取該協議Header，不存在則繼續探測其他協議Header；強制模式若Header不存在則按該協議規範強制產生新的Trace上下文。

探針採集配置

在探針採集配置地區，可以設定探針每秒最大鏈路採集量和探針記錄層級。

其中，探針每秒最大鏈路採集量預設為100；自訂指標採集需要探針2.0.0及以上版本；開啟Span上報需要探針1.8.3及以上版本；Span上報名稱需要探針1.7.0及以上版本，多個key之間用英文逗號分隔；預設指標採集過濾需要探針2.3.0及以上版本。

部分參數說明如下：

• 自訂指標採集控制Agent是否採集代碼中通過OTel SDK定義的指標。

• 開啟Span上報：預設開啟，關閉後所有Span 不上報。

• Span上報名稱：指定在關閉後需要上報的Span名稱。

• 自訂指標採集配置：配置指標Scope名稱，不配置預設採集所有自訂指標。

預設指標採集過濾：用於過濾指定類型的指標上報，當前支援下述幾種類型，可以多選：

• custom_entry: 方法監控自訂指標。

• http: http服務端指標。

• http_client: http用戶端指標。

• rpc: rpc調用服務端指標。

• rpc_client: rpc調用用戶端指標。

• sql: 訪問資料庫服務相關指標。

• nosql: 訪問nosql服務相關指標。

• cache: 訪問快取服務相關指標。

• producer: 發送訊息相關指標。

• consumer: 消費訊息相關指標。

• schedule: 調度服務相關指標。

進階設定

在進階設定地區，可以設定分位元統計、錯慢採樣、異常堆棧收集大長度等。

異常堆棧收集長度的預設值為4096。設定完成後，單擊儲存或儲存並批量複製到其它應用。

將配置複製到其他應用

如果您需要為其他應用同步相同配置，可以將對應配置複製到其他應用上。

全域預設配置

您可以將當前配置儲存為全域預設配置，在之後建立新應用時將會預設使用當前配置。

1. 在頁面底部單擊儲存當前應用設定為全域預設配置。

2. 如果彈出當前設定未儲存對話方塊，請單擊確定儲存本應用配置後，再單擊儲存當前應用設定為全域預設配置。

3. 在彈出的對話方塊中單擊確認。