digitalbazaar/bedrock-event-log

Name: bedrock-event-log

Owner: Digital Bazaar, Inc.

Description: Bedrock Event Log

Created: 2015-12-08 15:55:16.0

Updated: 2017-11-30 21:41:21.0

Pushed: 2017-11-30 21:42:21.0

Homepage:

Size: 12

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

bedrock-event-log

A bedrock module that can be used to record events of defined types into a MongoDB collection.

Requirements

• npm v3+

Quick Examples

config = require('bedrock').config;
eventLog = require('bedrock-event-log').log;

n eventType property MUST be added for each type of event to be recorded
ig['event-log'].eventTypes.MyEvent = {
dex: 'itemCategory', // (optional) specify an event property name to use as an index
sureWriteSuccess: true  // when false, database operations are performed without waiting for a callback


tLog.add({
pe: 'MyEvent', // MUST correspond to a defined event type
te: new Date().toJSON(),
emCategory: 'itemCategory1234',
source: 'https://example.com/item/12345',
tor: 'user1234'
allback);

API

add(event, callback)

event properties:

• type: an event type that is defined in the event type config (string)(required)
• date: (iso8601)(required)
• resource: the system resource, could be a URL (string)(optional),
• actor: user to associate with the event (string)(optional)
• customField(s): arbitrary properties can be included in the event. One custom field may be specified as an index field in the event type config.