SharePoint Server 中的設定檔結構描述參照

適用于:yes-img-132013 yes-img-16 2016yes-img-192019 yes-img-se訂閱版本 no-img-sopMicrosoft 365 中的 SharePoint

當您在 SharePoint 伺服器陣列上執行 BackupMonitoringSettings.ps1 Microsoft PowerShell 指令碼,您會建立一個稱作設定檔的檔案。 該設定檔遵循 XML 結構描述。 您可以修改的結構描述的項目設定,以建立自訂的設定檔。 您可以接著使用自訂的設定檔,以自動設定在 SharePoint 環境中的監視設定。 如需已編寫監視設定指令碼的簡介,請參閱<SharePoint Server 中的已編寫監視設定指令碼概觀>。

系統管理員可以執行指令碼之前、期間和之後的變更至伺服器陣列,伺服陣列拓撲,主要的安全性變更,例如套用軟體更新,或執行效能測試。 指令碼會變更監視設定,使所有必要的監視資料是在事件期間收集,而不會在正常操作期間濫記到記錄資料庫。

注意事項

[!附註] 您必須下載 PowerShell 指令碼,以備份、還原或修改伺服器陣列的監視設定。 腳本監視組態 - BackupMonitoringSettings 和腳本監視組態 - AlterMonitoringSettings的 TechNet 資源庫提供腳本。 BackupMonitoringSettings.ps1 PowerShell 指令碼會建立設定檔備份,您可以由此建立其他的設定檔。

您可以建立一或多個設定檔,以調整在 SharePoint 生命週期的不同階段的監視等級。 您也可以使用自訂的設定檔,在數個伺服器陣列上立刻進行監視設定。

您通常會為下列用途建立設定檔:

  • 在您安裝 SharePoint Server 之後,若要在伺服器陣列上完成監視設定

  • 在變更系統管理之前,例如在伺服器陣列上變更應用程式 [搜尋] 服務的設定,若要將伺服器陣列上的監視設定變更

    如此一來,您可以擷取更多關於變更的監視資料,並隱藏不想要的監控資料。 完成變更後,您可以接著將監視設定還原為原始值。

  • 在變更系統管理後,若要將伺服器陣列上的監控設定還原

  • 若要將伺服器陣列上的前一組監視設定還原

    如果您正在手動調整設定,並決定要還原先前的設定,您可以這麼做。

  • 若要還原預設設定

  • 若要建立可以套用至多個伺服器陣列的設定檔

備份原始設定

您應該永遠在變更監視設定的預設值之前進行備份。 如此一來,您可以還原這些您所需要的設定。 該備份設定檔也可以做為您將建立的其他設定檔起點。 如需關於如何備份這些設定的詳細資訊,請參閱<在 SharePoint Server 執行已編寫監視設定指令碼>。

了解設定檔結構描述

當您執行 BackupMonitoringSettings.ps1 PowerShell 指令碼,您會建立符合下列 XML 結構描述的設定檔。 檔案項目會包含來自伺服器陣列的相關監視設定。

<?xml version="1.0" standalone="yes"?>
<Configuration>
  <FarmDiagnosticConfig />
  <UsageServices>
    <UsageService />  
  </UsageServices>
  <UsageDefinitions>
    <UsageDefinition />
  </UsageDefinitions>
  <LogLevels>
    <LogLevel />
  </LogLevels>
  <TimerJobs>
    <TimerJob />
  </TimerJobs>
  <HealthAnalyzerRules>
    <HealthAnalyzerRule />
  </HealthAnalyzerRules>
</Configuration>

重要事項

[!重要事項] 在下列表格中,您無法在標示為 [唯讀] 的欄位中變更值。 如果您在設定檔的 [唯讀] 欄位變更值,可能會發生無法預期的結果。

FarmDiagnosticConfig 項目設定

