當您建立並想要發佈內容套件時,請確定內容套件符合基本發佈需求。
您必須檢查內容套件需求和發佈需求。
內容套件需求
內容套件必須符合一些內容、品質和標準需求。
內容需求包括:
- 最少三個儀表板
- 每個儀表板最少一個 (最好三個) 最多五個儀表板篩選器
- 每個儀表板最少三個儀表板 Widget
- 每個儀表板最多六個儀表板 Widget
- 每列最多三個儀表板 Widget
- 最少五個警示
- 最少 20 個擷取的欄位
內容套件的品質需求如下:
- 警示
- 針對警示使用有意義的期間。
- 儀表板群組
-
- 請考慮從概觀儀表板群組開始。
- 根據訊息類型 (例如概觀或效能) 建立儀表板群組,而根據元件類型 (例如計算、網路或儲存區) 建立。
- 如果儀表板 Widget 適用於每個儀表板群組,請在多個儀表板群組中複製相同的儀表板 Widget。
- 在內容套件中目標至少有三個儀表板群組。
- 您無法重新排序儀表板群組和儀表板 Widget,但使用者內容除外。
- 命名儀表板群組時,請將標題設為一般,並避免新增產品特定或應用程式特定的名稱,除非是以元件特定的方式使用。
- 儀表板 Widget
-
- 請勿在同一列中放入超過三個儀表板 Widget。
- 以不同格式顯示類似資訊時,請確保每個格式都有值。
- 將相關的儀表板堆疊在一起,以便更輕鬆地檢視。
- 提供儀表板 Widget 的描述性名稱。請勿在 Widget 標題中使用欄位名稱。
- 請確保每個儀表板 Widget 均包含圖表所顯示內容及其重要性的相關資訊或連結。附註應回答「為何 Widget 很重要?」以及「哪裡可以找到其他資訊?」之類的問題。
- 查詢
-
- 每個查詢至少有一個全文檢索關鍵字,並且最好有三個或以上的關鍵字。
- 查詢不是以環境特定屬性 (例如來源、主機名稱或設施) 為基礎。
- 僅在關鍵字和 Glob 不足時,才需要在查詢中使用規則運算式。使用規則運算式時,盡可能提供更多的關鍵字。
- 請盡可能讓查詢更具體。內容套件查詢應僅符合適用於已設計內容套件之產品或應用程式的事件。
- 欄位擷取
-
- 在欄位上使用其他內容篩選器,可改善查詢中的欄位效能。
- 盡可能減少所使用的規則運算式數目。
- 確認規則運算式值符合每個適用的記錄訊息。
- 盡可能提供更多的前置和後置關鍵字內容。
- 每個欄位至少有一個全文檢索關鍵字,並且最好有三個或以上的關鍵字。
- 欄位專屬於產品或應用程式,且不會傳回其他產品或應用程式記錄的結果。
- 盡可能使用代理程式進行記錄收集。在擷取後使用代理程式進行欄位剖析,而非欄位擷取。
- 欄位命名
-
- 使用下列命名標準:前置詞_欄位_名稱。前置詞應適用於內容套件。
- 使用所有小寫字母。
- 在欄位的其他內容中使用關鍵字,可改善查詢中的欄位效能。
- 篩選器
-
- 使用篩選器時,請勿使用相符項目「any」運算子,除非在搜尋列中定義了一或多個關鍵字。「any」表示每個篩選器都是個別的查詢。例如,當有三個篩選器與查詢中的「any」運算子搭配使用時,系統會將查詢視為三個查詢。愈多查詢會導致結果愈慢。您可以將「any」視為「or」,並將「all」視為「and」運算子。
- 將文字篩選器用於多個不同值時,請確保在搜尋列中定義一或多個關鍵字。
- 內容套件資訊
-
- 匯出內容套件時,請使用公司 – 產品 v版本的命名格式。理想情況下,內容套件名稱必須少於 30 個字元,以防止文字換行。
- 使用命名空間匯出時,請使用命名空間格式 Ext.Domain.Product。
- 匯出內容套件時,請匯出內容套件所處理產品的詳細說明,以及內容套件協助監控產品的方式。
- 將資訊新增至內容套件的 [設定指示] 區段。這些指示可協助使用者設定及使用內容套件。
- 在內容套件的 [升級說明] 區段中新增資訊。這些指示可協助使用者瞭解及使用內容套件升級後版本中的所有功能。
- 提供有關已設計內容套件之測試後版本的產品或裝置詳細資訊。
- 依預設,系統會假設內容套件與所有受支援版本的產品或裝置回溯相容,且新版本的內容套件在內容套件從 Marketplace 更新之後,將不會中斷先前的組態。如果不是,請確定您提供個別的內容套件。
- 分隔內容套件時,請確定內容套件具有不同的命名空間,且無法從舊版本升級至新的內容套件。此外也支援以平行方式使用舊的和新的解決方案,而不會因為不正確的資料或額外警示造成使用者的混淆。將例外狀況新增至兩個內容套件的 [版本說明] 和 [已知問題] 區段。
- 內容套件的版本號碼格式為 Major.Minor.Revision。主要版本適用於內容套件中的多項變更,例如一或多個新的儀表板。次要版本適用於小型變更,例如錯誤修正、Widget 類型變更或新增一或兩個 Widget。此修訂版本為選用,且內容套件作者準備將新版本連同修訂集傳送給 VMware 時可以使用此修訂版本,但在發佈最終版本之後可能會予以略過。針對內容套件僅使用兩位數的版本號碼。
- 代理程式群組
- VMware Aria Operations for Logs 同時支援 Syslog 轉送的組態和自己的代理程式以提供記錄。內容套件設計為與代理程式和代理程式群組範本搭配使用,包括建議的組態。如需詳細資訊,請參閱每個內容套件的指示。
發佈需求
發佈內容套件之前,請檢查套件是否符合發佈需求。使用開發人員中心上的內容套件發佈者來取得內容套件建議,並將要檢閱的版本上傳給 VMware。https://developercenter.vmware.com/web/loginsight
發佈需求 | 說明 |
---|---|
內容套件檔案格式 | VLCP 檔案。 |
事件 | 驗證內容套件所需的適當事件。 |
概觀 | 內容套件的概觀,長度為一到兩個段落。 |
要點 | 三個要點,說明內容套件的價值。 |
說明 | 內容套件及其價值的說明,長度為兩到三個段落。 |
技術規格 | 說明最低系統需求,包括產品版本和組態,以及 VMware Aria Operations for Logs 版本和組態。此外還提供設定產品以登入 VMware Aria Operations for Logs 以及填入內容套件所需的所有指示。 |
螢幕擷取畫面 | 三個或以上的螢幕擷取畫面,顯示包含真實資料的內容套件。 |
視訊 (選擇性) | 示範內容套件如何帶入値。 |
白皮書 (選擇性) | 如何設定產品或應用程式將記錄轉送給 VMware Aria Operations for Logs。 |