自己診断コマンド

問題調査等で Ksocket の動作確認を行いたい場合の自己診断コマンドについて説明します。

「コマンド使用方法 > コマンド実行方法」を参照し Ksocket シェルを起動した上で、ksocket diagnostics コマンドを実行します。

なお ksocket diagnostics コマンドは Ksocket スロットの一時的な占有を防ぐため authenticate を実行しません。

認証まで含めて診断する場合は、続けて ksocket diagnostics authenticate コマンドを実行してください。

システム診断

システム的な不備がないか診断するには ksocket diagnostics system を呼び出してください。

以下のようにすべて OK であれば、システム的な問題はありません。

% ksocket diagnostics system
Python:  3.9.13 (main, Aug 29 2023, 03:50:02)  [GCC 4.4.7 20120313 (Red Hat 4.4.7-23)]
Ksocket: 2.4.2

KSOCKET_HOME:    /opt/fixpoint/ksocket
KSOCKET_CONFIG:  /opt/fixpoint/ksocket/etc/ksocket/ksocket.toml

$PYTHONHOME:
$PYTHONPATH:
$PYTHONOPTIMIZE: 1
$PYTHONENCODING:
$PYTHONUTF8:
$KSOCKET_HOME:   /opt/fixpoint/ksocket
$KSOCKET_CONFIG:

ssl ................... OK
aiofiles .............. OK
aiohttp ............... OK
asyncssh .............. OK
dpkt .................. OK
hashlib ............... OK
netifaces ............. OK
Cryptodome ............ OK
pcap .................. OK
pysnmp ................ OK
pytz .................. OK
winrm ................. OK
yaml .................. OK
requests_credssp ...... OK
ntlm_auth ............. OK
jsonref ............... OK
stringcase ............ OK
websockets ............ OK
websockets.speedups ... OK

設定ファイル診断

設定ファイルに不備がないか診断するには ksocket diagnostics config を呼び出してください。

以下のようにすべて OK であれば、設定ファイルに問題はありません。

% ksocket diagnostics config
Python:  3.9.13 (main, Aug 29 2023, 03:50:02)  [GCC 4.4.7 20120313 (Red Hat 4.4.7-23)]
Ksocket: 2.4.2

KSOCKET_HOME:    /opt/fixpoint/ksocket
KSOCKET_CONFIG:  /opt/fixpoint/ksocket/etc/ksocket/ksocket.toml

$PYTHONHOME:
$PYTHONPATH:
$PYTHONOPTIMIZE: 1
$PYTHONENCODING:
$PYTHONUTF8:
$KSOCKET_HOME:   /opt/fixpoint/ksocket
$KSOCKET_CONFIG:

Read KSOCKET_CONFIG as bytes .......... OK
Read KSOCKET_CONFIG as UTF-8 .......... OK
Read KSOCKET_CONFIG as TOML/YAML ...... OK
Read KSOCKET_CONFIG as config file .... OK

疎通状況診断

DNS 設定等 Kompira cloud との疎通に不備がないか診断するには ksocket diagnostics connect を呼び出してください。

以下のようにすべて OK であれば、疎通状況に問題はありません。

% ksocket diagnostics connect
Python:  3.9.13 (main, Aug 29 2023, 03:50:02)  [GCC 4.4.7 20120313 (Red Hat 4.4.7-23)]
Ksocket: 2.4.2

KSOCKET_HOME:    /opt/fixpoint/ksocket
KSOCKET_CONFIG:  /opt/fixpoint/ksocket/etc/ksocket/ksocket.toml

$PYTHONHOME:
$PYTHONPATH:
$PYTHONOPTIMIZE: 1
$PYTHONENCODING:
$PYTHONUTF8:
$KSOCKET_HOME:   /opt/fixpoint/ksocket
$KSOCKET_CONFIG:

Resolve DNS forward lookup (cloud.kompira.jp) ..... OK [40.81.216.149]
Establish TCP connection (cloud.kompira.jp:80) .... OK
Establish TCP connection (cloud.kompira.jp:443) ... OK

KSOCKET_INSECURE: False

Host:     fixpoint.cloud.kompira.jp
Port:     443
Protocol: wss
Endpoint: wss://fixpoint.cloud.kompira.jp:443/api/ksocket/connect

Resolve DNS forward lookup ... OK [40.81.216.149]
Establish TCP connection ..... OK
Establish websocket .......... OK

認証情報診断

Ksocket token の誤り等、認証情報に不備がないか診断するには ksocket diagnostics authenticate を呼び出してください。

以下のようにすべて OK であれば、認証情報に問題はありません。

% ksocket diagnostics authenticate
Python:  3.9.13 (main, Aug 29 2023, 03:50:02)  [GCC 4.4.7 20120313 (Red Hat 4.4.7-23)]
Ksocket: 2.4.2

KSOCKET_HOME:    /opt/fixpoint/ksocket
KSOCKET_CONFIG:  /opt/fixpoint/ksocket/etc/ksocket/ksocket.toml

$PYTHONHOME:
$PYTHONPATH:
$PYTHONOPTIMIZE: 1
$PYTHONENCODING:
$PYTHONUTF8:
$KSOCKET_HOME:   /opt/fixpoint/ksocket
$KSOCKET_CONFIG:

KSOCKET_INSECURE: False

Host:     fixpoint.cloud.kompira.jp
Port:     443
Protocol: wss
Endpoint: wss://fixpoint.cloud.kompira.jp:443/api/ksocket/connect

Complete authentication ...... OK

注意

  • 自己診断を行う場合は、一度 Ksocket のサービスを停止してください。
    サービスの停止方法は、コマンド使用方法 > サービス管理コマンド > サービスの管理 を参照してください。

  • 認証処理を行うため、すでに同じ Ksocket スロットに対して別の Ksocket が接続している場合は失敗します。
    認証情報診断を行う際は新規 Ksocket スロットを作成して、そのスロットに対して接続を行ってください。