エラー定義 <failureDefinitions>

[アーティクル]
08/25/2009

概要
互換性
セットアップ
方法
構成
サンプルコード

※本ページに挿入されている画像をクリックすると、画像全体が別ウィンドウで表示されます。

概要

<httpProtocol> 要素の <customHeaders> 要素は、インターネットインフォメーションサービス (IIS) 7.0 で Web サーバーから HTTP 応答内で返されるカスタム HTTP ヘッダーを指定します。

注 : HTTP ヘッダーは、Web サーバーからの応答で返された名前と値のペアです。カスタム応答ヘッダーは、既定の HTTP ヘッダーと共にクライアントに送信されます。リダイレクトが発生した場合にのみ応答で返されるリダイレクト応答ヘッダーと異なり、カスタム応答ヘッダーはどの応答においても必ず返されます。

<failureDefinitions> 要素は、要求のトレースを行う状態を定義します。エラー状態には、状態コード、時間間隔、またはその両方の組み合わせが含まれます。また、トレースの詳細レベルも指定できます。

注 : 詳細オプションをさらに追加することにより、トレースログ内により多くの情報を返すように IIS を構成できますが、詳細なログが巨大になる可能性があります。ログファイルのサイズが <traceFailedRequestsLogging> 要素の maxLogFileSizeKB 属性で定義されたファイルの最大サイズを超えた場合、そのログファイルは最大サイズで切り捨てられるため、この属性で指定されたファイルサイズを増やす必要が生じます。

互換性

	IIS 7.0	IIS 6.0
注意	`<failureDefinitions>` は IIS 7.0 で新たに導入された要素です。	なし

セットアップ

IIS 7.0 の既定のインストールが終了したら、失敗した要求トレースを使用するために、トレースの役割サービスをインストールする必要があります。また、当該役割サービスをインストールした後には、失敗した要求トレースをサイトレベル、アプリケーションレベル、またはディレクトリレベルで有効にする必要があります。

Windows Server 2008

タスクバーで [スタート] ボタンをクリックし、[管理ツール] をポイントして [サーバーマネージャー] をクリックします。
[サーバーマネージャー] ウィンドウのツリー表示で、[役割] を展開して [Web サーバー (IIS)] をクリックします。
[Web サーバー (IIS)] ウィンドウで、[役割サービス] セクションまでスクロールして [役割サービスの追加] をクリックします。
役割サービスの追加ウィザードの [役割サービスの選択] ページで、[追跡] を選択して、[次へ] をクリックします。
[インストールオプションの確認] ページで [インストール] をクリックします。
[結果] ページで [閉じる] をクリックします。

Windows Vista

タスクバーで [スタート] ボタンをクリックし、[コントロールパネル] をクリックします。
コントロールパネルで、[プログラムと機能]、[Windows の機能の有効化または無効化] の順にクリックします。
[Internet Information Services]、[World Wide Web サービス]、[健常性と診断] の順に展開します。
[追跡] を選択して、[OK] をクリックします。

方法

トレースを有効にする方法

タスクバーで [スタート] ボタンをクリックし、[管理ツール] をポイントして [インターネットインフォメーションサービス (IIS) マネージャー] をクリックします。
[接続] ウィンドウで、失敗した要求トレースを構成するサーバー接続、サイト、アプリケーション、またはディレクトリを選択します。
[操作] ウィンドウで [失敗した要求トレース] をクリックします。
[Web サイトの失敗した要求トレース設定の編集] ダイアログボックスで、[有効にする] チェックボックスをオンにしてトレースを有効にします。[ディレクトリ] ボックスは、既定値のままにするか、失敗した要求ログファイルを保存する新しいディレクトリを入力します。[トレースファイルの最大数] ボックスには、失敗した要求のトレースファイルを保存する数を入力して、[OK] をクリックします。

エラー定義の構成方法

