ヘルスチェック

SDK には、さまざまなサービスで実行できるヘルスチェックが含まれています。このページでは、Consul を通じて実行できる、それぞれの構造に適切なヘルスチェックを紹介しています。

SDK ヘルスチェック

consul を使用する際に、 SDK Health Check というヘルスチェックを行うことができます。結果は、JSON 構造のデータとして取得できます。

HealthCheck

consul によるヘルスチェックです。

オブジェクトのプロパティ:
  • Node (string) – サービスで使用されるノード名
  • CheckID (string) – 型を識別する ID
  • Name (string) – サービス名の CheckID
  • Status (string) – サービスのステータス
  • Notes (string) – サービス関連の注釈
  • Output (string) – サービスに関連するアウトプット
  • ServiceID (string) – サービスの ID
  • ServiceName (string) – サービス名
JSON Example
{
    "Node": "GayzpMuADQcEgqBcIpYv",
    "CheckID": "QHEMWIohgDShzZNvgyWc",
    "Name": "ctXSPqeFzOwCauuXVHGN",
    "Status": "nWaeigSJtoQjdIBIBNBT",
    "Notes": "vavEYPVdUDmQkCQQHFtP",
    "Output": "NtgmzfzgnOHwLseNdJVK",
    "ServiceID": "miXgHqBgSwMlzqPAsDfP",
    "ServiceName": "uFfkVoUFstaifrxxkNCr"
}

この構造は、どのサービスでも共通で使用できますが、出力される文字列は呼び出されたサービスに応じて、JSON 構造にシリアライズできます。この例では HealthCheckOutput 構造にシリアライズできます。

HealthCheckOutput

ヘルスチェック SDK サービスに関連するアウトプット

オブジェクトのプロパティ:
  • Config (HealthConfig) – ヘルスチェックの出力設定
  • State (HealthState) – ヘルスチェックの出力ステータス
JSON Example
{
    "Config": {
        "Encode": {
            "Input": {
                "Height": 4509,
                "Quality": "{number object}",
                "Silent": false,
                "StampScale": "{number object}",
                "StampTimecode": true,
                "Width": 9853
            }
        }
    },
    "State": {
        "ComposeConnected": true,
        "NatsConnected": false,
        "NumStreams": 567
    }
}

HealthConfig

HealthConfig

ヘルスチェックの出力設定です。

オブジェクトのプロパティ:
JSON Example
{
    "Encode": {
        "Input": {
            "Height": 6622,
            "Quality": "{number object}",
            "Silent": true,
            "StampScale": "{number object}",
            "StampTimecode": true,
            "Width": 7106
        }
    }
}

HealthConfigEncode

HealthConfigEncode

ヘルス設定エンコード

オブジェクトのプロパティ:
JSON Example
{
    "Input": {
        "Height": 4301,
        "Quality": "{number object}",
        "Silent": false,
        "StampScale": "{number object}",
        "StampTimecode": true,
        "Width": 4188
    }
}

HealthConfigEncodeInput

HealthConfigEncodeInput

ヘルス設定エンコード入力

オブジェクトのプロパティ:
  • Height (integer) – ビデオの高さ
  • Quality (number) – ビデオの品質パーセンテージ
  • Silent (boolean) – オーディオを無音にするの有効化/無効化
  • StampScale (number) – フレームへのタイムコードスタンプに使用するスケール
  • StampTimecode (boolean) – フレームへのタイムコードスタンプの有効化/無効化
  • Width (integer) – ビデオの幅
JSON Example
{
    "Height": 1113,
    "Quality": "{number object}",
    "Silent": true,
    "StampScale": "{number object}",
    "StampTimecode": true,
    "Width": 7746
}

HealthState

HealthState

ヘルスチェックの出力ステータス

オブジェクトのプロパティ:
  • ComposeConnected (boolean) – Compose 接続ステータス
  • NatsConnected (boolean) – NATS 接続ステータス
  • NumStreams (integer) – 接続ストリーム数
JSON Example
{
    "ComposeConnected": true,
    "NatsConnected": false,
    "NumStreams": 4788
}