README.md

Audit Service

The Audit Service exposes an API to create and query audit logs. It allows us to answer questions such as:

• How many times did userA download file1 this month?
• When did userA download file1?
• Which files from dataset D were downloaded yesterday?
• How many times were files from dataset D downloaded yesterday?
• How many users downloaded data last year?
• How many unique users logged in since the creation of the Data Commons?
• How many users logged in via identity provider X last year?

The server is built with FastAPI and packaged with Poetry.

Key documentation

The documentation can be browsed in the docs folder, and key documents are linked below.

• Detailed API Documentation
• API example requests
• Quick start
• Local installation
• Deploying the Audit Service to a Gen3 Data Commons
• Architecture
• Query response page size
• Creating audit logs
• How to add a new audit log category?