proteusjs-console

1.0.0 • Public • Published

proteusjs-console

proteusjs-console is a transform stream useful for turning proteusjs server, database and http call events into formatted strings.

Build Status codecov Current Version

Lead Maintainer: Jai Kishan

Usage

new ProteusjsConsole([config])

Creates a new ProteusjsConsole object with the following arguments:

  • [config] - optional configuration object with the following keys
    • format - MomentJS format string. Defaults to 'YYMMDD/HHmmss.SSS'.
    • utc - boolean controlling Moment using utc mode or not. Defaults to true.
    • color - a boolean specifying whether to output in color. Defaults to true.

Output Formats

Below are example outputs for the designated event type:

  • [server event]

    • log - 160925/080223.698, [server:log] {event.data} pid: ({event.pid})
    • request - 160925/080710.318, [server:request] ${event.method} ${event.path}
    • response - 160925/080710.304, [server:response] http://localhost:6200: ${event.method} ${event.path} {} {event.statusCode} ({event.responseTime}ms)
    • ops - 160925/080722.290, [server:ops] memory: 66Mb, uptime (seconds): 31.802, load: [0,0,0]
    • error - 160925/080722.290, [server:error] message: event.errorMessage stack: event.errorStack
  • [database event]

    • query - 160925/065549.166, [knex:query] select [ sql: select * from log ]
    • end - 160925/071149.107, [knex:end] info: Query executed successfully
    • queryerror - 160925/072007.936, [knex:queryerror] error: [ select * from logg - ER_NO_SUCH_TABLE: Table 'sample.logg' doesn't exist ]
    • error - 160925/074231.942, [knex:error] error: [ select * from logg - ER_NO_SUCH_TABLE: Table 'sample.logg' doesn't exist ]
  • [httpclient event]

Package Sidebar

Install

npm i proteusjs-console

Weekly Downloads

3

Version

1.0.0

License

MIT

Last publish

Collaborators

  • geekjai