基本監査ログ

目的・用途

セルフアーカイブにより、リポジトリを操作するユーザが多くなり、作業ミスによるトラブルの発生も増加すると考えられる。

リポジトリ操作に関するログを記録し、リポジトリ管理者以上がリポジトリ操作に関するログを取得できるようにする。

関連モジュール

• weko_logging

ログ取得機能マスタ定義

• パス: https://github.com/RCOSDP/weko/blob/v1.1.0/modules/weko-logging/weko_logging/config.py#L96-L324

• 設定キー：WEKO_LOGGING_USER_ACTIVITY_DB_SETTING

• どのような操作が行われた場合に、基本監査ログを出力するか定義したマスタ。

• 基本監査ログが出力された際に、どのような操作によって出力したか併せて保存。

• 出力したログの操作分類毎に機能IDが設定される。

  • 現状設定されている機能IDについては、機能ID 参照

• 機能に対する具体的な操作を処理IDとして設定する。

  • 現状設定されている処理IDについては、処理ID 参照

  • 具体的なイメージについてはマスタイメージ を参照

マスタイメージ

WEKO_LOGGING_OPERATION_MASTER = {
    "ITEM": {
        "id": 11
        "label": "アイテム操作"
        "operation": {
            "ITEM_CREATE": {
              "id": 1,
              "label": "アイテム登録",
              "target": "item",
            },
            "ITEM_UPDATE": {
                "id": 2,
                "label": "アイテム編集",
                "target": "item"
            }
        }
    }
}

機能ID

処理ID

01：一般

10：アイテムタイプ操作

11：アイテム操作

12：ファイル操作

20：ワークフロー操作

21：インデックス操作

22：著者DB

操作対象一覧

監査ログ出力

機能内容

• ログをDBと標準出力に出力する
• マスタに記述されている機能は画面からの操作でもAPIからの操作でもログを取る
• 一連の処理の中で複数の機能を利用している場合は複数のログが出る
  • 例えばアイテム変更の際、ファイルがふたつ登録されたときはファイル変更のログがふたつ出力され、メタデータ変更のログも出力される。

設定値

• DBへ出力するログレベル、およびDBのレコードの有効期限の設定

  • パス: https://github.com/RCOSDP/weko/blob/v1.1.0/modules/weko-logging/weko_logging/config.py#L82-L88

  • 設定キー：WEKO_LOGGING_USER_ACTIVITY_DB_SETTING

  • 現在の設定値：

WEKO_LOGGING_USER_ACTIVITY_DB_SETTING = {

"log_level": "ERROR",

"delete": {

"when": "months",

"interval": 3

}

}

• 標準出力するログの設定

  • パス: https://github.com/RCOSDP/weko/blob/v1.1.0/modules/weko-logging/weko_logging/config.py#L91-L93

  - 設定キー：WEKO\_LOGGING\_USER\_ACTIVITY\_DB\_SETTING

  - 現在の設定値：

WEKO_LOGGING_USER_ACTIVITY_STREAM_SETTING = {

"log_level": "ERROR"

}

テーブル定義

• テーブル名：user_activity_logs

  • json、remarks以外の項目はjsonの中に同じ項目を入れる

json項目定義

• 定義はjsonschemaとしてconfig.pyに追加する
• jsonの中で、テーブルのカラムにするものもある
• ログレベルは、機能IDと処理IDで規定された処理が成功した場合はINFO、なんらかの異常で処理が完了できなかった場合はERRORにする

サンプル

{
    "id": 5,
    "log_level": "ERROR",
    "date":"2025/02/21 7:38:19.201",
    "user_id": 1,
    "eppn": null,
    "ip_address":"192.168.56.1",
    "client_id":"Z6DWfNWrrGwEYvh5Dcf81SSkrH6BiqIja17Cu2Hs",
    "community_id": "ccp",
    "source": "/sword/service-document",
    "log_group_id": 2,
    "operation_type_id": 10,
    "operation_id": 2,
    "target":"item",
    "target_key":"2000001"
}

処理概要

• メソッドの引数から機能ID、処理ID、対象キー、備考を受け取る
• flaskパッケージのrequestやcurrent_userから値を取得する
  • requestから取得するもの：source、ip_address、client_id
  • current_userから取得するもの：user_id
• DBと標準出力にログを出力する
  • DBに書き込むときのフォーマット標準出力のフォーマットの定義は別にする
  • 日時はDBと標準出力で同じにする

監査ログ削除

機能内容

• 基本監査ログのDB保持期間を設定し、その期間を超えたログを削除する

処理概要

• 設定値 の WEKO_LOGGING_USER_ACTIVITY_SETTINGにある 「delete」キーの情報から設定期間を読み込む
  • 設定できる期間は任意の日、週、月、年とする
• 設定期間を超えたログをDBから物理削除する
  • バッチは一日に一回の間隔で回す

更新履歴