/auditable

Audit library for dotnet

Primary LanguageC#Apache License 2.0Apache-2.0

auditable

release Nuget docs

dbones-labs codecov Codacy Badge

This is a small auditing framework

The need for auditing already exists in projects, the requirement to log information to prove something happened, but also to capture who, what and when a business action happened.

Features

  • Unit of work style to auditing changes
  • track Read, Removed and Modified instances
  • full delta is provided using the Json Patch Specification
  • Customise what you write to the audit log with your own Parser
  • Log anywhere, File, Console or bring bring your own if you need
  • changes can be audited as explicit or observed
  • capture who with the IPrincipal or IClaimsPrincipal
  • Supports tracing, using the OpenTelemerty/W3C specification

Downloads

you can find all packages here:

Nuget

Major releases

Nuget

We use Milestones to represent an notable release

Patch / feature releases

We use a variant of Githubflow, so all feature branches have their own pre-release packages

Docs and examples

check out our docs for examples and more information

docs

Use of this library

As this is about auditing your code, it is recommend that you fully test your use-cases to ensure that the requirement is met fully.