debugノードを使う

前回の記事で使ったdebugノードの動きをもう少し見てみたいと思います。debugノードはその名の通り、デバッグに使います。ログを出力してフローが期待通り動いているか確認できます。公式ドキュメントはこちら。

debugノードのプロパティ

フローエディタでdebugノードをダブルクリックしてプロパティを確認します。出力対象のデータは「対象」で指定します。選択肢は以下の通りです。
  • msgオブジェクト配下のプロパティ
    • 前回の記事みたいに、msgオブジェクト配下の特定プロパティをピンポイントで出力します
  • msgオブジェクト全体
    • msgオブジェクト全体を出力します。どんなプロパティがあるかわからないときに中身を全部出力する場合に使えそうですが、余計な情報も出力されてしまうデメリットもあります
  • JSONata式
    • 「JSONata式」という名前は初めて聞いたのですが、JSONオブジェクトからデータを抽出するためのクエリだそうです
    • 公式サイトを見たところ、結構いろいろなことができそうです。これはこれで深そうなので、別の機会にもう少し深く掘ってみたいと思います


出力先の選択肢は以下のとおりです。

  • デバッグウィンドウ
    • Node−RED画面上のデバッグウィンドウに出力します
    • デバッグウィンドウ上のログにマウスオーバーすると、そのログを出力したノードの枠線がハイライトされます。debugノードがたくさんあるときにどこで出力したログか識別するのに便利そうです

  • システムコンソール
    • Node-REDを起動したコンソール（いわゆる黒い画面）上に出力します 
      • 15 Sep 23:41:24 - [info] [debug:3d75809c46e7737f]
{ _msgid: '820edd68e4b23359', payload: 'Hello World!', topic: '' }
  • ノードステータス(32文字)
    • フローエディタ上でノードのすぐ下に出力します
    • 他のオプションと異なり、出力する内容を別途指定できるので、ノードのステータスを端的に表現する用途で使えそうです

その他のプロパティは各ノード共通のプロパティのようです。ノード名称やノードの説明、見た目を変更できます。

debugノードの右側にあるボタンを選択すると、有効／無効の切り替えができます。開発時はデバッグログを有効化しておき、運用時はログ出力を抑制すれば、わざわざノードを削除する必要がないので便利そうです。


まとめ

debugノードの使い方としては、なんだかよくわからないときはmsgオブジェクト全体を出力。状況が絞り込めてきたらプロパティピンポイントで出力指定。複雑な条件を与えたいならJSONata式する、みたいな感じでしょうか。次はinjectノードをもう少し詳しく見ていきたいと思います。


コメント

コメントを投稿

このブログの人気の投稿

Execノードを使う

イメージ
ここのところずっと Node-RED のサンプルを見ながら各ノードの使い方を確認しています。 頭出しの記事はこちら をご確認ください。今回はExecノードです。Execノードを使うと外部のコマンドを実行することができます。コマンドが出力した、標準出力や標準エラー出力などをノードから出力できます。 標準出力の内容を出力する 最初に確認するサンプルは「 flows > node-red > function > exec > 01 - Get standard output from external command 」です。 Execノードのプロパティを見ると以下の通りになっています。 実行コマンドは「 echo 」 msg.payload で受け取った値を引数として利用 出力モードは「 コマンド終了時 - execモード 」 コマンド終了時に結果を出力します Execノードには出力ポートが3つあります。 標準出力 標準エラー出力 返却コード 実行すると、標準出力には「 Hello World! 」、返却コードには「 {code : 0} 」が出力されます。この挙動は特に説明することはないかと思います。 標準エラー出力の内容を出力する 次に確認するサンプルは「 flows > node-red > function > exec > 02 - Get error output from external command 」です。外部コマンドのエラーをポートに出力します。中身は先程のサンプルフローとほぼ同じですが、Execノードで存在しないコマンドを実行しています。 実行すると、以下のログが出力されます。これも説明不要かと思います。 実行中に出力する 最後に確認するサンプルは「 flows > node-red > function > exec > 03 - Run external command in spawn mode 」です。出力がコマンド実行中に行われるのがこれまでのサンプルと違う点です。 コマンドはwhieループ内で2秒おきに「 Hello 」を標準出力に出力し続けます。Spawnモードで実行するとループ内でechoコマンドが実行されるたびにログが出力されます。サービスっぽい挙動をす
続きを読む

Joinノードを使う（その4）

イメージ
ここのところずっと Node-RED のサンプルを見ながら各ノードの使い方を確認しています。 頭出しの記事はこちら をご確認ください。今回はJoinノードの4回目です。終わらねぇ。 確認するサンプルは、 前回 に引き続き「 読み込み > サンプル > flows > node-red > sequence > join > 02 - Manual join mode 」です。 メッセージを結合してkey/valueオブジェクトにする 5段目のフローから見ていきます。ざっくりとした流れは以下のとおりです。 DataノードでCSVデータを送信する CsvノードでCSVデータをJSONオブジェクトに変換する msg.payloadには以下のような値が指定されたメッセージ4つに分解される { name: "Apple", price: 100 } Changeノードでmsg.payload内の値を以下のプロパティに設定する msg.topic = "Apple"（msg.payload.nameの値） msg.payload = 100（msg.payload.priceの値） Joinノードで、2個の受信メッセージごとにmsg.topicの値をキーとしてkey/valueオブジェクトに結合して送信する これを実行すると、以下のようにmsg.payloadにJSONオブジェクトが指定されていることを確認できます。 メッセージを結合して結合オブジェクトにする 先ほどは結合した値がkey/valueオブジェクトでしたが、6段目のフローでは単純にオブジェクト結合します。ざっくりとした流れは以下のとおりです。 DataノードでJSON配列を送信する nameをキーに持つオブジェクトとpriceをキーに持つオブジェクトを交互に含んでいます（実際、こんなに都合の良いデータが生成されることはあるんだろうか） Splitノードで配列データを個別のメッセージに分割します Joinノードで、2個の受信メッセージごとにオブジェクトに結合して送信する これを実行すると、以下のようにmsg.payloadに2個ずつのオブジェクトがJSONオブジェクトに結合されたものが指定されていることを確認できます。ちなみに、Joinノード
続きを読む

SendGridのX-SMTPAPIヘッダの使い方（Section Tags、Substitution Tags編）

イメージ
前回に引き続き SendGrid についてです。 今回は SMTP API を使ってみました。 SMTP APIについて SendGridのSMTP APIは基本的には普通のSMTPプロトコルに則ったものですが、X-SMTPAPIヘッダというカスタムヘッダを使うことで機能を拡張することができます。 X-SMTPAPIヘッダについて X-SMTPAPIヘッダはSMTPプロトコルの拡張ヘッダです。 X-SMTPAPI: { "category": "newuser" } みたいな感じでJSON形式でパラメータを与えることで機能を拡張します。 Section TagsとSubstitution Tagsについて 今回はSMTP APIで使える機能のうちSection TagsとSubstitution Tagsを使ってみました。 Section TagsとSubsitution Tagsは送信メールの内容を宛先毎に特定の文字列を置換するための機能です。toと合わせて使うことで機能します。 例えば、X-SMTPAPIヘッダの値を以下のような形にします。 { "to": ["test1@xxx.xxx", "test2@yyy.yyy"], "sub": { "-body-": [ "-bodyFemale-", "-bodyMale-" ], "-favorite-": [ "バナナ", "カツオ" ], " "-nickname-": [ "ミキ", "サブロー" ] }, "section": { " "-bodyFemale-": "-nickname-さん！女性向けの商品のご紹介です。", "-bodyMale": "-nickn
続きを読む