Skip to main content
Version: v2.0

Audit Log

info

This feature is available in the Enterprise Edition of The Formance Platform. It is available as a preview on Formance Cloud sandboxes.

The Formance Platform ships with an Audit Log feature that allows you to track all activity within the platform, including activity events from API usage, organisation users, or machine-generated events. This feature is available for Enterprise Edition users.

Initialisation

Contact our support team in order to enable the Audit Log on your deployment. Once set up, logging will start at the current date for all activity on your organization, stacks, and enabled modules.

Concepts

The audit log system operates at three levels:

  • Organisation: Providing a detailed overview of all activity tied to the organisation itself, e.g. whenever a user is invited, has their permissions updated, or a new resource is created.
  • Resources: Providing a detailed event history of the lifecycle of the Formance Platform deployments created within the organisation.
  • Modules: Providing a detailed event history of the modules activity within a stack.

Each event record consists of the following fields:

IdentifierOriginDateActionData
A unique identifier for the eventThe user or system that triggered the eventThe timestamp when the event occurred in ISO 8601 formatCode for the event triggeredAdditional information about the event

Usage

Organisation logs

Organisation logs provide a detailed overview of all activity tied to the organisation itself. You can access these logs by using fctl with the following command:

fctl cloud org history <organization-id>

The following events are available:

ScopeEvent
organizationsorganizations.created
organizationsorganizations.deleted
organizationsorganizations.updated
organizationsorganizations.user.deleted
organizationsorganizations.user.updated
invitationsinvitations.created
invitationsinvitations.accepted
invitationsinvitations.accepted-from-link
invitationsinvitations.rejected
regionsregions.created
regionsregions.deleted
usersusers.created
usersusers.join-domain
stacksstacks.created
stacksstacks.deleted
stacksstacks.restored
stacksstacks.updated
stacksstacks.enabled
stacksstacks.disabled
stacksstacks.upgraded

Resources logs

Resources logs operate at the stack level, and provides a detailed event history of the lifecycle of the stack itself.

You can get an overview of these logs by using fctl with the following command:

fctl stack history <stack-id>

This event list is availble through the Formance Platform API (contact our support team for API access).

The following events are availble for the stack resource logs:

ScopeEvent
stacksstacks.disposal
stacksstacks.disposal-reset
stacksstacks.warned
stacksstacks.pruned
stacksstacks.status.updated
stacksstacks.reachness.updated
stacksstacks.module.enabled
stacksstacks.module.disabled
stacksstacks.module.status.updated

Modules logs

To access the modules activity logs, navigate to the "manage environments" section or directly access it from here of the console interface. From here, select navigate to the stack that you want to view the Audit Log for.

In the stack information panel, under the Audit logs section, navigate through the "Show logs" button to head to the Audit Log page.

Events available for the modules logs are structured as follows:

FieldDescriptionPath
IdentityThe originating user or machine tokendata.identity
HTTP MethodThe method used (e.g., GET, POST)data.request.method
Status CodeThe response status code (e.g., 200)data.response.status_code
HostThe host of the requestdata.request.host
EndpointThe API endpoint accesseddata.request.path
Request HeadersHeaders included in the requestdata.request.header.*
Response HeadersHeaders included in the responsedata.response.headers.*
Response BodyContent of the response bodydata.response.body