システムステータスの確認
エンドポイント /.status に HTTP/HTTPS アクセスすることで、システムを構成する各コンテナのステータスを確認することができます。
監視システムで Kompira の状態を監視したい、また、クラスタ構成で前段でロードバランサーを設定してステータスによって振り分けたい、といった場合に利用することができます。
注意: このエンドポイントは認証無しにアクセスすることができるようになっています。外部からのアクセスを防ぐ必要がある場合は、Kompira システムの外部のファイアーウォールなどでブロックするようにしてください。
※ システムステータスの確認は KE v2.0.1 から対応しました。
ステータスコード
システムステータス /.status にアクセスすると、レスポンスのステータスコードでシステムの全体的な状況を示します。
- 200 OK: 正常
- 503 Service Unavailable: 重要なコンテナ (redis, postgreqsl) が動作していない。
- 504 Gateway Timeout: kompira コンテナが動作していない、または、ステータス取得にタイムアウトした。
※ kompira コンテナより前段のコンポーネントが上記以外のエラーコードを返す場合も考えられます。
応答がない場合は、Kompira システムのホストサーバがダウンしている、ネットワークが導通していない、Docker およびコンテナが正常に動作していない、といった障害が発生していることが考えられます。
システムステータスが異常を示している、またはシステムステータスが取得できない、といった場合は、システムに何らかの問題が生じていると考えられます。トラブルシュートを参考にして、システムの診断を行なって回復手順を試してみてください。
ブラウザアクセス時のシステムステータス
エンドポイント /.status にブラウザでアクセスすると、以下のような画面が表示されます。
これは、全てのコンテナが正常に動作しているときの表示になります。
一方で、異常や警告が発生しているコンテナがあると、以下のように当該コンテナが赤(異状)や黄色(警告)の表示になります。
各コンテナの領域をクリックすると以下のように詳細な情報が表示されますが、その内容は次に示す API アクセス時のレスポンスと同じです。
ここまではステータスコードとしては 200 となる例を示していました。重要なコンテナ (redis, postgreqsl) が動作していない場合はステータスコードが 503 となり、以下のように画面の表示上でもステータスコードを確認することができます。
API アクセス時のシステムステータス
エンドポイント /.status に API アクセスすると、JSON 形式のレスポンスを得ることができます。
API アクセスするには、リクエストのヘッダに Accept: application/json を含めてください。または、クエリ文字列に format=json を含めて /.status?format=json にアクセスする方法もあります。
API アクセスでは、各コンテナのステータスを含む情報を以下のような辞書形式で返します。
{
"redis": {
"status": <Status of Redis: "OK"|"NG"|"ERROR">
},
"postgres": {
"status": <Status of PostgreSQL: "OK"|"NG"|"ERROR">
},
"rabbitmq": {
"status": <Status of RabbitMQ: "OK"|"NG"|"ERROR">
},
"kompira": {
"status": <Status of Kompira server: "OK"|"WARNING"|"ERROR">
"detail": {
"version": <Version of kompira>,
"hostname": <Hostname of kompira>,
"proc_id": <process id>,
"started_datetime": <Date and time the kompira server started>,
"license_expire": <Date the license expires>,
"license_error": <License error> or null
}
},
"kengine": {
"status": <Status of Kompira engine: "OK"|"NG"|"ERROR">
"total_num": <Total number of kompira engines>,
"running_num": <Number of running kompira engines>,
"executor_num": <Number of active executors>,
"detail": [
{
"engine_id": <Engine ID>,
"status": <Status of engine: "STARTED"|"RUNNING"|"UNKNOWN">,
"role": <Role of engine: "leader"|"follower">,
"hostname": <Hostname of kengine>,
"executor_num": <Number of executor>,
"started_datetime": <Date and time the kompira engine started>,
"proc_id": <process id>
},
...
]
},
"jobmngrd": {
"status": <Status of Kompira jobmngrd: "OK"|"NG"|"ERROR">
"total_num": <Total number of jobmngrd>,
"active_num": <Number of active jobmngrd>,
"detail": [
{
"realm_name": <Realm name>,
"status": <Status of jobmngrd: "RUNNING"|"UNKNOWN">,
"hostname": <Hostname of jobmngrd>,
"version": <Version of jobmngrd>,
"ssl": <SSL version>,
"pid": <process id>
},
...
]
}
}
レスポンス辞書の、コンテナごとのステータス値 (.status) は、以下のような状態を示しています。
- "OK": 正常
- "WARNING": 正常（ただし警告を示す情報がある）
- kompira: ライセンスエラーが生じている。
- "NG": 異状（対象コンテナにアクセスできるが、正常性を示していない）
- redis: PING 要求に応答しない。
- postgres: クエリ "SELECT 1" に応答しない。
- rabbitmq: 接続後に内部で例外が発生している。
- kengine: 実行状態のエンジンが 1 つも存在しない、または、アクティブなエグゼキュータが 1 つも存在しない。
- jobmngrd: アクティブなジョブマネージャが 1 つも存在しない。
- "ERROR": エラー
- 対象コンテナが動作していない、または、アクセスできない。