適用対象:
2016 2019 Subscription Edition 
SharePoint in Microsoft 365
SharePoint ファームで BackupMonitoringSettings.ps1 Microsoft PowerShell スクリプトを実行すると、プロファイルというファイルを作成できます。 プロファイルは XML スキーマに従っています。 スキーマの要素の設定を変更して、カスタム プロファイルを作成することができます。 その後、カスタム プロファイルを使用して、SharePoint 環境で監視設定の構成を自動化することができます。 スクリプト化された監視構成の概要については、「SharePoint Server のスクリプト化された監視構成の概要」を参照してください。
管理者は、ファームのトポロジ、主なセキュリティ上の変更、ソフトウェアの更新プログラムの適用、またはパフォーマンス テストの実行など、ファームの変更前、変更中、および変更後にスクリプトを実行することができます。 スクリプトは、通常操作中にログ データベースがオーバーフローすることなく、すべての必要な監視データイベント中に収集されるように監視設定を変更します。
注:
ファームの監視設定をバックアップ、復元、または変更するには、PowerShell スクリプトをダウンロードする必要があります。 スクリプトは、TechNet ギャラリーの スクリプト監視構成 - BackupMonitoringSettings と スクリプト化された監視構成 - AlterMonitoringSettings にあります。 BackupMonitoringSettings.ps1PowerShell スクリプトは、バックアップ プロファイルを作成して、そこから他のプロファイルを作成します。
1 つ以上のプロファイルを作成して、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 は、マイクロソフト製品とテクノロジの品質、信頼性、およびパフォーマンスの向上を目的として設計されています。 ユーザーの許可を得て、ユーザーのサーバーに関する匿名情報がマイクロソフトに送信され、SharePoint Server の改善に役立てられます。 |
| DownloadErrorReportingUpdatesEnabled |
ブール値 |
エラー報告をマイクロソフトに自動的にアップロードするかどうかを指定します。 エラー レポートには、問題が発生したときのサーバーの状態に関する情報、使用中のオペレーティング システムのバージョンとコンピューター のハードウェア、ライセンスを識別するために使用できるデジタル製品 ID が含まれます。 注: オンライン サービスに接続してエラー報告を送信しているため、コンピューターの IP アドレスも送信されます。ただし、IP アドレスは、集計した統計の生成にのみ使用されます。 |
| DaysToKeepLogs |
整数 |
トレース ログ ファイルを保持する日数を指定します。 この型は、1 ～ 366 の有効な数値であることが必要です。 既定値は 14 日です。 |
| LogMaxDiskSpaceUsageEnabled |
ブール値 |
トレース ログファイルに使用する最大容量を制限するかどうかを指定します。 |
| LogDiskSpaceUsageGB |
整数 |
トレース ログ ファイルに使用する記憶域の最大値 (GB 単位) を指定します。 既定値は 1000 で、LogMaxDiskSpaceusageEnabled パラメーターが True に設定されている場合にのみ有効になります。 この型は、1 ～ 1,000 の有効な整数であることが必要です。 |
| LogLocation |
文字列パス |
これは、ログ ファイルを格納する場所への完全パスです。 リモートの場所を指定できます。 例: "%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\16\LOGS" と "%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\LOGS" |
| LogCutInterval |
整数 |
次のログ ファイルにロール オーバーする期間を指定します。 この型は、0 ～ 1,440 の有効な数であることが必要です。 |
| EventLogFloodProtectionEnabled |
ブール値 |
イベント ログのオーバーフロー保護機能を有効にするかどうかを指定します。 複数の類似イベントをイベント ログに書き込む場合、重複するメッセージの表示が抑制されます。 一定期間後に、抑制したイベントの数が概要メッセージに表示されます。 |
| EventLogFloodProtectionThreshold |
整数 |
イベント ログのオーバーフローと判断されるまでに一定期間内で許容されるイベント数を指定します。 この整数の範囲は、1 ～ 100 です。 既定値は 5 です。 |
| EventLogFloodProtectionTriggerPeriod |
整数 |
イベントのオーバーフローを監視する期間を指定します (分単位)。 この整数の範囲は、1 ～ 1,440 です。 既定値は 2 です。 |
| EventLogFloodProtectionQuietPeriod |
整数 |
イベントが発生しなくなってからオーバーフロー保護を終了するまでの期間を指定します (分単位)。 この整数の範囲は、1 ～ 1,440 です。 既定値は 2 です。 |
| EventLogFloodProtectionNotifyInterval |
整数 |
オーバーフロー保護のために抑制したイベント数を示す概要イベントを書き込む頻度を指定します (分単位)。 この整数の範囲は、1 ～ 1,440 です。 既定値は 5 です。 |
| ScriptErrorReportingEnabled |
ブール値 |
ログ ファイル内のスクリプト エラーの報告を有効または無効にします。 |
| ScriptErrorReportingRequireAuth |
ブール値 |
スクリプト エラー報告で認証が必要かどうかを指定します。 |
| ScriptErrorReportingDelay |
整数 |
スクリプト エラー報告の間隔 (分単位) を指定します。 この値は、0 ～ 1,440 の有効は整数であることが必要です。 値は分単位で指定します。 既定値は 30 です。 |
UsageServices の設定には、次の表を使用します。
UsageServices の設定の要素
| 名前 | 値の種類 | メモ |
|---|---|---|
| ID |
GUID: 読み取り専用 |
12345678-90ab-cdef-1234-567890bcdefgh の形式の GUID。 |
| UsageLogLocation |
パス |
ファーム内の各コンピューター上で利用状況のログ ファイルを作成するパスを指定します。 ファーム内のすべてのコンピューターに同じパスが存在する必要があります。 |
| LoggingEnabled |
ブール値 |
利用状況データを利用状況ファイルに記録することを指定します。 |
| UsageLogMaxFileSizeKB |
整数 |
すべての利用状況プロバイダーに適用される 1 つの利用状況ファイルの最大サイズを指定します。 最小値は 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 の適用先のコンポーネントまたはサービス。 |
| ID |
文字列: 読み取り専用 |
スロットルを設定するカテゴリまたはカテゴリ セットの名前 ("Unified Logging Service" など) を指定します。 注: Identity パラメーターを指定しない場合は、記録されるイベント スロットルの設定がファーム内のすべてのカテゴリに適用されます。 |
| EventSeverity |
文字列: [None | ErrorCritical |Error | Warning |Information | Verbose] |
設定するカテゴリ レベルを指定します。 カテゴリ レベルは、次のいずれかの値です:[None |ErrorCritical |エラー |警告 |情報 |Verbose] |
| TraceSeverity |
文字列: [None | Unexpected |Monitorable | High |Medium | Verbose | VerboseX] |
指定したカテゴリを に設定するトレース スロットルを指定します。 トレース ログ ファイルは、SharePoint サーバーの全体管理 Web サイトの [診断ログの設定] ページで定義されているトレース ログ パスに書き込まれるテキスト ファイルです。 型は、次のいずれかの値である必要があります::[None |予期しない |監視可能 |高 |中 |Verbose |VerboseX] |
TimerJob の設定には、次の表を使用します。
TimerJob の設定の要素
| 名前 | 値の種類 | メモ |
|---|---|---|
| ID |
GUID: 読み取り専用 |
更新するタイマー ジョブを指定します。 この型には、12345678-90ab-cdef-1234-567890bcdefgh の形式の有効な GUID を指定する必要があります。 |
| スケジュール |
String |
タイマー ジョブの実行スケジュールを指定します。 種類は、次のいずれかのスケジュールの形式で有効な SharePoint Timer サービス (SPTimer) スケジュールである必要があります。0 から 59 の間の 5 分ごと、 0 から 59 の時間単位、毎日 15:00:00、毎週 22:00:00 から日 06:00:00、月次 15:00:00、1 月 1 日 15:00:00 |
| 有効 |
ブール値 |
タイマー ジョブを有効または無効にします。 |
HealthAnalyzerRule の設定には、次の表を使用します。
HealthAnalyzerRule の設定の要素
| 名前 | 値の種類 | メモ |
|---|---|---|
| ID |
GUID: 読み取り専用 |
設定する Health Analyzer ルールの名前または GUID を指定します。 |
| 有効 |
ブール値 |
Health Analyzer ルールを有効または無効にします。 |
プロファイルの作成
プロファイルは無制限に作成できます。 各プロファイルは、環境に特定の変更を加える前に監視レベルを上げたり、変更後にレベルを下げたりするなどのさまざまな目的に使用されることがあります。
加える特定の変更に対してプロファイルのエントリを作成することのみが必要になります。 その他の設定に変更はありません。 たとえば、いくつかの LogLevel 設定を変更する場合、プロファイルにこの設定を指定することのみが必要になります。 プロファイルに指定されていない設定は変更されません。
プロファイルを整理して使いやすくするように、名前付け規則を使用することができます。
重要
変更を加える前に必ず監視設定をバックアップしてください。 必ずバックアップ プロファイルのコピーから作業し、バックアップ元のファイル自体からは作業しないでください。