タスクバーで [スタート] ボタンをクリックし、[管理ツール] をポイントして [インターネットインフォメーションサービス (IIS) マネージャー] をクリックします。
[接続] ウィンドウで、失敗した要求トレースを構成する接続、サイト、アプリケーション、またはディレクトリに移動します。
[ホーム] ウィンドウで [失敗した要求トレースの規則] をダブルクリックします。
[操作] ウィンドウで [追加] をクリックします。
失敗した要求トレース規則の追加ウィザードの [トレースするコンテンツの指定] ページで、トレースするコンテンツの種類を選択し、[次へ] をクリックします。
[トレース条件の定義] ページで、トレースする条件を選択して、[次へ] をクリックします。トレース条件は、状態コード、要求に応じる制限時間、またはイベントの重大度をどのように組み合わせてもかまいません。すべての条件を指定すると、適合した最初の条件によって、失敗した要求のトレースログファイルが生成されます。
[トレースプロバイダーの選択] ページで、[プロバイダー] の下のトレースプロバイダーを 1 つ以上選択します。
[トレースプロバイダーの選択] ページで、[詳細] の下の詳細レベルを 1 つ以上選択します。
手順 8 で [ASPNET] または [WWW Server] トレースプロバイダーを選択した場合は、[トレースプロバイダーの選択] ページの [領域] の下で、当該プロバイダーがトレースする機能領域を 1 つ以上選択します。
[完了] をクリックします。

構成

属性

属性説明

statusCodes オプションの string 属性。

トレースする状態コードを指定します。このリストには、各コードをコンマで区切って、状態コードを複数入力できます。また、副状態コード ("404.2, 500" など) または副状態コードの範囲 ("400-599" など) を使用して、状態コードを絞り込むこともできます。副状態コードを指定しないと、指定された状態コードに対するすべての副状態コードがトレースされます。状態コードは 100 から 999、副状態コードは 1 から 999 となります。

timeTaken オプションの timeSpan 属性。

ある要求の処理に費やすことができる最長時間を指定します。この時間を過ぎると、要求は失敗したとマークされ、トレースされるようになります。

既定値は 00:00:00 です。

属性	説明
`statusCodes`	オプションの string 属性。トレースする状態コードを指定します。このリストには、各コードをコンマで区切って、状態コードを複数入力できます。また、副状態コード ("404.2, 500" など) または副状態コードの範囲 ("400-599" など) を使用して、状態コードを絞り込むこともできます。副状態コードを指定しないと、指定された状態コードに対するすべての副状態コードがトレースされます。状態コードは 100 から 999、副状態コードは 1 から 999 となります。
`timeTaken`	オプションの timeSpan 属性。ある要求の処理に費やすことができる最長時間を指定します。この時間を過ぎると、要求は失敗したとマークされ、トレースされるようになります。既定値は `00:00:00` です。
`verbosity`	オプションの enum 属性。トレースログに記録する情報の最小量と情報の種類を指定します。verbosity 属性を Error に設定すると、verbosity が Error または CriticalError に設定されたトレースイベントを最初に受信したときに、その要求に対する失敗した要求のトレースログファイルが作成されます。 verbosity 属性には、次のいずれかの値を指定できます。既定値は `Ignore` です。 -------------------------------------------------------------------------------------------------- 値: Ignore 説明: 要求アクティビティに関する情報を提供しません。数値は 0 です。値:CriticalError 説明: プロセスの終了を引き起こす可能性のあるアクション、またはプロセスの終了を引き起こそうとしているアクションに関する情報を提供します。数値は 1 です。値: Error 説明: エラーが発生し、要求の処理を継続できないコンポーネントに関する情報を提供します。通常、このエラーはサーバー側の問題を示します。数値は 2 です。値: Warning 説明: エラーが発生したが、要求の処理は継続できるコンポーネントに関する情報を提供します。数値は 3 です。

verbosity

オプションの enum 属性。

トレースログに記録する情報の最小量と情報の種類を指定します。verbosity 属性を Error に設定すると、verbosity が Error または CriticalError に設定されたトレースイベントを最初に受信したときに、その要求に対する失敗した要求のトレースログファイルが作成されます。

