common feature

共通プラグインログ

benryPlus の各プラグインでは、設定変更やエラーを kintone のログアプリに記録できます。 必須ではありませんが、運用管理をしやすくするため記録を推奨しています。 ログ仕様はかりんこラボ製 kintone プラグインと共通です。

ログアプリテンプレートをダウンロード

ファイル名：benryPlus_plugin_logging_v3.zip ／ 最新版：v3.0.0

kintone システム管理の「アプリテンプレート」から読み込み、テンプレートからログアプリを作成してください。 プラグイン設定画面からも同じテンプレートをダウンロードできます。

こんな場面で使う

  • 利用者の画面に出ないエラーを、管理者が把握したい
  • プラグイン設定の変更履歴を残しておきたい
  • 本番運用で、障害の兆候を早めに検知したい
  • 複数プラグインのログを、1 つのログアプリに集約したい

ログに記録される主なタイミング

  • プラグイン設定を保存したとき
  • プラグイン動作中にエラーが発生したとき（検知できないエラーもあるため、すべてが記録されるわけではありません）
かりんこラボ製プラグインと共通のログ仕様

ログアプリのテンプレート、フィールド構成、記録の考え方は同じです。 すでにかりんこラボ製プラグイン用にログアプリを運用している場合は、そのアプリをそのまま利用できます。 benryPlus 製品とかりんこラボ製プラグインのログを、同じログアプリにまとめて記録することも可能です。

設定の流れ

ログアプリテンプレートをダウンロードする

このページ、または各プラグインの設定画面から ZIP を取得し、kintone にインポートします。

ログアプリを作成し、権限を設定する

設置場所と認証方式（セッション認証 / API トークン認証）に応じて、アクセス権を設定します。

プラグイン設定でログ記録を ON にする

ログアプリ ID を入力し、接続確認が成功することを確認してから保存します。

（任意）条件通知を設定する

ログ種別（LOG_TYPE）が Error のレコード追加時に、管理者へメール通知する設定ができます。

ログアプリの設置場所

まず、プラグインを入れたアプリがゲストスペース内かどうかを確認してください。

  • ゲストスペース外（ポータル・通常スペース） … ログアプリもゲストスペース外に置けます。複数アプリから 1 つのログアプリへ集約できます。
  • ゲストスペース内 … ログアプリは同じゲストスペース内に作成してください。ゲストスペース外のログアプリには、セッション認証では接続できません。

認証方式の選び方

観点セッション認証API トークン認証
書き込みに使う権限 ログイン中の利用者の権限 API トークンの権限
利用者にログアプリの「レコード追加」が必要か 必要 不要
ゲストユーザーの操作 ゲストユーザー本人に追加権限があれば記録できる 記録されない
向いているケース シンプルに始めたい、ゲストユーザーのログも残したい 利用者にログアプリの追加権限を渡したくない、閲覧を管理者だけにしたい

ログアプリの主なフィールド

テンプレートに含まれるフィールドコードは変更・削除しないでください（かりんこラボ製プラグインと共通の仕様です）。

フィールドコード用途
LOG_DATETIMEログ出力日時
LOG_TYPEError / Warning / Information
PLUGIN_NAMEプラグイン名
USER_CODE / USER_NAME実行ユーザー
APPID / APP_NAME発生元アプリ
REC_ID / REC_REVISION / REC_LINK対象レコード（あれば）
LOG_EVENT発生イベント名
S_MSG_1 〜 L_MSG_3メッセージ（summary / detail 等）
CONFIG_SETTINGサニタイズ済み設定 JSON
テンプレートのカスタマイズについて

フィールドの追加、通知やプロセス管理の設定、一覧やグラフの追加、アプリ名・アイコンの変更は問題ありません。 フィールドコードの変更・削除のみ行わないでください。

対応製品と詳細ガイド

製品ごとの設定手順・注意点は、各製品の活用ガイドもあわせてご覧ください。

benryNote

設定画面上部のガイド（v0.4.44 以降）から、対話形式でログアプリの作成・接続設定を案内できます。

benryNote のログ設定ガイド

ダウンロードできない場合は、ブラウザのポップアップブロック設定を確認するか、各プラグインの設定画面からテンプレートを取得してください。