アプリケーション プールのエラー設定 <failure>

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

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

概要

<applicationPools> コレクション内の <add> 要素の <failure> 要素は、アプリケーション プールで障害が発生したときに行う操作を構成します。<failure> 要素の autoShutdownExe 属性、orphanActionExe 属性、および rapidFailProtection 属性は、アプリケーションのトラブルシューティングやデバッグを行う上で特に役立つ属性です。これは、この属性を使用することにより、外部実行可能ファイルを実行してエラーのロギングやデバッグを行うなど、アプリケーションで障害が発生したときにインターネット インフォメーション サービス (IIS) 7.0 で行う操作を柔軟に指定できるためです。

互換性

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

<failure> 要素は、IIS 6.0 の IIsApplicationPools メタベース プロパティの一部に代わるものです。

セットアップ

<applicationPools> コレクションは、IIS 7.0 の既定のインストールに含まれています。

方法

ラピッド フェール保護構成設定の編集方法

  1. タスク バーで [スタート] ボタンをクリックし、[管理ツール] をポイントして [インターネット インフォメーション サービス (IIS) マネージャー] をクリックします。

  2. [接続] ウィンドウで当該サーバー名を展開して [アプリケーション プール] をクリックし、編集するアプリケーション プールをクリックします。

    拡大

  3. [操作] ウィンドウで [詳細設定] をクリックします。

  4. [詳細設定] ダイアログ ボックスで、編集するラピッド フェール保護プロパティをクリックし、ダイアログ ボックスのプロパティ値のセクションで値を編集して、[OK] をクリックします。たとえば、[エラー間隔 (分)] を 4 に変更し、[最大エラー数] を 4 に変更します。

    拡大

構成

属性

属性 説明
autoShutdownExe オプションの string 属性。

WWW サービスでアプリケーション プールがシャットダウンしたときに実行する実行可能ファイルを指定します。実行可能ファイルにパラメーターを送るには、autoShutdownParams 属性を使用します。

autoShutdownParams オプションの string 属性。

autoShutdownExe 属性で指定された実行可能ファイルに対するコマンドライン パラメーターを指定します。

loadBalancerCapabilities オプションの enum 属性。

要求キューがいっぱいになったとき、またはアプリケーション プールがラピッド フェール保護の状態にあるときなど、ワーカー プロセスを開始できないときの動作を指定します。loadBalancerCapabilities 属性には、次のいずれかの値を指定できます。既定値は HttpLevel です。



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

値: HttpLevel

説明:

  • エラー コード 503 が返されるように指定します。HTTP に対応していない負荷分散装置の場合は、別のノードに切り替わりません。これは、503 応答から負荷分散装置に、コンピューターが良好であると伝えられるためです。
  • 数値は 2 です。

値: TcpLevel

説明:

  • TCP 接続を終了するように指定します。これは、HTTP に対応していない負荷分散装置を使用している場合に役立ちます。
  • 数値は 1 です。
orphanActionExe オプションの string 属性。

WWW サービスでワーカー プロセスが孤立化したときに実行する実行可能ファイルを指定します (orphanWorkerProcess 属性が true に設定されている場合)。実行可能ファイルにパラメーターを送るには、orphanActionParams 属性を使用します。

orphanActionParams オプションの string 属性。

orphanActionExe 属性で指定された実行可能ファイルに対するコマンドライン パラメーターを指定します。孤立化したプロセスのプロセス ID を指定する場合は、%1% を使用します。

orphanWorkerProcess オプションの Boolean 属性。

アプリケーション プールで障害が発生したときに、ワーカー プロセスを終了するのではなく、孤立した状態にするかどうかを指定します。

既定値は false です。

rapidFailProtection オプションの Boolean 属性。

true に設定すると、次の状態になった場合に、アプリケーション プール内のすべてのアプリケーションが WWW サービスから削除されます。

  • ワーカー プロセスのクラッシュ数が、rapidFailProtectionMaxCrashes 属性で指定された最大値に達した場合。
  • そのクラッシュが、rapidFailProtectionInterval 属性で指定された時間内 (分) に発生した場合。

既定値は true です。

rapidFailProtectionInterval オプションの timeSpan 属性。

