Zzdats.Audit.Sdk 10.0.3

Audit SDK

Integrate the Audit API into your C# project!

Audit providers

The preceding code shows the Startup class.

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddAudit(Configuration.GetSection("Lgp:Audit"));
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        app.UseAudit();
    }

    ...
}

Configure audit

Audit configuration is commonly provided by the audit section of appsettings.{Environment}.json files.

{
    ...
    "Lgp": {
        "Application": {
            "Id": 190
        },
        "Infrastructure": {
            "Authority": {
                "Url": "<authority_url>",
                "ClientId": "<authority_clientId>",
                "ClientSecret": "<authority_clientSecret>"
            },
            "Csso": {
                "Url": "<csso_url>"
            },
            "Service": {
                "Code": "AUDIT"
            },
            "Health": {
                "Enabled": true
            }
        },
        "Audit": {
            "Url": "<audit_url>",
            "ClientId": "<audit_clientId>",
            "ClientSecret": "<audit_clientSecret>"
        }
    }
}

Resilience configuration

Each audit HTTP client (BusinessEventProvider, PersonProcessEventProvider, ClassifierProvider, etc.) has its own resilience pipeline (retry, timeouts): it retries transient failures and bounds how long a call may block, but never fails fast, since an audit call must succeed before the calling operation can continue.

Defaults apply out of the box; override any setting via a Resilience section. To limit how long a request can block during an audit outage, lower TotalTimeout (and AttemptTimeout accordingly):

{
    "Lgp": {
        "Audit": {
            "Url": "<audit_url>",
            "ClientId": "<audit_clientId>",
            "ClientSecret": "<audit_clientSecret>",
            "Resilience": {
                "MaxRetryAttempts": 2,
                "RetryBaseDelay": "00:00:02",
                "AttemptTimeout": "00:00:10",
                "TotalTimeout": "00:00:45"
            }
        }
    }
}

In a Docker/environment-variable setup, nested sections use __ instead of :, e.g. Lgp__Audit__Resilience__TotalTimeout=00:00:45.

Config changes apply live, no restart needed.

For full control (e.g. custom retry predicates), build the HTTP clients yourself instead of calling AddAudit/AddAuditUsingSession, using AuditDefaults.ConfigureResiliencePipeline(builder, options) as a starting point.

Error handling

Audit provider calls can throw:

• AuditApiException — either the audit API returned a validation problem (HTTP 400, in which case ApiProblemDetails is populated), or the call timed out (AttemptTimeout/TotalTimeout exceeded, in which case ApiProblemDetails is null and InnerException is a Polly.Timeout.TimeoutRejectedException).
• HttpRequestException — a non-success response other than validation errors, including transient failures once retries configured via Resilience are exhausted.