README
This module provide and usefull helper to ship structured logs to logz.io.
Estructured logs are really important to process them through the ELK Stack.
Compatibility
The minimum supported version of Node.js is v6.
How to use it
To use the library you just need to follow the following steps Install the library with npm
npm install @autobits/logzio-logger
Import the library:
const logger = require('@autobits/logzio-logger');
library properties via environment variables
| Property | Default | Description |
|---|---|---|
| LOGZIO_TOKEN (String) | Mandatory. Your account token. Look it up in the Device Config tab in Logz.io | |
| LOGZIO_APPNAME (String) | nodejs_app | Your application name. |
| LOGZIO_DEBUGGING (String) | false | ship debugging logs (logger.debug(msg)) to logz.io |
| LOGZIO_TYPE (String) | nodejs | Log type. Help classify logs into different classifications |
Examples
index.js
try {
const logger = require('@autobits/logzio-logger');
console.log('-------------------');
logger.debug({ y: 1, z: 2 });
console.log('-------------------');
logger.information({ a: 1, b: 2 });
logger.info({ a: 1, b: 2 });
logger.log({ a: 1, b: 2 });
console.log('-------------------');
logger.warning('My text...');
logger.warn('My text...');
console.log('-------------------');
logger.error(Error("my error :) "));
logger.err(Error("my error :) "));
console.log('-------------------');
process.exit(1);
} catch (error) {
console.error(error)
}
How to Publish
Increasing package version
You will need to update the package.json file placed in the root folder.
identify the property version and increase the right number in plus one.
Login in NPM by console.
npm login
[Enter username]
[Enter password]
[Enter email]
If all is ok the console will show you something like this : Logged in as USERNAME on https://registry.npmjs.org/.
Uploading a new version
npm publish --access public
Ref: https://docs.npmjs.com/getting-started/publishing-npm-packages
Note: you will need to have a NPM account, if you don't have one create one here: https://www.npmjs.com/signup
Contributors
Autobits team.