名稱 值類型 附註
AllowLegacyTraceProviders
布林值
指定為舊版 SharePoint 產品及技術所建的追蹤提供者,可寫入 SharePoint Server 產品的追蹤工作階段。
AppAnalyticsAutomaticUploadEnabled
布林值
指定是否要將彙總應用程式使用資料自動上傳至 Microsoft。
CustomerExperienceImprovementProgramEnabled
布林值
決定管理群組是否啟用 [參與客戶經驗改進計畫] 功能。
ErrorReportingEnabled
布林值
取得或設定值,用以表示是否啟用損毀資料收集和錯誤報告。
ErrorReportingAutomaticUploadEnabled
布林值
指定是否啟用參與客戶經驗改進計畫 (CEIP)。 CEIP 之目的是改進 Microsoft 產品和技術的品質、可靠性和執行效能。 經由您的許可,關於您伺服器的匿名資訊將會傳送至 Microsoft,以協助我們改進 SharePoint Server。
DownloadErrorReportingUpdatesEnabled
布林值
指定錯誤報告是否自動上傳至 Microsoft。 錯誤報告包括:伺服器發生問題時,作業系統版本和電腦硬體使用及數位產品 ID,可以用來識別您的授權條件相關資訊。
附註:
因為您連線到線上服務傳送錯誤報告,這也會傳送您的電腦的 IP 位址;不過,IP 位址只用於產生彙總的統計資料。
DaysToKeepLogs
整數
指定追蹤記錄檔要保留的天數。 此類型必須是 1 到 366 之間的有效數字。 預設值為 14 天。
LogMaxDiskSpaceUsageEnabled
布林值
指定是否要限制用於追蹤記錄檔的空間上限。
LogDiskSpaceUsageGB
整數
指定用於追蹤記錄檔的儲存量上限,以 GB 計。 預設值為 1000,且只有在 LogMaxDiskSpaceusageEnabled 參數設為 True 時才生效。 此類型必須是 1 到 1000 之間的有效數字。
LogLocation
字串:路徑
這是您想要儲存的記錄檔的位置的完整路徑。 可以是遠端位置。 範例:「%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\16\LOGS」 和 「%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\LOGS」
LogCutInterval
整數
指定變換成下一份記錄檔案的時間。 此類型必須是 0 到 1440 之間的有效數字。
EventLogFloodProtectionEnabled
布林值
指定是否啟用防止事件記錄檔濫記功能。 如果將多個類似事件寫入事件記錄檔,則會隱藏一些重複的訊息。 一段時間之後,摘要訊息會顯示已隱藏的事件數目。
EventLogFloodProtectionThreshold
整數
指定設定時間範圍內允許的事件數,超過此數即視為事件記錄檔濫記的事件。 整數的範圍介於 1 到 100 之間。 預設值為 5。
EventLogFloodProtectionTriggerPeriod
整數
指定留意可能濫記事件的時間範圍,以分鐘計。 整數的範圍介於 1 到 1440 之間。 預設值為 2。
EventLogFloodProtectionQuietPeriod
整數
指定不激發事件即結束防止濫記的時間,以分鐘計。 整數的範圍介於 1 到 1440 之間。 預設值為 2。
EventLogFloodProtectionNotifyInterval
整數
指定以分鐘計的摘要事件寫入頻率,指出因防止濫記而隱藏的事件數。 整數的範圍介於 1 到 1440 之間。 預設值為 5。
ScriptErrorReportingEnabled
布林值
啟用或停用記錄檔中的指令碼錯誤的報告。
ScriptErrorReportingRequireAuth
布林值
指定指令碼錯誤報告是否需要驗證。
ScriptErrorReportingDelay
整數
以分鐘計,指定指令碼錯誤報告的間隔時間。 此值必須是 0 到 1440 之間的有效整數。 此值以分鐘為單位。 預設值為 30。

使用下表進行 UsageServices 設定。

UsageServices 設定中的項目

名稱 值類型 附註
ID
GUID: 唯讀
格式為 12345678-90ab-cdef-1234-567890bcdefgh 的 GUID
UsageLogLocation
路徑
指定要建立流量檔案之伺服器陣列中每部電腦的路徑。 在伺服器陣列中的所有電腦上必須要有相同的路徑。
LoggingEnabled
布林值
指定記錄至流量檔案的流量資料。
UsageLogMaxFileSizeKB
整數
指定套用至所有流量提供者之單一流量檔案的大小上限。 最小值為 512 KB,而最大值為 65536 KB。
UsageLogCutTime
整數
以分鐘為單位,指定每個流量記錄檔收集流量資料的時間。 預設時間為 5 分鐘。 此值必須為整數,且介於 1 到 1440 之間。

