Info | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
We need to:
A separate section needs to be about using the Mnoe API for events retrieval
|
The audit log is managed by an event logger provided by MnoEnterprise (MnoEnterprise::EventLogger
).
Table of Contents | ||
---|---|---|
|
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:
- A user does something that triggers a logged event.
- As the action is processed by MnoEnterprise the event logger is notified.
- Each action or event is then sent to various listeners.
- 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
- Audit Events Listener
- The audit events listener creates a record or audit trail of events that can be accessed via the MnoEnterprise API.
- Intercom Events Listener
- The Intercom events listener creates intercom events.
- DIY Listeners
- Listeners can be created and added to the event logger to adopt custom behaviors.
Status | ||||
---|---|---|---|---|
|
1.2 - Events
The following events and metadata are logged via the MnoEnterprise::EventLogger
App Events
Event | Description | Metadata | |||||
---|---|---|---|---|---|---|---|
'app_add ' | Application added to dashboard |
| |||||
'app_destroy ' | Application deleted from dashboard |
| |||||
'app_launch ' | Application launched/started |
|
Dashboard Events
Event | Description | Metadata | |||||
---|---|---|---|---|---|---|---|
'dashboard_create ' | Dashboard created |
| |||||
'dashboard_delete ' | Dashboard deleted |
|
Organization Events
Event | Description | Metadata | ||
---|---|---|---|---|
'organization_create ' | Organization created |
| ||
'organization_destroy ' | Organization deleted |
|
User Events
Event | Description | Metadata | |||||
---|---|---|---|---|---|---|---|
'user_invite ' | User invited to team/organization |
| |||||
'user_login ' | User logged into platform |
| |||||
'user_logout ' | User logged out of platform |
| |||||
'user_update ' | User attributes changed |
| |||||
'user_confirm ' | Confirmed user account |
| |||||
'user_timeout ' | User session expired |
| |||||
'user_update_password ' | User changed password |
| |||||
'register_developer ' | User registered as a developer |
|
Widget Events
Event | Description | Metadata | ||
---|---|---|---|---|
'widget_create ' | Widget added to dashboard |
| ||
'widget_delete ' | Widget removed from dashboard |
|
Info | ||||||
---|---|---|---|---|---|---|
| ||||||
The following events are not currently tracked by the About users:
About sign-up:
About teams:
About apps:
About Impac!™:
Actions not tracked for Impac!
|
1.2.1 - Intercom Events
If /wiki/spaces/UKB/pages/58065026 is enabled, the MnoEnterprise::EventLogger
will also create Intercom events.
Status | ||||
---|---|---|---|---|
|
MnoEnterprise | Intercom |
---|---|
'user_confirm' | 'finished-sign-up' |
'dashboard_create' | 'added-dashboard' |
'dashboard_delete' | 'removed-dashboard' |
'widget_delete' | 'removed-widget' |
'widget_create' | 'added-widget' |
'app_launched' | 'launched-app-{app_nid}' Ex: 'launched-app-inv-tracker' |
'app_destroy' | 'deleted-app-{app_nid}' |
'app_add' | 'added-app-{app_nid}' |
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:
Code Block | ||||
---|---|---|---|---|
| ||||
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.