Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

管理

「管理」區可以查看 Osprey 設定,包括支援偵測的 Rules 與 Features、查詢及 Rule 作者可以使用的函式,以及理解各部分如何連接的工具。

Rules Visualizer

Rules Visualizer 以 dependency graph 顯示 Rules 與 Labels 之間的關係,可用來理解套用某個 Label 後會觸發哪些項目,或產生某個 Label 前必須符合哪些條件。

Rules Visualizer 頁面開啟搜尋框,在尚未選取項目前提供 Actions 與 Labels 類別

在搜尋框尋找 Action 或 Label 後,介面會顯示所選項目的 upstream 與 downstream 關係圖。兩個方向的顯示可以分別開啟或關閉。

圖中的 node types 如下。

  • 紅色橢圓 位於 Rule upstream 的 Label,也就是輸入條件
  • 藍色矩形 Rule
  • 綠色橢圓 位於 Rule downstream 的 Label,也就是輸出

將游標停在 node 上方,可以看到來源檔案路徑。關係圖支援縮放及平移,方便瀏覽大型 dependency trees。

UDF Registry

UDF Registry 是 Osprey 中所有使用者自訂函式 UDFs 的自動產生 API 參考。程式碼新增或修改 UDFs 後,內容會動態更新,因此能反映實際可用項目。

UDF Registry 依類別列出可用函式的 type signatures 與說明

UDFs 依類別整理並支援搜尋。每筆項目包含下列資訊。

  • 具有 syntax highlighting 的 function signature
  • 函式功能說明
  • Parameter names、types 與說明
  • Return type

撰寫 Rules 時,可用這個頁面確認函式的確切名稱與 parameter order。大多數 UDFs 只能用於 Rules。查詢輸入框只支援 RegexMatchDidAddLabelDidRemoveLabelDidDeclareVerdict 四個函式,目前在查詢中使用其他 UDF 會發生沒有可見訊息的 500 error。

Features Registry

Features Registry 列出 Osprey 部署環境中定義的每個 Feature。Features 是從 Events 擷取的具名變數,也是查詢與 Rules 操作的對象。

清單每頁顯示 50 筆,並提供下列篩選及排序方式。

  • Search 依名稱、類別或說明篩選
  • Category filter 限制為特定 Feature 類別
  • Extraction function filter 限制為使用特定 extraction function 的 Features
  • Unused only 只顯示未被任何 Rule 參照的 Features
  • Sort 依名稱、最多參照或最少參照排序

每一列會顯示 Feature name、category、extraction functions、reference count,也就是使用該 Feature 的 Rules 數量,以及 description、owner 與 last modified date。

Rules Registry

Rules Registry 列出 Osprey 部署環境中載入的每個 Rule。

清單每頁顯示 50 筆,並提供下列篩選及排序方式。

  • Search 依名稱、來源檔案或說明篩選
  • Unused only 隱藏被其他 when-Rules 參照的 Rules,只顯示 leaf Rules
  • Sort 依名稱、最多參照或最少參照排序

每一列會顯示 Rule name、source file、description、reference count 與來源檔案中的 line number。