使用下表進行 UsageDefinition 設定。

UsageDefinition 設定中的項目

名稱 值類型 附註
ID
GUID: 唯讀
格式為 12345678-90ab-cdef-1234-567890bcdefgh 的 GUID
名稱
字串: 唯讀
UsageDefinition 的字串名稱。
DaysRetained
整數
指定使用狀況提供者在使用服務資料庫中可保留使用資料的天數。 預設值為 14。 此類型必須是介於 0 與 31 之間的整數。
DaysToKeepUsageFiles
整數
指定要保留檔案使用情況的天數。 此值必須小於或等於 DaysRetained 參數值。
已啟用
布林值
啟用或停用指定的使用情況提供者。

使用下表進行 LogLevel 設定。

元素的 LogLevel 設定

名稱 值類型 附註
區域
字串: 唯讀
元件或 LogLevel 會套用到的服務。
身分識別
字串: 唯讀
指定類別或一組類別的名稱用以設定節流,例如,「整合記錄服務」。
附註:
如果未指定 Identity 參數,調整事件流速的設定會套用至伺服器陣列中的所有類別。
EventSeverity
字串:[無 | ErrorCritical |錯誤 |警告 |資訊 |詳細資訊]
指定要設定的類別層級。 類別層級是其中一個下列值:[無 | ErrorCritical |錯誤 |警告 |資訊 |詳細資訊]
TraceSeverity
字串:[無 | 未預期 |可監控 | 高 |中 | 詳細資訊 | VerboseX]
指定所指定之類別要設定的追蹤節流。 追蹤記錄檔案是寫入追蹤記錄路徑的文字檔案,此路徑是在 SharePoint 管理中心網站 的 [診斷記錄設定] 頁面中定義。 此類型必須是下列任一值:[無 | 未預期 |可監控 | 高 |中 | 詳細資訊 | VerboseX]

使用下表進行 TimerJob 設定。

TimerJob 設定中的項目

名稱 值類型 附註
身分識別
GUID: 唯讀
指定要更新的計時器工作。 此類型必須是格式為 12345678-90ab-cdef-1234-567890bcdefgh 的有效 GUID。
排程
字串
指定執行計時器工作的排程。 此類型必須是有效的 SharePoint 計時器服務 (SPTimer) 排程,格式為下列任一排程:在 15:00:00,星期五之間,每週的每天每隔 5 分鐘介於 0 到 59 之間,每小時介於 0 和 59,22:00:00 和週日 06:00:00,每月 15 15:00:00 和每年在 1 年 1 月 15:00:00
已啟用
布林值
啟用或停用計時器工作

使用下表進行 HealthAnalyzerRule 設定。

HealthAnalyzerRule 設定中的項目

名稱 值類型 附註
身分識別
GUID: 唯讀
指定要設定的狀況分析規則名稱或 GUID。
啟用
布林值
啟用或停用狀況分析規則

建立設定檔

您可以建立無數個設定檔。 每個設定檔可能會用於不同的用途,例如在對環境進行特定變更之前增加監視的層級,或在變更後到較低的層級。

您只需要建立想要的特定變更的設定檔項目。 其他的設定將維持不變。 例如,如果您想要變更一些 LogLevel 設定,然後您只需要在設定檔中指定這些設定。 未指定設定檔中的設定將不會變更。

您可能想要使用您的設定檔的命名慣例,以便您可以將它們組織,並更輕易地使用。

重要事項

[!重要事項] 永遠在對監視設定進行任何變更前備份。 總是從備份設定檔的複本運作,而且絕不會從原始的備份檔案本身運作。

另請參閱

概念

SharePoint Server 中的已編寫監視設定指令碼概觀

在 SharePoint Server 執行已編寫監視設定指令碼