Audit.NET Documentation

Audit.NET provides a wide range of specialized extension packages to intercept and audit interactions with different .NET frameworks and systems. Depending on your technology stack, you can use these extensions to generate detailed audit logs without manually instrumenting every operation.

Supported Systems and Extensions:

• Web & APIs

  • Audit.AzureFunctions: Middleware for Azure Functions.
  • Audit.HttpClient: Message handler for HttpClient REST calls.
  • Audit.MVC: Action filter attributes for MVC (including ASP.NET Core).
  • Audit.WebApi: Action filter attributes or middleware for Web API (including ASP.NET Core).
  • Audit.SignalR: Intercepts SignalR and SignalR Core hub processing.
  • Audit.Grpc.Server / Audit.Grpc.Client: Interceptors for gRPC server and client calls.
  • Audit.WCF / Audit.WCF.Client: Behaviors for Windows Communication Foundation (WCF).

• Data & Persistence

  • Audit.EntityFramework: Inherit from DbContext or IdentityDbContext for Entity Framework (EF 6 and EF 7/EF Core).
  • Audit.MongoClient: Command Event Subscriber for the MongoDB Driver.
  • Audit.FileSystem: Intercepts file system events via FileSystemWatcher.

• Application Patterns & Background Jobs

  • Audit.DynamicProxy: Uses a proxy to audit any class without code changes.
  • Audit.MediatR: Pipeline behavior for MediatR requests.
  • Audit.Hangfire: Filter attribute for Hangfire background jobs.

The Firestore provider supports several authentication methods:

• Default Application Credentials: Works automatically if running on GCP or with environment variables configured.
• Service Account Key File: Provide a path to a JSON credentials file using .CredentialsFromFile(path).
• Service Account JSON String: Provide a JSON string using .CredentialsFromJson(jsonString).
• Custom FirestoreDb Instance: Provide a pre-configured FirestoreDb instance using .FirestoreDb(firestoreDb).

Audit.Core.Configuration.Setup()
    .UseFirestore(config => config
        .ProjectId("your-project-id")
        .CredentialsFromFile("path/to/credentials.json")
        .Collection("AuditEvents"));

// Service Account JSON String
Audit.Core.Configuration.Setup()
    .UseFirestore(config => config
        .ProjectId("your-project-id")
        .CredentialsFromJson(credentialsJsonString)
        .Collection("AuditEvents"));

// Custom FirestoreDb Instance
var firestoreDb = FirestoreDb.Create("your-project-id");
Audit.Core.Configuration.Setup()
    .UseFirestore(config => config
        .FirestoreDb(firestoreDb)
        .Collection("AuditEvents"));

You can configure the RavenDB data provider during application startup by setting the Audit.Core.Configuration.DataProvider property or using the UseRavenDB fluent API method.

Important for .NET 5.0+: Since the RavenDB C# Client depends on Newtonsoft.Json, it is highly recommended to call .JsonNewtonsoftAdapter() in your global setup to ensure proper serialization.

Common configuration patterns include:

• Using WithSettings to define URLs and a default database.
• Using a function to dynamically select a database based on the AuditEvent type.
• Providing an existing IDocumentStore instance.

// Option 1: Direct assignment with fluent settings
Audit.Core.Configuration.DataProvider = new RavenDbDataProvider(config => config
    .WithSettings("http://127.0.0.1:8080", "AuditEvents"));

// Option 2: Global setup with Newtonsoft adapter (Recommended for .NET 5+)
Audit.Core.Configuration.Setup()
    .JsonNewtonsoftAdapter()
    .UseRavenDB(config => config
        .WithSettings(settings => settings
            .Urls("http://127.0.0.1:8080")
            .Database(ev => "Audit_" + ev.EventType)
            .Certificate(cert)));

// Option 3: Using an existing IDocumentStore
Audit.Core.Configuration.Setup()
    .UseRavenDB(config => config
        .UseDocumentStore(new DocumentStore()
        {
            Urls = new[] {"http://127.0.0.1:8080"},
            Database = "AuditEvents"
        }));

You can configure the MongoDB data provider during application startup using either the static DataProvider property or the fluent configuration API. This must be done before any AuditScope is created.

Option 1: Static Property

Set Audit.Core.Configuration.DataProvider directly with an instance of Audit.MongoDB.Providers.MongoDataProvider.

Option 2: Fluent API

Use Audit.Core.Configuration.Setup().UseMongoDB(...) to configure the provider.

Option 3: Using MongoClientSettings

Instead of a connection string, you can provide a MongoClientSettings object for more granular control over the connection.

// Using static property
Audit.Core.Configuration.DataProvider = new Audit.MongoDB.Providers.MongoDataProvider()
{
    ConnectionString = "mongodb://localhost:27017",
    Database = "Audit",
    Collection = "Event"
};

// Using Fluent API
Audit.Core.Configuration.Setup()
    .UseMongoDB(config => config
        .ConnectionString("mongodb://localhost:27017")
        .Database("Audit")
        .Collection("Event"));

// Using MongoClientSettings
Audit.Core.Configuration.Setup()
    .UseMongoDB(config => config
        .ClientSettings(new MongoClientSettings() 
        {
            Server = new MongoServerAddress("localhost", 27017), 
            UseTls = true 
        })
        .Database("Audit")
        .Collection("Event"));