操作日志

这里以pai-console 为例子

1、在后台工程目录添加/resource/log/pai-log.yaml

log:
  actions:
    - key: 'dept_staff_update'
      value: '部门与员工变更'
      types:
        - {key: 'add_dept',value: '新建了部门【${deptName}】'}
        - {key: 'update_dept',value: '编辑了部门【${deptName}】的信息'}
        - {key: 'del_dept',value: '删除部门【${deptName}】'}
        - {key: 'add_staff',value: '添加了员工【${staffName}】'}
       - {key: 'del_staff',value: '删除了员工【${staffName}】'}
       - {key: 'stop_staff',value: '停用了员工【${staffName}】'}
       - {key: 'edit_staff',value: '编辑了员工【${staffName}】'}
       - {key: 'pass_staff',value: '通过了【${staffName}】的加入申请'}
       - {key: 'refused_staff',value: '拒绝了【${staffName}】的加入申请'}
       - {key: 'enable_staff',value: '启用了员工【${staffName}】'}
    - key: 'ent_update'
      value: '企业信息变更'
      types:
        - {key: 'edit_ent',value: '编辑了企业【${entName}】的信息' }
    - key: 'park_update'
      value: '园区信息变更'
      types:
        - {key: 'edit_park',value: '编辑了园区信息'}
        - {key: 'invite_ent',value: '邀请了企业【${entName}】'}
        - {key: 'park_edit_ent',value: '编辑了企业【${entName}】的信息'}
    - key: 'app_update'
      value: '应用套件变更'
      types:
        - {key: 'install_app',value: '安装了应用套件【${appName}】'}
        - {key: 'uninstall_app',value: '卸载了应用套件【${appName}】'}
        - {key: 'edit_app',value: '修改了应用套件【${appName}】的配置'}
        - {key: 'update_app',value: '更新了应用套件【${appName}】'}
        - {key: 'set_micro_visible',value: '设置了【${appName}】可见范围'}

    - key: 'role_update'
      value: '企业角色变更'
      types:
        - { key: 'add_ent_role',value: '添加【${roleName}】角色' }
        - { key: 'update_ent_role',value: '更新【${roleName}】角色' }
        - { key: 'del_ent_role',value: '删除角色【${roleName}】' }
        - { key: 'auth_role',value: '对【${roleName}】授权' }

    - key: 'park_user_update'
      value: 'c端用户变更'
      types:
        - { key: 'stop_user',value: '停止用户【${userName}】' }
        - { key: 'enable_user',value: '启用用户【${userName}】' }

log.actions.key：表示日志的大类，例如归属通讯录人员变更
log.acitons.types[]:表示日志具体的操作内容，支持${}获取请求参数内的内容

2、使用@SysLog 注解

package cn.flyrise.pai.console.model.constants;

/**
 * @author: zhucanyi
 * @description:
 * @date: Create in 1:56 下午 2020/7/24
 * @modified By:
 */
public class ConsoleConstants {

    //部门与员工变更--- start

    public final static String ADD_DEPT = "add_dept";

    public final static String UPDATE_DEPT = "update_dept";

    public final static String DEL_DEPT = "del_dept";

    public final static String ADD_STAFF = "add_staff";

    public final static String EDIT_STAFF = "edit_staff";

    public final static String STOP_STAFF = "stop_staff";

    public final static String DEL_STAFF = "del_staff";

    public final static String ENABLE_STAFF = "enable_staff";

    public final static String PASS_STAFF = "pass_staff";

    public final static String REFUSED_STAFF = "refused_staff";


    //部门与员工变更--- end

    public final static String EDIT_ENT = "edit_ent";

    public final static String EDIT_PARK = "edit_park";

    public final static String INVITE_ENT = "invite_ent";

    public final static String PARK_EDIT_ENT = "park_edit_ent";


    //应用套件变更

    public final static String INSTALL_APP = "install_app";
    public final static String UNINSTALL_APP = "uninstall_app";
    public final static String EDIT_APP = "edit_app";
    public final static String UPDATE_APP = "update_app";


    //企业角色

    public final static String ADD_ENT_ROLE = "add_ent_role";
    public final static String UPDATE_ENT_ROLE = "update_ent_role";
    public final static String DEL_ENT_ROLE = "del_ent_role";
    public final static String AUTH_ROLE = "auth_role";


    //c 端用户

    public final static String STOP_USER = "stop_user";
    public final static String ENABLE_USER = "enable_user";


    //微应用设置可见范围

    public final static String SET_MICRO_VISIBLE = "set_micro_visible";


    public static final String SUITE_NAME = "console:suite_name";

    public static final String USER_ICON_OSS = "console:user:icon:oss";

    //企业邀请

    public static final String JOIN_ENTERPRISE = "join_enterprise";
}

支持在方法级别使用，controller，service的方法都能使用
@SysLog(action = ConsoleConstants.PASS_STAFF)
action：/log/pai-log.yaml，log.actions.types.key 定义的key例如 pass_staff
saveParms：是否保存请求参数，默认为true
saveResponse： 是否保存返回数据，如敏感数据需设置为false

3、最后就可以在运营后台看到