Skip to main content

Audit logs

The audit log is a paper trail of all notable activities on an Appsmith instance. It automatically captures and displays events by recording what activity was performed, who performed it, and when it occurred. With this information, you can ensure that you're able to follow up and address any unexpected or undesirable events.

info

Audit logs are only available on self-hosted, Business Edition instances of Appsmith.

Access the Audit Logs from the Admin Settings page.

You can find audit logs by navigating to your Admin Settings page, and finding the Audit Logs tab under the Others heading. From here, you can see all the events that have been tracked under your organization's account, along with the user, date, and time that the event was logged. Click the arrow next to any event to expand it and see its complete set of details in JSON form.

There are several kinds of events that are logged:

  • App-specific activity

    • Changes to pages
    • Datasource configuration
    • Query configuration and execution
    • Deleting apps
  • Changes to Administrator settings

    • Instance configuration changes
  • User sign-up and login activity

For an exhaustive list of events, see Tracked Events.

Log contents

Each logged item has a number of data points that describe that event, including references to related apps, datasources, queries, and workspaces. This data is served in JSON format.

DataDescriptionDetails
eventEach action performed on Appsmith app (edit or view mode) is classified as event
timestampDisplays the date and time of a logged event.
userDisplays the user who made performed this eventid, email, name
resourceThe type of resource on which this event was performed (Query, Datasource, etc.)id, type, name
appApplication on which the action is performed.id, name, git {branch, default}
workspaceWorkspace on which the action is performed.id, name
metadataPlatform details, such as the Appsmith version.appsmithVersion, createdAt

Below is an example of a log item:

{
"event": "datasource.created",
"timestamp": "2022-06-29T08:36:33.507+00:00",
"user": {
"id": "62bc0f11545c4c00b19d5c65",
"email": "john@appsmith.com",
"name": "John Doe"
},
"resource": {
"id": "62bc0f11545c4c00b19d5c59",
"type": "Datasource",
"name": "Movies"
},
"app": {
"id": "62bc0f11545c4c00b19d5c68",
"name": "Standup App",
"git": {
"branch": "feat/new-ui",
"default": "master"
}
},
"workspace": {
"id": "62bc0f11545c4c00b19d5c64",
"name": "Appsmith Internal Apps"
},
"metadata": {
"appsmithVersion": "1.7.5",
"createdAt": "2022-06-29T08:36:33.507+00:00"
}
}

Filtering audit logs

Active workspaces generate thousands of log events. To help you quickly find the log you're looking for, Appsmith offers a number of search filters:

Use filters to find specific types of log records
  • User: Users are identified by their email. To see a certain user's activity, filter the logs by their email.
  • Event: Logs are triggered by specific occurrences called Events, which each have a name. For example, to find all logs related to query execution, filter by the query.executed event. For a complete list of events and their names, see Tracked Events.
  • ResourceId: A resourceID identifies each entity on your Appsmith instance, be it a workspace, app, page, datasource, query, or JSObject.
  • Date Range: Show logs from only a certain period of time.

From the JSON area of any event (accessed by clicking the log record), you can use the 🔍event, 🔍email, or 🔍resource.id buttons to add that value to the search filters.

Tracked events

The following table shows the events that appear in Appsmith's audit logs. In any given log record, you can find the event's name on the record's event property.

Event NameDescription
workspace.createdLogged when a new workspace is created.
workspace.updatedLogged when the details of an existing workspace are changed.
workspace.deletedLogged when a workspace is deleted.
application.createdLogged when a new application is created.
application.updatedLogged when a user edits an existing application.
application.deletedLogged when an application is deleted.
application.importedLogged when a new application is created via importing with Git or JSON.
application.exportedLogged when an existing application is exported via Git or JSON.
application.clonedLogged when a new application is created via cloning.
application.forkedLogged when an existing application is forked.
application.deployedLogged when a new version of an application is deployed/published.
page.createdLogged when a new page is created.
page.viewedLogged when a user, including any anonymous public users, views a page.
page.updatedLogged when a user edits a page.
page.deletedLogged when a page is deleted.
datasource.createdLogged when a new datasource is created.
datasource.updatedLogged when a user edits an existing datasource's configuration.
datasource.deletedLogged when a datasource is deleted.
query.createdLogged when a new query is created.
query.updatedLogged when a user edits an existing query's configuration.
query.deletedLogged when a query is deleted.
query.executedLogged when an existing query runs. This applies both in Edit and View modes.
user.logged_inLogged when a user signs in.
user.logged_outLogged when a user signs out.
user.invitedLogged when someone invites another user to the app or workspace.
user.signed_upLogged when a new user logs in for the first time.
instance_setting.updatedLogged when a change is made to the Appsmith instance's configuration.