logdna / logdna-bunyan Goto Github PK

I see that package logdna has been deprecated recently:

logdna has been renamed to @logdna/logger. Please install the latest version of @logdna/logger instead of logdna

Will this package be updated to depend on @logdna/logger? Or is there a replacement for this package we should use instead?

Thanks.

Hello,

We tried to use LogDNA with our stage environment and found that message sequence of different microservices mixed in some cases. We hoped that found that core of this issue is:

// LogDNA adds their own - lets assume the time delta is trivial
// record['timestamp'] = record.time;

In log heavy cases it's definitely not trivial. :)

BUT it was not fix our issue :(

NOTE: Issue moved from logdna/nodejs#24

Node.js: 8.9.1
logdna-bunyan: ^1.0.0
bunyan: ^1.8.12
sequelize: ^4.8.4

How to reproduce:

1. Run an application where you use Bunyan and LogDNA's BunyanStream sub-module to log, and Sequelize for DB connection.
2. Try log a raw, unformatted Sequelize object

What happens:
The log is not executed (the information is not logged and does not reach LogDNA).
The server app freezes.

More info:
So, this is the unformatted Sequelize object that is trying to get logged:

[ registration {
    dataValues:
     { id: '1',
       customerId: '1',
       date: '2017-10-10',
       userId: '1',
       amount: 1800,
       unit: 'kg',
       currency: 'DKK',
       kgPerLiter: 15,
       cost: '5000',
       comment: 'Hello test',
       manual: true,
       scale: 'true',
       updatedAt: 2017-10-09T10:30:42.000Z,
       createdAt: 2017-10-09T10:30:42.000Z,
       deletedAt: null,
       areaId: '2',
       productId: '2',
       area_id: '2',
       product_id: '2' },
    _previousDataValues:
     { id: '1',
       customerId: '1',
       date: '2017-10-10',
       userId: '1',
       amount: 1800,
       unit: 'kg',
       currency: 'DKK',
       kgPerLiter: 15,
       cost: '5000',
       comment: 'Hello test',
       manual: true,
       scale: 'true',
       updatedAt: 2017-10-09T10:30:42.000Z,
       createdAt: 2017-10-09T10:30:42.000Z,
       deletedAt: null,
       areaId: '2',
       productId: '2',
       area_id: '2',
       product_id: '2' },
    _changed: {},
    _modelOptions:
     { timestamps: true,
       validate: {},
       freezeTableName: true,
       underscored: false,
       underscoredAll: false,
       paranoid: true,
       rejectOnEmpty: false,
       whereCollection: [Object],
       schema: null,
       schemaDelimiter: '',
       defaultScope: {},
       scopes: [],
       hooks: {},
       indexes: [Object],
       name: [Object],
       omitNull: false,
       getterMethods: [Object],
       sequelize: [Object],
       uniqueKeys: {} },
    _options:
     { isNewRecord: false,
       _schema: null,
       _schemaDelimiter: '',
       raw: true,
       attributes: [Object] },
    __eagerlyLoadedAssociations: [],
    isNewRecord: false } ]

It does not get logged and the whole app freezes, becoming unresponsive to further requests.
Nevertheless, if I format the object into the actual thing that has to be logged:

[
    {
        "date": "2017-10-10",
        "createdAt": "2017-10-09 10:30:42",
        "updatedAt": "2017-10-09 10:30:42",
        "id": "1",
        "customerId": "1",
        "userId": "1",
        "amount": 1800,
        "unit": "kg",
        "currency": "DKK",
        "kgPerLiter": 15,
        "cost": "5000",
        "comment": "Hello test",
        "manual": true,
        "scale": "true",
        "deletedAt": null,
        "areaId": "2",
        "productId": "2",
        "area_id": "2",
        "product_id": "2"
    }
]

Then it works all fine.
I perform the formatting (as suggested from Sequelize) with JSON.parse(JSON.stringify(object)).

Of course, I don't want to log the unformatted object, because it contains a lot of redundant data, and I am going to format my objects before logging them.
I just thought it'd be nice to let you know about this issue.

The logdna-bunyan library is currently using logdna ^2.0.0, but that dependency is now on v3.

Can logdna-bunyan move to use logdna ^3.0.0 to pick up any new fixes and features?

A closing bracket is missing at

which results in

SyntaxError: missing ) after argument list

LogDNA stream deletes properties from record object and such modified object is then passed to any other raw bunyan stream declared after LogDNA stream, resulting in incomplete data logged with other streams.

This is because in JS objects are passed to functions as references. This means that modifying arguments inside the function actually modifies external object, not a local copy (because there is no local copy). Stream driver should not mutate received arguments in any way.

Example:

const bunyan = require('bunyan');

/* Basic stream which will get raw data and print it to the console */
class SimpleStream {
  write(record) {
    console.log(record);
  };
}

let LogDNAStream = require('logdna-bunyan').BunyanStream;
let logDNA = new LogDNAStream({
  key: '...apikey...'
});

var logger = bunyan.createLogger({
  name: 'test',
  streams: [
    { stream: new SimpleStream(), type: 'raw' }, // first: basic stream
    { stream: logDNA, type: 'raw' },             // second: logdna
    { stream: new SimpleStream(), type: 'raw' }, // third: basic stream
  ]
});

logger.warn('This is a warning');

The above logger instance uses three streams. The first prints to the console, the second is a LogDNAStream, the third prints to the console.

Expected behaviour: object printed to the console with first and third stream is the same.

Actual behaviour:

{ name: 'test',
  hostname: 'hostname',
  pid: 3296,
  level: 40,
  msg: 'This is a warning',
  time: 2018-04-21T10:36:05.294Z,
  v: 0 }
{ hostname: 'hostname',
  pid: 3296,
  time: 2018-04-21T10:36:05.294Z,
  v: 0 }

Result: LogDNAStream stream deleted some properties and later streams receive incomplete record. Actually, the most important fields are deleted, level and the message itself, which makes the log record useless.

Does this stream work with https://github.com/pinojs/pino?

Pino is basically a better version of Bunyan. Very similar interface and actively supported.