4.6ABP应用层-审计日志

.6ABP应用层-审计日志"

ABP官方翻译文档

4.6 ABP应用层—审计日志

维基百科定义:审计跟踪(也称为审核日志)是一个安全相关的时间顺序记录,记录这些记录的目的是为已经影响在任何时候的详细操作,提供程序运行的证明文件记录、源或事件。

ABP提供了能够为应用程序交互自动记录日志的基础设施,它能记录你调用的方法的调用者信息和参数信息。从根本上来说,存储区域包含:

  • tenant id(相关的租户Id),

  • user id(请求用户Id),

  • server name(请求的服务名称【调用方法对应的类】),

  • method name(调用方法名称),

  • parameters(方法的参数【JSON格式】),

  • execution time(执行时间),

  • duration (执行耗时时间【通常是毫秒】),

  • IP address (客户端IP地址),

  • computer name(客户机名称),

  • exception (异常【如果方法抛出异常】)等信息。

  • 有了这些信息,我们不仅能够知道谁进行了操作,还能够估算出应用程序的性能及抛出的异常。甚至更多的,你可以得到有关应用程序的使用情况统计。

审计系统使用IAbpSession接口来获取当前用户Id和租户ID。

注意:关于IAuditingStore接口
审计系统使用IAuditingStore接口来保存审计信息。module-zero项目是这个接口的完整实现,当然你也可以通过自己的方式来实现这个接口。如果你不想自己实现这个接口,SimpleLogAuditingStore类可以直接拿来使用,它是实现方式是将审计信息写入日志中。

4.6.1 配置

可以在你的模块初始化方法(PreInitialize)中使用Configuration.Auditing的属性来配置审计,Auditing属性默认是启用状态(即true)。你可以禁用它,如下图所示:

public class MyModule : AbpModule
{
    public override void PreInitialize()
    {
        Configuration.Auditing.IsEnabled = false;
    }

    //...
}

以下是审计配置的属性:

  • IsEnabled: 用于设置完全启用或禁用审计系统。默认值:true.

  • IsEnabledForAnonymousUsers:如果设置成ture,未登陆的用户的审计日志也会保存。默认值: false.

  • MvcControllers: 在ASP.NET MVC 控制器中使用审计日志

  • IsEnabled: 在ASP.NET MVC中启用(true)或禁用(false)审计日志. 默认值: true.

  • IsEnabledForChildActions: 为MVC actions启用(true)或禁用(false)审计日志. 默认值: false.

  • Selectors: 选择使用其他类来处理审计日志的存储。

正如你所看到的,审计系统单独为mvc控制器提供了审计配置使之可以使用不同的方法来使用它。

Selectors是一个断言(推断类型)选择器列表,用于选择那种方式来保存审计日志。每一个选择器包含一个唯一的名称和一个断言。断言列表中默认的选择器,使用的是应用程序服务类。如下图所示:

Configuration.Auditing.Selectors.Add(
    new NamedTypeSelector(
        "Abp.ApplicationServices",
        type => typeof (IApplicationService).IsAssignableFrom(type)
    )
);

你可以在自己的模块初始化方法(PreInitialize)中添加自己的断言选择器。同样的,如果你不喜欢使用应用程序服务来保存审计日志,你也可以通过名称(name)来移除断言选择器,这就是为什么断言选择器的名称必须是唯一的(你也可以通过Linq的方式查找到选择器来移除它)。

4.6.2 通过属性来启用和禁用审计日志

当你使用配置项来配置断言选择器时,你可以通过使用Audited和DisableAuditing特性标记到单个类或单个方法来实现审计系统的启用和禁用。例如:

[Audited]
public class MyClass
{
    public void MyMethod1(int a)
    {
        //...
    }

    [DisableAuditing]
    public void MyMethod2(string b)
    {
        //...
    }

    public void MyMethod3(int a, int b)
    {
        //...
    }
}

上述列子中,MyClass类中除了MyMethod2明确标记不需要审计外,其他的方法都会被审计。Audited特性能够帮助你只想保存审计日志的方法,进行审计日志保存。

4.6.3 说明

保存审计日志的方法必须是public修饰的,private和protected修饰的方法将会被忽略。
如果调用的方法不在类的引用范围内,那么引用的方法必须是虚方法(virtual),如果依赖注入的是它自己的接口则不需要是虚方法(例如注入 IPersonService 来使用 PersonService类)。

ABP使用动态代理和拦截机制以后,使用虚方法是必须的。对MVC Controller actions 使用审计日志不是正确的做法,因为他们可能不是虚方法。

(4.1、4.2由厦门-浩哥翻译,4.3由Carl翻译,4.4由半冷翻译4.5由冰封翻译)

原文出处:https://github.com/ABPFrameWorkGroup/AbpDocument2Chinese

原文链接:

本文观点不代表 .Net中文网 立场,转载请联系原作者。

发表评论

登录后才能评论