verbosity 属性には、次のいずれかの値を指定できます。

既定値は Ignore です。

--------------------------------------------------------------------------------------------------

値: Ignore

説明:

要求アクティビティに関する情報を提供しません。
数値は 0 です。

値:CriticalError

説明:

プロセスの終了を引き起こす可能性のあるアクション、またはプロセスの終了を引き起こそうとしているアクションに関する情報を提供します。
数値は 1 です。

値: Error

説明:

エラーが発生し、要求の処理を継続できないコンポーネントに関する情報を提供します。通常、このエラーはサーバー側の問題を示します。
数値は 2 です。

値: Warning

説明:

エラーが発生したが、要求の処理は継続できるコンポーネントに関する情報を提供します。
数値は 3 です。

子要素

なし。

構成サンプル

次の構成サンプルでは、サーバーレベルのトレースを ApplicationHost.config ファイルで構成しています。すべての .aspx ファイルに対するトレースを設定し、<traceAreas> 要素を使用して ASPNET プロバイダーを設定して、ASP.NET のすべての領域 (Infrastructure、Module、Page、および AppServices) をトレースします。また、verbosity 属性を使用して、トレースファイルに返される情報量を warning に設定しています。最後に、<failureDefinitions> 要素を使用して、HTTP 404 状態コードを生成する要求のみをトレースするように定義しています。

<tracing>
   <traceFailedRequests>
      <add path="*.aspx">
         <traceAreas>
            <add provider="ASPNET" areas="Infrastructure,Module,Page,AppServices" verbosity="Warning" />
         </traceAreas>

         <failureDefinitions statusCodes="404" />
      </add>
   </traceFailedRequests>
</tracing>

サンプルコード

次の例では、*.aspx ページに対するすべての要求で、ASP.NET コンテンツ内の HTTP 500 エラーに対して、詳細な失敗した要求トレースが有効化されます。

AppCmd.exe

appcmd.exe set config "Contoso" -section:system.webServer/tracing/traceFailedRequests /+"[path='*.aspx']" 

appcmd.exe set config "Contoso" -section:system.webServer/tracing/traceFailedRequests /+"[path='*.aspx'].traceAreas.[provider='ASPNET',areas='Infrastructure,Module,Page,AppServices',verbosity='Verbose']" 

appcmd.exe set config "Contoso" -section:system.webServer/tracing/traceFailedRequests /[path='*.aspx'].failureDefinitions.statusCodes:"500"

C#

using System;
using System.Text;
using Microsoft.Web.Administration;

internal static class Sample
{
   private static void Main()
   {
      using (ServerManager serverManager = new ServerManager())
      {
         Configuration config = serverManager.GetWebConfiguration("Contoso");
         ConfigurationSection traceFailedRequestsSection = config.GetSection("system.webServer/tracing/traceFailedRequests");
         ConfigurationElementCollection traceFailedRequestsCollection = traceFailedRequestsSection.GetCollection();

         ConfigurationElement addElement = traceFailedRequestsCollection.CreateElement("add");
         addElement["path"] = @"*.aspx";

         ConfigurationElementCollection traceAreasCollection = addElement.GetCollection("traceAreas");
         ConfigurationElement addElement1 = traceAreasCollection.CreateElement("add");
         addElement1["provider"] = @"ASPNET";
         addElement1["areas"] = @"Infrastructure,Module,Page,AppServices";
         addElement1["verbosity"] = @"Verbose";
         traceAreasCollection.Add(addElement1);

         ConfigurationElement failureDefinitionsElement = addElement.GetChildElement("failureDefinitions");
         failureDefinitionsElement["statusCodes"] = @"500";
         traceFailedRequestsCollection.Add(addElement);

         serverManager.CommitChanges();
      }
   }
}

VB.NET

Imports System
Imports System.Text
Imports Microsoft.Web.Administration

