The audit log is managed by an event logger provided by MnoEnterprise (MnoEnterprise::EventLogger). 

1 - What is the MnoEnterprise::EventLogger?

The MnoEnterprise::EventLogger is responsible for the following:

• Processing of various actions performed by end users (eg: signing in, adding an application, etc.). 
  • The actions or events that the event logger tracks are pre-defined and listed in the events section below. 
• Creating a notification for each event and dispatching those notifications to various listeners.
  • Listeners are responsible for processing the events as they see fit. 

How it works: 

1. A user does something that triggers a logged event. 
2. As the action is processed by MnoEnterprise the event logger is notified.
3. Each action or event is then sent to various listeners. 
4. Each listener is responsible for processing the event/s as they see fit. 

1.1 - Listeners

Listeners are implemented in MnoEnterprise to process the events dispatched by the MnoEnterprise::EventLogger

1. Audit Events Listener
   • The audit events listener creates a record or audit trail of events that can be accessed via the MnoEnterprise API.
2. Intercom Events Listener
   • The Intercom events listener creates intercom events. 
3. DIY Listeners
   • Listeners can be created and added to the event logger to adopt custom behaviors. 

                   TODO: Technical article on DIY listeners coming soon. 

1.2 - Events 

The following events and metadata are logged via the MnoEnterprise::EventLogger

App Events 

{
  id: 2,
  uid: 'cld-7y9h',
  name: 'AccountingPro',
  app_nid: 'account-pro-us'
}

{
  id: 7,
  uid: 'cld-89r7',
  name: 'DemoApplication',
  app_nid: 'demo-app'
}

{
  id: 4,
  uid: 'cld-8y7f',
  name: 'Inventory Tracker',
  app_nid: 'inv-track'
}

Dashboard Events

{
  name: 'Sales Dashboard'
}

{
  name: 'Sales Dashboard'
}

Organization Events

{
id: 4,
uid: "org-fbjz",
name: "abc motors"
}

{
id: 4,
uid: "org-fbjz",
name: "Example Financial"
}

User Events

{
user_email: 'sample@example.com',
account_name: 'Example Company'
}

{
user_name: 'John Doe',
user_email: 'john.doe@example.com'
}

{
user_name: 'John Doe',
user_email: 'john.doe@example.com'
}

{
name: ['old name', 'new name'],
surname: ['old name', 'new name']
}

{
user_name: 'Johnny Doe',
user_email: 'JD5575@example.com'
}

{
user_name: 'Johnny Doe',
user_email: 'JD5575@example.com'
}

{
user_name: 'John Doe',
user_email: 'john.doe@example.com'
}

{
user_name: 'John Doe',
user_email: 'john.doe@example.com'
}

Widget Events

{
name: 'Account Balance'
}

{
name: 'Invoices List'
}

1.2.1 - Intercom Events 

If /wiki/spaces/UKB/pages/58065026 is enabled, the MnoEnterprise::EventLogger will also create Intercom events.

NOTE: Some events are named differently when being sent to Intercom. The following table illustrates the naming differences between MnoEnterprise and Intercom.

1.2.2 - Retrieving Events via the MnoHub API 

MnoHub API Documentation (Audit Events)

The Audit Log can be viewed from the admin panel: (Note: The 'Description' field can be customized; See Below)

The 'Description' field can be set to display custom messages via a config file: 

default: &DEFAULT
  events:
    app_add: "%{name} added"
    user_invite: "%{user_email} invited"
    dashboard_create: Dashboard '%{dashboard_name}' created
    dashboard_delete: Dashboard '%{dashboard_name}' deleted
    widget_create: Widget '%{widget_name}' added
    widget_delete: Widget '%{widget_name}' deleted

development:
  <<: *DEFAULT

uat:
  <<: *DEFAULT

production:
  <<: *DEFAULT

test:
  <<: *DEFAULT

The variables are the one from the event metadata.