ログを記録したい
ベンリーノートでは、オプションでプラグインログを記録できます。設定変更やエラーをログアプリに残すことで、利用者に表示されない不具合も管理者が早期に把握しやすくなります。必須ではありませんが、運用管理をしやすくするため記録することを推奨します。
設定画面上部の「プラグインログ記録について」ボタンから、対話形式でログアプリの作成・接続設定を案内できます。テンプレートのダウンロードから接続確認まで、画面の指示に沿って進められます。
ベンリーノートのプラグインログは、かりんこラボ株式会社の有料kintoneプラグインと共通のログ仕様です。ログアプリのテンプレート、フィールド構成、記録の考え方は同じため、すでにかりんこラボ製プラグイン用にログアプリを運用している場合は、そのアプリをそのまま利用できます。ベンリーノートとかりんこラボ製プラグインのログを、1つのログアプリにまとめて記録することも可能です。
こんな場面で使う
- メモ保存の接続エラーなど、画面に出ない問題を管理者が把握したい
- プラグイン設定の変更履歴を残しておきたい
- 本番運用で、障害の兆候を早めに検知したい
ログに記録される主なタイミング
- プラグイン設定を保存したとき
- プラグイン動作中にエラーが発生したとき（検知できないエラーもあるため、すべてが記録されるわけではありません）
ログアプリの設置場所
ログ設定でまず確認するのは、ベンリーノートを入れたアプリがゲストスペース内かどうかです。ゲストスペース内と外では、セッション認証で接続できるログアプリの範囲が変わります。
- ゲストスペース外（ポータル・通常スペースのアプリ） … ログアプリもゲストスペース外に置けます。ポータル上のアプリ、通常スペース内のアプリなど、スペースに所属しないアプリもこちらに含まれます。複数の業務アプリから1つのログアプリにまとめて書き込む運用が可能です。
- ゲストスペース内 … ログアプリは同じゲストスペース内に作成してください。ゲストスペース外のログアプリには、セッション認証では接続できません。
「通常スペースかポータルか」よりも、ゲストスペース内にあるかが重要です。ゲストユーザーが利用する現場ではログアプリもゲストスペース内に置くのが基本です。ゲストスペース外の社内向けアプリだけであれば、ポータル・通常スペース側にログアプリを置いて集約する構成も取れます。
ログアプリのアクセス権と認証方式
ログの書き込みに必要な権限は、選んだ認証方式によって異なります。ここがログ設定で最も重要なポイントです。
| 観点 | セッション認証 | APIトークン認証 |
|---|---|---|
| 書き込みに使う権限 | ログイン中の利用者の権限 | APIトークンの権限 |
| 利用者にログアプリの「レコード追加」が必要か | 必要（ログを残す操作をした本人が追加できること） | 不要（利用者に追加権限がなくても記録できる） |
| ログアプリ側で必要な設定 | ログを残す利用者ごとに「レコード追加」権限を付与 | APIトークンに「レコード追加」権限を付与（利用者のアクセス権は問わない） |
| ログの閲覧を管理者だけにしたい場合 | 閲覧は管理者のみ、追加は利用者にも付与、という分け方が必要 | 閲覧は管理者のみ、追加はトークンだけ、としやすい |
| ゲストユーザーの操作 | ゲストユーザー本人に追加権限があれば記録できる | 記録されない |
セッション認証のとき
ログイン中のユーザー権限でログアプリにレコードを追加します。ログを残す利用者本人が、ログアプリに「レコード追加」できる必要があります。
- 利用者全員に Everyone の「レコード追加」を付与する、または利用者が属するグループに付与する
- 接続確認は設定画面を開いた管理者の権限で行われるため、管理者だけ成功しても、利用者全員分は保証されません。利用者の権限もあわせて確認してください
- ゲストスペース内のアプリでは、ログアプリも同一ゲストスペース内に置く
- ゲストスペース外（ポータル・通常スペース）では、利用者がアクセスできる同一サブドメイン内のアプリを指定できる
APIトークン認証のとき
プラグインに登録した API トークン経由でログアプリへ書き込みます。利用者にログアプリの「レコード追加」権限がなくても、トークンに権限があればログは記録されます。
- ログアプリの API トークンに「レコード追加」権限を付与する（利用者のアクセス権設定とは別）
- ログアプリの閲覧を管理者だけに限定し、業務アプリの利用者にはログアプリを見せない、という運用がしやすい
- メモ保存の API トークン設定と共通（どちらの入力欄で変更しても同期）
- ゲストユーザーからの操作ではログは記録されません。ゲストユーザーのエラーも残したい場合はセッション認証を選び、ログアプリを同一ゲストスペース内に置いてください
- セッション認証 … シンプルに始めたい、ゲストユーザーのログも残したい
- APIトークン認証 … 利用者にログアプリの追加権限を渡したくない、ログの閲覧を管理者に閉じたい
認証方式と設置場所の組み合わせ
ベンリーノートを入れたアプリがゲストスペース内か外か、ログアプリをどこに置くかによって、選べる認証方式が変わります。
| ベンリーノートを入れたアプリ | ログアプリの置き場所 | 利用者 | おすすめの認証方式 |
|---|---|---|---|
| ゲストスペース外（ポータル・通常スペース） | ゲストスペース外（利用者が追加できる場所） | 社内ユーザーのみ | セッション認証 |
| ゲストスペース外（ポータル・通常スペース） | ゲストスペース外（閲覧は管理者のみ、利用者に追加権限なし） | 社内ユーザーのみ | APIトークン認証（利用者に追加権限がなくても記録可） |
| ゲストスペース内 | 同一ゲストスペース内 | ゲストユーザーも含む | セッション認証 |
| ゲストスペース内 | ゲストスペース外（ポータル・通常スペースなど） | 社内ユーザーの操作のみログ化 | APIトークン認証（ゲスト操作は記録されない） |
| 複数アプリ（ゲストスペース内外混在） | 1つのログアプリに集約 | 構成による | アクセスできる利用者構成に合わせて要設計（下記参照） |
ゲストスペース外の複数アプリ（ポータル・通常スペース）から1か所に集約し、利用者にログアプリを見せたくない場合は、APIトークン認証＋管理者のみ閲覧の構成が扱いやすいです（利用者にレコード追加権限は不要）。ゲストスペース内のアプリも含め、ゲストユーザーのログまで残すならゲストスペース内に別のログアプリを置き、ゲスト向けアプリはセッション認証でそちらへ記録する構成を検討してください。
設定手順
- プラグイン設定の「設定・運用」タブを開く
- ログアプリテンプレートをダウンロードする
kintoneシステム管理の「アプリテンプレート」から読み込み、テンプレートからログアプリを作成します。設置場所は上記「ログアプリの設置場所」を参照してください。 - ログアプリの権限を設定する
認証方式に応じて設定します。セッション認証の場合は、ログを残す利用者に「レコード追加」権限を付与してください。APIトークン認証の場合は、利用者への追加権限は不要で、APIトークンに「レコード追加」権限を付与します。 - 認証方式を選び、ログ記録を「記録する」にする
上記「認証方式の選び方」に従ってセッション認証またはAPIトークン認証を選び、ログアプリIDを入力します。接続確認が成功することを確認してから保存します。 - （任意）ログアプリで条件通知を設定する
例：ログ種別が Error のレコードが追加されたとき、管理者にメール通知する、といった条件通知を設定できます。
条件通知で管理者に知らせる
ログアプリは通常のkintoneアプリと同様に、レコードの条件通知を設定できます。ログ種別（LOG_TYPE）が Error のレコードが追加されたときだけ通知する、といった運用がおすすめです。
通知を受け取ると、利用者の画面には表示されなかったエラーも、管理者がログアプリで内容を確認し、対処を進められます。
「処理続行」を選ぶと、利用者の作業は止めずにログだけ残します（ログ記録ONの場合）。「処理停止」を選ぶと、利用者にエラーが表示され、処理が中断される場合があります。業務を止めたくない場合は処理続行を選んでください。
テンプレートの注意点
- テンプレートに含まれるフィールドのフィールドコード変更・削除は行わないでください（かりんこラボ製プラグインと共通の仕様です）
- フィールドの追加、通知やプロセス管理の設定、一覧やグラフの追加、アプリ名・アイコンの変更は問題ありません
- 複数のベンリーノート導入アプリから、1つのログアプリにまとめて書き込むこともできます
- かりんこラボ製プラグインとベンリーノートのログを、同じログアプリに集約することもできます