@arateg/logger

CUSTOMIZED COLOR LOGGER

The logger has opportunities to print color messages and also send emails or messages to slack

You can write your own method names of logger and they are supported!

Install

$ npm i @arateg/logger --save

Usage

File .env must contain 5 values:

1. SMTP_USER - string. User who will send messages.
2. SMTP_PASS - string. Password for smtp user.
3. SMTP_HOST - string. SMTP host service.
4. EMAIL_RECEIVERS - string or array. Emails for messages.
5. LOG_FOLDER - string. Folder to save log files.
6. SLACK_ACCESS_TOKEN - string. Access token from your application in slack.
7. SLACK_RECEIVER - string. ID of person or channel in slack where to send messages.
8. DOMAIN - string. Domain name which is used in email message header on email log level

.env example

SMTP_USER='[e-mail]'
SMTP_PASS='password'
SMTP_HOST='smtp.gmail.com'
EMAIL_RECEIVERS='[e-mail]'
LOG_FOLDER='/var/logs/myapp'
SLACK_ACCESS_TOKEN='xoxp-111111111111-111111111111-111111111111-111111111111aaaaaaaaaaaaaaaaaaaa'
SLACK_RECEIVER='ZZZZZZZZZ'
DOMAIN='mysite.com'

index.js

const logger = require('@arateg/logger');
logger.iWantInfo('Message for admin', { something: 'Hello', someField: 'Great!' });
logger.warnLogWithEmail('Print and send Mail', { error: 'No error', sweetCakes: 'Give me 3!!!' });
logger.letMeSlackNotify('Message in slack please', { thisLoggerRank: 'GOAT' });

API

logger.<method>(string, object)

How it works:

 1. The logger has some keyword:
   + daemon
   + info
   + email
   + error
   + full
   + slack
   + warn
 2. Combine these words with any other words you want and create convient method name.
 3. Add a string as the 1st argument(message) and an object as the 2nd.
 4. Timestamp in format DD-MM-YYYY HH:mm:ss (31/12/2018 23:59:59) will be added automatically.
 5. You receive a colored message (and email send if needed and configured).

Description of keyword(log levels):

• "daemon" - print log in green color. Has debug log level.
• "info" - print log in cyan color. Has info log level.
• "email" - send a message with report to email. Print message of successful in yellow color. If some error when sending print message in red color to console.
• "error" - print log in red color. Has error log level.
• "full" - print log in gray color. Has silly log level.
• "slack" - send a message with report to slack. Print message of successful in yellow color. If some error when sending print message in red color to console.
• "warn" - print log in magenta color. Has warn log level.

Log files:

Logger creates a folder for logs regarding LOG_FOLDER in .env file. If LOG_FOLDER is not existed in .env file then logs will be saved in process.cwd() + /logs directory. There is a message in console ===== New log file ===== when new file is created each day.
Logger creates a new 2 files each day, where %DATE% has a format YYYY-MM-DD. :

• LogError-%DATE%.log. These files are related to error log level.
• LogCombined-%DATE%.log. These files are related to silly log level.