ログ
概要
ここではenebular-agentのログについて説明します。
ログは有料デバイスでのみ使用できる機能です。
enebular-agentはログをenebularに送信しクラウドで蓄積します。
説明
機能
ログは、enebular-agentおよびNode-REDのログを対象として動作します。
ログは、以下の2つの機能を持ちます。
- コンソールへのログ出力
- enebular-agentのコンソール（標準出力:stdout/標準エラー出力:stderr）にログを出力します
- enebularへのログ送信
- ログを、enebularに送信します
デバイスのログはenebularのDeviceListおよびLogsで確認できます。
詳細についてはDevice ListおよびLogsを参照してください。
ログレベル
ログレベルにはinfoとdebugの二種類があります。
環境変数DEBUGの指定により、出力および送信するログレベルを制御できます。debugはinfoよりも詳しい情報を取得できます。
環境変数DEBUGの値とコンソールに出力するログおよびenebularへの送信情報の関係は次の表になります。
環境変数DEBUGの値 |
コンソールに出力するログ | enebularへの送信情報 |
|---|---|---|
| なし（デフォルト） | 出力しない | info |
| info | info | info |
| debug | debug | debug |
Node-REDのログメッセージは、常にinfoとして扱われます。
確認方法
環境変数DEBUGの確認は次のコマンドのレスポンスにより行います。
echo $DEBUG
| レスポンス | 環境変数DEBUGの値 |
|---|---|
| ブランク | なし |
| info | info |
| debug | debug |
変更方法
環境変数DEBUGの変更は以下の手順で行います。
- enebular-agentのサービスを停止
- Node.jsのパス設定を追加
- 環境変数
DEBUGを設定 - enebular-agentを実行しサービスを起動
enebular-agentの実行は、起動/停止 - <サービス名>ファイルのenebular-agent-<ユーザー>.serviceファイルの[Service]-ExecStart=を参照してください。[Service]-ExecStart=が次の場合
ExecStart=/home/enebular/enebular-runtime-agent/ports/awsiot/bin/enebular-awsiot-agent --enable-syslog --daemon-mode
実行するコマンド（以降、実行コマンド）は
/home/enebular/enebular-runtime-agent/ports/awsiot/bin/enebular-awsiot-agent --enable-syslog --daemon-mode
上記になります。
-uまたは--userを<ユーザー>に指定してインストールし、Node.jsのバージョンが<バージョン>の場合の環境変数DEBUGの変更手順を以下に示します。
- 環境変数
DEBUGを「なし」にする場合
sudo systemctl stop enebular-agent-<ユーザー>.service
export PATH=$PATH:/home/<ユーザー>/nodejs-v<バージョン>/bin
export DEBUG=
実行コマンド
- 環境変数
DEBUGをinfoにする場合
sudo systemctl stop enebular-agent-<ユーザー>.service
export PATH=$PATH:/home/<ユーザー>/nodejs-v<バージョン>/bin
export DEBUG=info
実行コマンド
- 環境変数
DEBUGをdebugにする場合
sudo systemctl stop enebular-agent-<ユーザー>.service
export PATH=$PATH:/home/<ユーザー>/nodejs-v<バージョン>/bin
export DEBUG=debug
実行コマンド
ライセンス登録
ログの通知状態には有効と無効の二種類があります。
通知状態が有効の場合は、ログの通知が行われ、無効の場合は、ログの通知が行われません。
ログの通知状態の初期設定は無効です。
ログの通知状態を有効にするには、ライセンスを購入した際に得られるライセンスキーをデバイスに登録する必要があります。
ライセンス登録の詳細については、License Managerを参照してください。