Audit Logs enable you to revisit user actions that took place within the Flamelink interface for a given project. This can be useful to determine when changes took place along with supporting context.
The Audit Logs feature is available as an add-on for our Firestarter, Bonfire & Inferno plans, and is included in the feature-set for Wildfire.
Please Note:
Audit Logs is currently only available for projects using Cloud Firestore
Audit Logs when enabled, could incur additional costs for your Firebase project since it creates write operations (and reads when viewed)
Log entries are only created when actions take place within the Flamelink interface and will not be created using either the Flamelink SDK or Firebase SDKs
Each log entry is written to your Firebase project database and is not stored on any of the Flamelink servers
If you are using custom Firebase database rules, please ensure read and create access is enabled for the relevant data location (for Cloud Firestore, logs are stored in the fl_auditLogs collection).
How to enable Audit Logs
Once you have ensured that the Audit Logs feature is enabled for your project, we can go ahead and enable logging.
As a project OWNER
Select the "Settings" tab from the project menu
Select "Audit Logs"
Toggle the "Enabled" switch
Retrieving logs
Now that our logs are enabled, and some user actions have taken place, let's go ahead and retrieve some of those logs.
Enter a From Date & End Date (optional) then select the "Search" button.
Viewing Log Details
To view the details for a given log, simply click on the row. This will present a screen with the full information for the selected log.
Audit Log Properties
Property | Example | Description |
Module | content | Module for which the action took place |
Action | save | Action that took place. |
Result | success | Result of the action |
Payload | { id: x1234, title: "Test" } | Data that was submitted for the action. |
UID | jsHTKSaakZgeazCdnBCxTdxBTVE3 | Firebase User ID |
User Display Name | Test User | Display name of the user |
User Permission ID | PYK3OnH9P9ZYoeNRUQci | Database entry ID for the user's permission group |
User Email | Email of the user | |
Selected Environment | production | Environment that was selected when the action took place |
Selected Locale | en-US | Locale that was selected when the action took place |
Date (User Locale) | 2021-11-17 | Date at the user's location when the action took place |
Time (User Locale) | 09:02:4637 | Time at the user's location when the action took place |
UTC Date-Time | Wed, 17 Nov 2021 08:02:46 GMT | Date in UTC timezone |
ISO Date-Time | 2021-11-17T08:02:46.375Z | Date in ISO timezone format |
JSON Date-Time | 2021-11-17T08:02:46.375Z | Date in Browser JSON format |
Timestamp | 1637136166375 | Browser timestamp format |