Module Sample
   Sub Main()
      Dim serverManager As ServerManager = New ServerManager
      Dim config As Configuration = serverManager.GetWebConfiguration("Contoso")
      Dim traceFailedRequestsSection As ConfigurationSection = config.GetSection("system.webServer/tracing/traceFailedRequests")
      Dim traceFailedRequestsCollection As ConfigurationElementCollection = traceFailedRequestsSection.GetCollection

      Dim addElement As ConfigurationElement = traceFailedRequestsCollection.CreateElement("add")
      addElement("path") = "*.aspx"
      Dim traceAreasCollection As ConfigurationElementCollection = addElement.GetCollection("traceAreas")
      Dim addElement1 As ConfigurationElement = traceAreasCollection.CreateElement("add")
      addElement1("provider") = "ASPNET"
      addElement1("areas") = "Infrastructure,Module,Page,AppServices"
      addElement1("verbosity") = "Verbose"
      traceAreasCollection.Add(addElement1)

      Dim failureDefinitionsElement As ConfigurationElement = addElement.GetChildElement("failureDefinitions")
      failureDefinitionsElement("statusCodes") = "500"
      traceFailedRequestsCollection.Add(addElement)

      serverManager.CommitChanges()
   End Sub
End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST/Contoso";
var traceFailedRequestsSection = adminManager.GetAdminSection("system.webServer/tracing/traceFailedRequests", "MACHINE/WEBROOT/APPHOST/Contoso");
var traceFailedRequestsCollection = traceFailedRequestsSection.Collection;

var addElement = traceFailedRequestsCollection.CreateNewElement("add");
addElement.Properties.Item("path").Value = "*.aspx";
var traceAreasCollection = addElement.ChildElements.Item("traceAreas").Collection;

var addElement1 = traceAreasCollection.CreateNewElement("add");
addElement1.Properties.Item("provider").Value = "ASPNET";
addElement1.Properties.Item("areas").Value = "Infrastructure,Module,Page,AppServices";
addElement1.Properties.Item("verbosity").Value = "Verbose";
traceAreasCollection.AddElement(addElement1);

var failureDefinitionsElement = addElement.ChildElements.Item("failureDefinitions");
failureDefinitionsElement.Properties.Item("statusCodes").Value = "500";
traceFailedRequestsCollection.AddElement(addElement);

adminManager.CommitChanges();

VBScript

Set adminManager = createObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST/Contoso"
Set traceFailedRequestsSection = adminManager.GetAdminSection("system.webServer/tracing/traceFailedRequests", "MACHINE/WEBROOT/APPHOST/Contoso")
Set traceFailedRequestsCollection = traceFailedRequestsSection.Collection

Set addElement = traceFailedRequestsCollection.CreateNewElement("add")
addElement.Properties.Item("path").Value = "*.aspx"
Set traceAreasCollection = addElement.ChildElements.Item("traceAreas").Collection

Set addElement1 = traceAreasCollection.CreateNewElement("add")
addElement1.Properties.Item("provider").Value = "ASPNET"
addElement1.Properties.Item("areas").Value = "Infrastructure,Module,Page,AppServices"
addElement1.Properties.Item("verbosity").Value = "Verbose"
traceAreasCollection.AddElement addElement1

Set failureDefinitionsElement = addElement.ChildElements.Item("failureDefinitions")
failureDefinitionsElement.Properties.Item("statusCodes").Value = "500"
traceFailedRequestsCollection.AddElement addElement

adminManager.CommitChanges()

次の方法で共有

エラー定義 <failureDefinitions>

概要

互換性

セットアップ

Windows Server 2008

Windows Vista

方法

トレースを有効にする方法

エラー定義の構成方法

構成

属性

子要素

構成サンプル

サンプルコード

AppCmd.exe

C#

VB.NET

JavaScript

VBScript

その他のリソース

次の方法で共有

エラー定義 <failureDefinitions>

概要

互換性

セットアップ

Windows Server 2008

Windows Vista

方法

トレースを有効にする方法

エラー定義の構成方法

構成

属性

子要素

構成サンプル

サンプル コード

AppCmd.exe

C#

VB.NET

JavaScript

VBScript

その他のリソース

サンプルコード