プロセスのエラー数がリセットされるまでの時間を分単位で指定します。

既定値は 00:05:00 (5 分) です。

rapidFailProtectionMaxCrashes オプションの uint 属性。

rapidFailProtectionInterval 属性で指定された時間内 (分) に許容される、エラーの最大数を指定します。

既定値は 5 です。

子要素

なし。

構成サンプル

次の構成サンプルでは、DefaultAppPool という単一のアプリケーション プールに対するラピッド フェール保護を有効にし、ラピッド フェール保護の間隔を 5 分に構成して、その時間内 (分) に発生するエラーの最大数を 5 に設定しています。

<applicationPools>
   <add name="DefaultAppPool">
     <failure rapidFailProtection="true"
        rapidFailProtectionInterval="00:05:00"
        rapidFailProtectionMaxCrashes="5" />
   </add>
   <applicationPoolDefaults>
     <processModel identityType="NetworkService" />

   </applicationPoolDefaults>
</applicationPools>

サンプル コード

次のコード サンプルでは、サーバー上の DefaultAppPool に対するラピッド フェール保護を有効にし、保護の間隔を 5 分、クラッシュの最大数を 5 に設定しています。

AppCmd.exe

appcmd.exe set config -section:system.applicationHost/applicationPools /[name='DefaultAppPool'].failure.rapidFailProtection:"True" /commit:apphost

appcmd.exe set config -section:system.applicationHost/applicationPools /[name='DefaultAppPool'].failure.rapidFailProtectionInterval:"00:05:00" /commit:apphost

appcmd.exe set config -section:system.applicationHost/applicationPools /[name='DefaultAppPool'].failure.rapidFailProtectionMaxCrashes:"5" /commit:apphost

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.GetApplicationHostConfiguration();
         ConfigurationSection applicationPoolsSection = config.GetSection("system.applicationHost/applicationPools");
         ConfigurationElementCollection applicationPoolsCollection = applicationPoolsSection.GetCollection();
         ConfigurationElement addElement = FindElement(applicationPoolsCollection, "add", "name", @"DefaultAppPool");
         if (addElement == null) throw new InvalidOperationException("Element not found!");

         ConfigurationElement failureElement = addElement.GetChildElement("failure");
         failureElement["rapidFailProtection"] = true;
         failureElement["rapidFailProtectionInterval"] = TimeSpan.Parse("00:05:00");
         failureElement["rapidFailProtectionMaxCrashes"] = 5;
         serverManager.CommitChanges();
      }
   }

   private static ConfigurationElement FindElement(ConfigurationElementCollection collection, string elementTagName, params string[] keyValues)
   {
      foreach (ConfigurationElement element in collection)
      {
         if (String.Equals(element.ElementTagName, elementTagName, StringComparison.OrdinalIgnoreCase))
         {
            bool matches = true;
            for (int i = 0; i < keyValues.Length; i += 2)
            {
               object o = element.GetAttributeValue(keyValues[i]);
               string value = null;
               if (o != null)
               {
                  value = o.ToString();
               }
               if (!String.Equals(value, keyValues[i + 1], StringComparison.OrdinalIgnoreCase))
               {
                  matches = false;
                  break;
               }
            }
            if (matches)
            {
               return element;
            }
         }
      }
      return null;
   }
}

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.GetApplicationHostConfiguration
      Dim applicationPoolsSection As ConfigurationSection = config.GetSection("system.applicationHost/applicationPools")
      Dim applicationPoolsCollection As ConfigurationElementCollection = applicationPoolsSection.GetCollection
      Dim addElement As ConfigurationElement = FindElement(applicationPoolsCollection, "add", "name", "DefaultAppPool")

      If (addElement Is Nothing) Then
         Throw New InvalidOperationException("Element not found!")
      End If

      Dim failureElement As ConfigurationElement = addElement.GetChildElement("failure")
      failureElement("rapidFailProtection") = True
      failureElement("rapidFailProtectionInterval") = TimeSpan.Parse("00:05:00")
      failureElement("rapidFailProtectionMaxCrashes") = 5

      serverManager.CommitChanges()
   End Sub

   Private Function FindElement(ByVal collection As ConfigurationElementCollection, ByVal elementTagName As String, ByVal ParamArray keyValues() As String) As ConfigurationElement
      For Each element As ConfigurationElement In collection
         If String.Equals(element.ElementTagName, elementTagName, StringComparison.OrdinalIgnoreCase) Then
            Dim matches As Boolean = True
            Dim i As Integer
            For i = 0 To keyValues.Length - 1 Step 2
               Dim o As Object = element.GetAttributeValue(keyValues(i))
               Dim value As String = Nothing
               If (Not (o) Is Nothing) Then
                  value = o.ToString
               End If
               If Not String.Equals(value, keyValues((i + 1)), StringComparison.OrdinalIgnoreCase) Then
                  matches = False
                  Exit For
               End If
            Next
            If matches Then
               Return element
            End If
         End If
      Next
      Return Nothing
   End Function

