OptOut of Stored Procedures?

[StarGazer202424]

Hi

I have some Stored Procedures and I do not want to log into my audit.log. Most of them are just grabbing predefined lists.

Some of these SP are being called using EF Core and some are using Ado.net.

Is there something built in to filter these out like I can do with "optout" on classes?

[thepirat000]

Are you referring to events generated with the Audit Command Interceptor?

[StarGazer202424]

I am not too sure I have stuff like this

using(var context = dbFactory.CreateDbContext())
{
      var picklist = context.PickList.FromSqlRaw("EXEC GetPickList).ToList()
}

I will aslo have ones like this but just written in Ado.net

I see something like this in my logs

{
   CommandEvent: {
         CommandText: "EXEC GetPickList)"
         Result: {
               "Table1": [
                        { "Value": "Item1"},
                         { "Value": "Item2"}
                 ]

          }
   }
}

I am wondering if I can somehow disable this from being recorded. I know with the EF core addon I could just go to my "Picklist" class and put "OptOut/In" and I think it would not record it.

[StarGazer202424]

I do have AuditCommand

build.AddInterceptors(new AuditCommandINterceptor() 
{
           AuditEventType = "EF_Command",
          ExldueNonQueryEvents = true,
         IncludeReaderResults = true,
          LogParamaterValues = true
}).EnableSenstiveDataLogging();

[thepirat000]

The command interceptor has no knowledge of the .NET entity classes, so there's no way to opt out by class.

However, when using the AuditCommandInterceptor, you have additional options to filter or discard events.

1. Filter the reader events with the IncludeReaderEventsPredicate setting. For example:

optionsBuilder.AddInterceptors(new AuditCommandInterceptor()
{
    IncludeReaderEventsPredicate = cmd => cmd.CommandSource != CommandSource.FromSqlQuery || !cmd.Command.CommandText.Contains("GetPickList")
});

2. Discard the audit scope in the OnScopeCreated event with a custom action. For example:

Audit.Core.Configuration.AddCustomAction(ActionType.OnScopeCreated, scope =>
{
    var cmdEvent = scope.GetCommandEntityFrameworkEvent();
    if (cmdEvent?.CommandSource == CommandSource.FromSqlQuery && cmdEvent.CommandText.Contains("GetPickList"))
    {
        scope.Discard();
    }
});

[StarGazer202424]

@thepirat000 - Hey, your helping me with my other issue and noticed in your example project has

`     IncludeReaderEventsPredicate = cmdData => cmdData.CommandSource == CommandSource.LinqQuery,`

How do I incorporate this with what you posted here?

[thepirat000]

I don't understand your last question. The IncludeReaderEventsPredicate is a custom predicate on the commend to determine if it should be logged. I just put an example but you can add your custom logic as needed. Just set the IncludeReaderEventsPredicate property when instantiating the AuditCommandInterceptor to return true for the commands you want to log and false to ignore them

[StarGazer202424]

Sorry, in our discussion here you posted a sample project which I copied the code from into my application.

#692

I noticed in the sample project you have already set the "IncludeReaderEventsPredicate" I was not 100% sure what it is doing and how it ties into this problem I am having and if I need to do both.

    ```
// NOTE: Configure your database connection and audit interceptor
        builder.Services.AddDbContextFactory<PeopleContext>(opt =>
            opt.UseSqlite($"Data Source={nameof(PeopleContext)}.db")
                .AddInterceptors(new AuditCommandInterceptor()
                {
                    AuditEventType = "EF_COMMAND",
                    ExcludeNonQueryEvents = true,
                    ExcludeScalarEvents = true,
                    IncludeReaderEventsPredicate = cmdData => cmdData.CommandSource == CommandSource.LinqQuery,
                    IncludeReaderResults = true,
                    LogParameterValues = true
                })
                .EnableSensitiveDataLogging(), ServiceLifetime.Scoped);

        // NOTE: Configure your audit output, by default logs to files in the C:\Logs directory
        Audit.Core.Configuration.Setup()
            .IncludeActivityTrace()
            .UseFileLogProvider(f => f
                .Directory(@"C:\Logs")
                .FilenameBuilder(ev => $"{ev.StartDate:yyyyMMddHHmmssffff}_{ev.EventType}.json"));

[thepirat000]

Refer to the documentation on the CommandSource Enum.

• cmd.CommandSource == CommandSource.LinqQuery implies: Log any query executed on a DbSet, such as dbContext.People.First(p => p.Id == 1).
• cmd.CommandSource != CommandSource.FromSqlQuery || !cmd.Command.CommandText.Contains("GetPickList"), which is equivalent to
  !(cmd.CommandSource == CommandSource.FromSqlQuery && cmd.Command.CommandText.Contains("GetPickList")) means: Exclude from logging any commands executed via FromSqlRaw if they contain the string "GetPickList."

To combine both conditions, the predicate would be:

cmd.CommandSource == CommandSource.LinqQuery || !(cmd.CommandSource == CommandSource.FromSqlQuery && cmd.Command.CommandText.Contains("GetPickList"))

[StarGazer202424]

Okay let me review the link you sent. As I got a bit confused as I noticed that "GetPickList" was no longer being logged anymore when I added the line of

IncludeReaderEventsPredicate = cmdData => cmdData.CommandSource == CommandSource.LinqQuery,

So it made me wonder if this was another way to filter them out or if something else is going on.