Service Fabric プローブ

この記事を読み進める前に、Service Fabric のアプリケーション モデルと Service Fabric のホスティング モデルについて理解を深めておいてください。 この記事では、マニフェスト ファイルを使用して liveness probe および readiness probe を定義する方法の概要を示します。

liveness probe

Azure Service Fabric のバージョン 7.1 以降では、コンテナー化および非コンテナー化アプリケーションに対して liveness probe メカニズムがサポートされています。 liveness probe は、コード パッケージの活動性を報告するのに役立ちます。すぐに応答しない場合、そのアプリケーションは再起動されます。

readiness probe

8\.2 以降では、readiness probe もサポートされています。 readiness probe は、トラフィックを受け入れる準備ができているかどうかを判断するために使用されます。 たとえば、コンテナーで要求の処理に時間がかかっている、または要求キューがいっぱいで、コード パッケージがそれ以上のトラフィックを受け入れられなくなり、コード パッケージに到達するエンドポイントが削除される場合があります。

readiness probe の動作は次のとおりです。

1. コンテナー/コード パッケージ インスタンスが開始されます
2. エンドポイントが直ちに発行されます
3. readiness probe の実行が開始されます
4. readiness probe は最終的にエラーしきい値に達し、エンドポイントが削除され、使用できなくなります
5. しばらくしてインスタンスの準備が整います
6. readiness probe は、インスタンスの準備ができていることを通知し、エンドポイントを再度発行します
7. 要求を処理する準備ができたので、要求は再びルーティングされ、成功します

Note

readiness probe の場合、コード パッケージは再起動されません。エンドポイントは発行されないので、レプリカ/パーティションのセットは影響を受けません。

Semantics

指定できるのは、1 つのコード パッケージにつき 1 つの liveness probe と 1 つの readiness probe だけで、次のフィールドでその動作を制御できます。

• type: プローブの種類が Liveness か Readiness かを指定するために使用します。 現在サポートされる値は Liveness または Readiness です。

• initialDelaySeconds: コンテナーが起動されてから、probe の実行を開始するまでの最初の遅延 (秒)。 サポートされる値は int です。既定値は 0、最小値は 0 です。

• timeoutSeconds: probe が正常に終了しなかった場合に、それが失敗したと見なされるまでの期間 (秒)。 サポートされる値は int です。既定値は 1、最小値は 1 です。

• periodSeconds: probe の頻度を指定する期間 (秒)。 サポートされる値は int です。既定値は 10、最小値は 1 です。

• failureThreshold: この値に達すると、コンテナーが再起動されます。 サポートされる値は int です。既定値は 3、最小値は 1 です。

• successThreshold: 失敗した場合、probe が成功と見なされるには、この値に対して正常に実行される必要があります。 サポートされる値は int です。既定値は 1、最小値は 1 です。

1 つのコンテナーに対して使用できる probe はいかなるときも最大で 1 つです。 timeoutSeconds で設定された時間内に probe が終了しない場合は、待機しながら failureThreshold までの時間をカウントします。

さらに、Service Fabric により、DeployedServicePackage について次の probe 正常性レポートが生成されます。

• OK: successThreshold で設定された値に対して probe は成功しています。

• Error: probe の failureCount == failureThreshold。この後、コンテナーが再起動されます。

• Warning:

  • probe が失敗し、failureCount<failureThreshold となっています。 この正常性レポートは、failureCount が failureThreshold または successThreshold で設定された値に達するまで維持されます。
  • 失敗後に成功した場合、警告は残りますが、連続して成功した場合は更新されます。

プローブの指定

ServiceManifestImport の下の ApplicationManifest.xml ファイルで probe を指定できます。

probe は、次のいずれかに対して指定できます。

• HTTP
• TCP
• Exec

HTTP プローブ

HTTP probe の場合、指定したポートとパスに、Service Fabric から HTTP 要求が送信されます。 返されるコードが 200 以上、400 未満の場合は、成功が示されます。

HTTP liveness probe を指定する方法の例を次に示します。

  <ServiceManifestImport>
    <ServiceManifestRef ServiceManifestName="Stateless1Pkg" ServiceManifestVersion="1.0.0" />
    <ConfigOverrides />
    <Policies>
      <CodePackagePolicy CodePackageRef="Code">
        <Probes>
          <Probe Type="Liveness" FailureThreshold="5" SuccessThreshold="2" InitialDelaySeconds="10" PeriodSeconds="30" TimeoutSeconds="20">
            <HttpGet Path="/" Port="8081" Scheme="http">
              <HttpHeader Name="Foo" Value="Val"/>
              <HttpHeader Name="Bar" Value="val1"/>
            </HttpGet>
          </Probe>
        </Probes>
      </CodePackagePolicy>
    </Policies>
  </ServiceManifestImport>

HTTP probe には、設定できる次の追加のプロパティがあります。

• path: HTTP 要求で使用するパス。

• port: probe に使用するポート。 このプロパティは必須です。 範囲は 1 から 65535 です。

• scheme: コード パッケージへの接続に使用するスキーム。 このプロパティを HTTPS に設定すると、証明書の検証はスキップされます。 既定の設定は HTTP です。

• httpHeader: 要求内で設定するヘッダー。 複数のヘッダーを指定できます。

• host: 接続先のホスト IP アドレス。

Note

コンテナー化されていないアプリケーションでは、ポートとスキームはサポートされていません。 このシナリオでは、EndpointRef="EndpointName" 属性を使用してください。 'EndpointName' を、ServiceManifest.xml で定義されているエンドポイントの名前に置き換えます。

TCP プローブ

TCP probe の場合、Service Fabric では、指定されたポートを使用してコンテナー上のソケットを開こうとします。 接続を確立できる場合、probe は成功と見なされます。 TCP ソケットを使用する probe を指定する方法の例を次に示します。

  <ServiceManifestImport>
    <ServiceManifestRef ServiceManifestName="Stateless1Pkg" ServiceManifestVersion="1.0.0" />
    <ConfigOverrides />
    <Policies>
      <CodePackagePolicy CodePackageRef="Code">
        <Probes>
          <Probe Type="Liveness" FailureThreshold="5" SuccessThreshold="2" InitialDelaySeconds="10" PeriodSeconds="30" TimeoutSeconds="20">
            <TcpSocket Port="8081"/>
          </Probe>
        </Probes>
      </CodePackagePolicy>
    </Policies>
  </ServiceManifestImport>

Exec probe

この probe では、exec コマンドをコンテナーに発行し、そのコマンドが終了するまで待機します。

Note

exec コマンドでは、コンマで区切られた文字列を取得します。 次の例のコマンドは、Linux コンテナーで使用できます。 Windows コンテナーに対して probe を試す場合は、cmd を使用します。

  <ServiceManifestImport>
    <ServiceManifestRef ServiceManifestName="Stateless1Pkg" ServiceManifestVersion="1.0.0" />
    <ConfigOverrides />
    <Policies>
      <CodePackagePolicy CodePackageRef="Code">
        <Probes>
          <Probe Type="Liveness" FailureThreshold="5" SuccessThreshold="2" InitialDelaySeconds="10" PeriodSeconds="30" TimeoutSeconds="20">
            <Exec>
              <Command>ping,-c,2,localhost</Command>
            </Exec>
          </Probe>        
       </Probes>
      </CodePackagePolicy>
    </Policies>
  </ServiceManifestImport>

次のステップ

関連情報については、次の記事を参照してください。

• Service Fabric とコンテナー