02. Log

logオブジェクトは、ログ出力機能を提供する組み込みオブジェクトです。

機能概要:

  • システムログの出力レベルを設定できます。
  • ログ出力先を設定できます。
  • JavaScript上から任意文字をログへ出力できます。

制限事項:

  • ログ保存用不揮発メモリの最大保存容量は4064KBとなります。
    フルになった場合は古いログから上書き更新されます。


log Global Object

Methods()/PropertiesSummaryVersionNote
log.setLevel() システムログのレベル及び出力先を設定します。
log.clear() 不揮発メモリに保存されているログを消去します。
log.getStoredSize() 現在保存されているログサイズを取得します。
log.getStorageSize() 保存可能なログサイズを取得します。
log.printLevel() print()関数の出力先を設定します。
print() ログを出力します。グローバルスコープの関数となります。


Details

log.setLevel([level[,output[,instance]]])

システムログのレベル及び出力先を設定します。
最後に設定した値が不揮発メモリに保存されます。
システムログは基本的に無効設定のままで構いません。
予期せぬ動作が発生した際に、原因を調査するために使用します。

NameTypeM/OSummary                                  Note
levelnumberoptionalログレベル設定
-1: Disabled
0: Error level
1: Warning level
2: Debug level
3: Trace level
デフォルト値は-1となります。
outputnumberoptional出力先設定
0: All disabled
1: NEQTOデバイス上の不揮発メモリにログ保存
2: NEQTOデーモンログ出力
3: 1, 2 が有効
4: NEQTO Consoleにログをリアルタイム送信
5: 1, 4 が有効
6: 2, 4 が有効
7: 1, 2, 4 が有効
デフォルト値は0となります。		「NEQTO Consoleにログをリアルタイム送信する」機能は、デバック用途のみでご使用ください。この機能は多くの通信リソースを使用するため、デバイスの処理負荷の増加やデータ伝送遅延を発生させる可能性があります。又、通信障害時の再送処理は行われないため、ログデータが欠落する可能性があります。
instancenumberoptional,
mandatory		NEQTO Console上のリアルタイムログ送信先となるインスタンスIDを指定します。
指定可能なインスタンスIDの範囲についてはこちらを参照してください。		'output'が 4 以上の場合のみ必須となります。

リアルタイムログは下記のMQTT仕様でNEQTO Consoleへ送信されます。
項目設定値
オブジェクトIDテキスト表示
(固定)
インスタンスID任意
リソースIDテキスト
(固定)
returnundefined--異常が発生した時は、例外となります。

log.clear()

不揮発メモリに保存されているログを消去します。

NameTypeM/OSummaryNote
returnundefined--

log.getStoredSize()

現在保存されているログサイズを取得します。

NameTypeM/OSummaryNote
returnnumber-現在保存されているログサイズ[byte]

log.getStorageSize()

保存可能なログサイズを取得します。

NameTypeM/OSummaryNote
returnnumber-保存可能なログサイズ[byte]

log.printLevel([output[,instance]])

print()関数の出力先を設定します。
スクリプトの開始時に常にデフォルト値で初期化されます。

NameTypeM/OSummary                                  Note
outputnumberoptional出力先設定
0: All disabled
1: NEQTOデバイス上の不揮発メモリにログ保存
2: NEQTOデーモンログ出力
3: 1, 2 が有効
4: NEQTO Consoleにログをリアルタイム送信
5: 1, 4 が有効
6: 2, 4 が有効
7: 1, 2, 4 が有効
デフォルト値は0となります。		「NEQTO Consoleにログをリアルタイム送信する」機能は、デバック用途のみでご使用ください。この機能は多くの通信リソースを使用するため、デバイスの処理負荷の増加やデータ伝送遅延を発生させる可能性があります。又、通信障害時の再送処理は行われないため、ログデータが欠落する可能性があります。
instancenumberoptional,
mandatory		NEQTO Console上のリアルタイムログ送信先となるインスタンスIDを指定します。
指定可能なインスタンスIDの範囲についてはこちらを参照してください。		'output'が 4 以上の場合のみ必須となります。

リアルタイムログは下記のMQTT仕様でNEQTO Consoleへ送信されます。
項目設定値
オブジェクトIDテキスト表示
(固定)
インスタンスID任意
リソースIDテキスト
(固定)
returnundefined--異常が発生した時は、例外となります。

print(logMsg)

ログを出力します。

NameTypeM/OSummaryNote
logMsgstringmandatory出力するログメッセージ
returnundefined--異常が発生した時は、例外となります。


オブジェクトの使用例

Sample 1

システムログ及びprintログをNEQTOデーモンログに出力するサンプルです。

log.setLevel(0,2);
log.printLevel(2);

Sample 2

システムログ及びprintログをNEQTO Consoleにリアルタイム送信するサンプルです。
インスタンスIDは任意の値です。システムログとprintログで同IDを使用することも可能です。

log.setLevel(0,4,1);
log.printLevel(4,2);
//log.printLevel(4,1); /*Available*/


Updated: 2022-09-01
← 前次 →