End Module

JavaScript

var adminManager = new ActiveXObject('Microsoft.ApplicationHost.WritableAdminManager');
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST";

var applicationPoolsSection = adminManager.GetAdminSection("system.applicationHost/applicationPools", "MACHINE/WEBROOT/APPHOST");

var applicationPoolsCollection = applicationPoolsSection.Collection;

var addElementPos = FindElement(applicationPoolsCollection, "add", ["name", "DefaultAppPool"]);
if (addElementPos == -1) throw "Element not found!";
var addElement = applicationPoolsCollection.Item(addElementPos);

var failureElement = addElement.ChildElements.Item("failure");
failureElement.Properties.Item("rapidFailProtection").Value = true;
failureElement.Properties.Item("rapidFailProtectionInterval").Value = "00:05:00";
failureElement.Properties.Item("rapidFailProtectionMaxCrashes").Value = 5;

adminManager.CommitChanges();

function FindElement(collection, elementTagName, valuesToMatch) {
   for (var i = 0; i < collection.Count; i++) {
      var element = collection.Item(i);
      if (element.Name == elementTagName) {
         var matches = true;
         for (var iVal = 0; iVal < valuesToMatch.length; iVal += 2) {
            var property = element.GetPropertyByName(valuesToMatch[iVal]);
            var value = property.Value;
            if (value != null) {
               value = value.toString();
            }
            if (value != valuesToMatch[iVal + 1]) {
               matches = false;
               break;
            }
         }
         if (matches) {
            return i;
         }
      }
   }
   return -1;
}

VBScript

Set adminManager = WScript.CreateObject("Microsoft.ApplicationHost.WritableAdminManager")
adminManager.CommitPath = "MACHINE/WEBROOT/APPHOST"
Set applicationPoolsSection = adminManager.GetAdminSection("system.applicationHost/applicationPools", "MACHINE/WEBROOT/APPHOST")
Set applicationPoolsCollection = applicationPoolsSection.Collection
addElementPos = FindElement(applicationPoolsCollection, "add", Array("name", "DefaultAppPool"))

If (siteElementPos = -1) Then
   WScript.Echo "Element not found!"
   WScript.Quit
End If

Set addElement = applicationPoolsCollection.Item(addElementPos)
Set failureElement = addElement.ChildElements.Item("failure")
failureElement.Properties.Item("rapidFailProtection").Value = true
failureElement.Properties.Item("rapidFailProtectionInterval").Value = "00:05:00"
failureElement.Properties.Item("rapidFailProtectionMaxCrashes").Value = 5

adminManager.CommitChanges()

Function FindElement(collection, elementTagName, valuesToMatch)
   For i = 0 To CInt(collection.Count) - 1
      Set element = collection.Item(i)
      If element.Name = elementTagName Then
         matches = True
         For iVal = 0 To UBound(valuesToMatch) Step 2
            Set Property = element.GetPropertyByName(valuesToMatch(iVal))
            value = property.Value
            If Not value = Null Then
               value = CStr(value)
            End If
            If Not value = valuesToMatch(iVal + 1) Then
               matches = False
               Exit For
            End If
         Next
         If matches Then
            Exit For
         End If
      End If
   Next
   If matches Then
      FindElement = i
   Else
      FindElement = -1
   End If
End Function