開発者向け機能:サーバスクリプト:logs.LogInfo
概要¶
logsオブジェクトの「LogInfo」メソッドです。サーバスクリプトでログの種類:Infoとしてログを表示、出力します。
構文¶
パラメータ¶
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| message | string | ○ | 表示、出力するエラー内容を指定。 |
| method | string | 省略可能。既定値は空文字。 | |
| console | bool | 省略可能。既定値はtrue。ブラウザの開発者ツールのコンソールに表示する場合はtrueを指定 | |
| syslogs | bool | 省略可能。既定値はtrue。システムログに出力する場合はtrueを指定 |
戻り値¶
ログを表示、出力できたらtrue、表示、出力できなかったらfalseを返却します。
コンソール表示時の表示内容¶
表示フォーマット¶
| 表示項目 | 表示内容 | 備考 |
|---|---|---|
| Message | messageで設定した文字列 | |
| Method | methodで設定した文字列 | method未指定時は角括弧([])も表示しない |
システムログ出力時の出力先項目¶
| 出力先項目 | 出力内容 | 備考 |
|---|---|---|
| Comments | messageで設定した文字列 | |
| Method | 本来のMethodに記録される文字列に「:method」の形式で結合した文字列 | |
| SysLogType | 10 | 10(Info)固定 |
使用例¶
下記の例では、サイトID 2 の「期限付きテーブル」にタイトルが "プリザンターのバージョンアップについて" のレコードを作成し、正常終了した場合にログ出力します。
JavaScript¶
const siteId = 2;
const item = items.NewIssue();
item.Title = 'プリザンターのバージョンアップについて';
const ret = items.Create(siteId, item);
if (ret) {
logs.LogInfo(`レコードを作成しました。レコードID:${item.IssueId}`);
}
サンプルコード¶
1. 汎用的なログ出力関数
logsオブジェクトの各メソッドをラップし、デバッグ時と本番時でログ出力を切り分けられる汎用ロガーのサンプルコードです。
機能要件¶
-
デバッグフラグによる出力制御
DEBUG_MODE(bool)をtrueにした場合のみlogger.debug()が出力される。falseの場合は完全に抑制される。 -
出力先の一元管理
LOG_TARGET(console / syslogs の bool)で、コンソールとシステムログへの出力をそれぞれ個別にオン・オフできる。設定はスクリプト全体に一括適用される。 -
ログレベルの提供
以下の6メソッドを提供し、それぞれ対応する
logsメソッドに委譲する。メソッド 委譲先 常時出力 logger.debug() LogInfo ✗(デバッグ時のみ) logger.info() LogInfo ✓ logger.warn() LogWarning ✓ logger.userError() LogUserError ✓ logger.systemError() LogSystemError ✓ logger.exception() LogException ✓
JavaScript¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | |
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.4.12.0 以降 | 機能追加 |
