loujaybee / phat-event Goto Github PK

PLEASE NOTE Phat-event is a beta library, currently under development.

Opinionated helper library for constructing one-per-service log events.

There are many disadvantages of logging across many log lines.

Phat events solves this and gives the following advantages...

• Easily to correlate data (Do users in X region correlate with an integration failure)
• Less log data (one emit per service request)
• Easier to read in log files (one emit per service request)
• Opinionated structure (less endless debates about log structure)

So that this:

{ level: 'INFO', message: 'Started Lambda' }
{ level: 'INFO', message: 'Calling /user' }
{ level: 'INFO', message: 'User recieved' }
{ level: 'INFO', message: 'Getting user ID' }
{ level: 'INFO', message: 'Responding to Lambda' }

Becomes this:

{
    level: 'INFO',
    started: true,
    steps: [ { name: 'Called user', success: true } ],
    responded: true
}

Install: npm install phat-event

const PhatEvent = require("phat-event");
const phatEvent = new PhatEvent();

phatEvent.configure({ log: console.log })

phatEvent
    .addKey('key', true)

phatEvent
    .emit();

A log event is a form of structured log, that is updated throughout the lifecycle of a service and a single structured event is emitted at the end of the service.

Rather than this:

{ "timestamp": "X", "message": "Something" }

You have this:

{
    "timestamp": "X",
    "step1": {
        "input": {
            ...
        }
        "output": {
            ...
        }
    }
}

But log events have downsides.

• If the service fails unexpectedly, the event might not be emitted.
• Each emitted property is not timestamped by default
• Poor naming of properties makes it harder to understand property meanings
• There is no "standard" way to structure these fat log events

phat-event is not a logging library. Phat event is primarily for the opinionated construction of a fat single log line entry, it is not for the act of logging, you decide the logger you want to use.

Documentation for the public API of phat-event.

The configure method takes an object of configuration properties, such as:

• log — The method that is called when the emit event is triggered.

Adds a key and value to the event object.

Nested properties can be passed by using dot delimiters between keys prop.prop.prop.

Convers

Invokes the configured log method and applies the event as the first argument.

This method allows the log entry to be emitted at the end of service processing.

• Return the constructor, rather than the object instance

• Bugfix to allow .sanitise to access deeply nested properties.

• Implements .sanitise
  • A helper method which implements method to block out large or sensitive properties.

• Implements push method

Naming things is hard. And something dry like "event emitter" or similiar isn't noteworthy enough.

As a topic discussed heavily by Charity Majors, I stole the name from her tweet thread: this tweet thread comment where she refers to the event objects as "phat", which made me laugh and is now the name of this library.