child_processから起動したコマンドラインからログが出力されるたびにリアルタイム処理を行いたい

前提・実現したいこと

child_processによって起動されたtsharkから新たにログが出力されるたびに、そのログを変数に格納、処理を行いたいです

プログラムの流れ

tsharkを起動
tsharkから新たにログが出力されたときに、ログを変数に格納、処理の実行
次のログの出力を待機

tsharkから新たにログが出力されたときに、ログを変数に格納、処理の実行
この点についての実装の方法がわかりません

コード

tsharkは現在このようにnode.jsから実行しています

javascript
1const { exec } = require('child_process')
2exec('\"C:\Program Files\Wireshark\tshark.exe\" -i Wi-Fi -Y \"mqtt.topic\" -x');

補足情報（FW/ツールのバージョンなど）

Windows 10 Pro 64bit
Wireshark 3.4.3

行動規範の内容に同意します

回答1件

child_process.execではなく、child_process.spawnを使うと実現できます。

exec ... プログラムの終了を待つため、出力をリアルタイムに扱えない。
spawn ... プログラムの終了を待たない。非同期に実行。

例)

#!/usr/bin/env node

// プログラムの出力を扱う場合はexecではなく、spawnを利用
const { spawn, /*exec*/ } = require('child_process');

(async () => {
    // プログラム名
    const program = 'tshark';
    // プログラムの引数
    const args = ['-i', 'wlp2s0', '-Y', 'http', '-x'];

    // プログラムを起動。プログラムの終了を待たずに戻ってくる
    const child = spawn(program, args, {
        // spawnのstdioオプション
        // [標準入力, 標準出力, 標準エラー出力] の形式で指定
        // 'ignore' -> nulや/dev/null相当
        // 'pipe' -> nodeプログラムで扱う場合はこれを指定
        // 'inherit' -> このnodeプロセスのものをそのまま使う
        // そのほか ドキュメント参照 https://nodejs.org/api/child_process.html#child_process_options_stdio
        stdio: ['ignore', 'pipe', 'inherit'],
    });

    // 標準出力が出力される毎にループを回す
    for await (const chunk of child.stdout) {
        // chunkは標準出力が出力するデータのまとまり
        // 行単位でもなんでもなく、バッファがいっぱいになるか、
        // 出力が一段落したかなど、人としては予測ができない塊
        console.log("*****");
        console.log(String(chunk));
        console.log("#####");
    }
})().catch(console.error);

※プログラムの引数は適宜置き換えて下さい。

ただ、これではコメントにも記載していますが、出力を扱えるタイミングが予想できないです。
readlineを使うと行単位の出力を扱えます。

#!/usr/bin/env node

// プログラムの出力を扱う場合はexecではなく、spawnを利用
const { spawn, /*exec*/ } = require('child_process');
// 追加
const readline = require('readline');

(async () => {
    // プログラム名
    const program = 'tshark';
    // プログラムの引数
    const args = ['-i', 'wlp2s0', '-Y', 'http', '-x'];

    // プログラムを起動。プログラムの終了を待たずに戻ってくる
    const child = spawn(program, args, {
        // spawnのstdioオプション
        // [標準入力, 標準出力, 標準エラー出力] の形式で指定
        // 'ignore' -> nulや/dev/null相当
        // 'pipe' -> nodeプログラムで扱う場合はこれを指定
        // 'inherit' -> このnodeプロセスのものをそのまま使う
        // そのほか ドキュメント参照 https://nodejs.org/api/child_process.html#child_process_options_stdio
        stdio: ['ignore', 'pipe', 'inherit'],
    });

    const lines = readline.createInterface({ input: child.stdout });
    // 標準出力の行単位でループを回す
    for await (const line of lines) {
        console.log("*****", line, "#####");
    }
})().catch(console.error);

なお、tsharkのオプションで-T ekを指定すると通信が行単位でJSONとして出力されるので、より扱いやすそうでした。
なお、プログラムを非同期で扱うことになるので、同期での実行に比べエラー処理等の難易度が上がります。頑張って下さい！

投稿2021/04/21 12:18