AgentStack for es6/typescript
What is this?
- Application Stack for Enterprise Applications
What is this actually???
- Read configuration from
conf/settings.yaml
- Merge configuration from
conf/${NODE_ENV}.yaml
,conf/${NODE_ENV}.local.yaml
and environment variables. (if have) - Merge configuration from
data/settings.json
(only when DATA_DIR was defined ) - Print merged configuration on application start
- Do not print sensitive configuration name with
_KEY
,_PASSWORD
,_SECRET
or_TOKEN
postfix - Auto create missing dir if the configuration name ends with
_DIR
. (e.g. LOG_DIR folder) - Configuration with
_DIR
or_FILE
will resolve to absolute path automatically - Provide a
app.settings
object for application to access the final configuration - Provide a
app.logger
object for application to use, available transporters: Console, File or Webhook - Provide nested error object
Exception
which will concat all the stacktrace for nested errors - When transporter itself got errors. It will automatically fallback to another available transporter
- Trap linux signals
SIGHUP
,SIGINT
,SIGQUIT
,SIGTERM
- Log nodejs process events
uncaughtException
- Provide universal application event
beforeExit
,exiting
,exit
- The original log called on failed transporter will logged using fallback logger
- Add routing utils:
router
,route
,param
,middleware
- Add container registry utils:
router
,route
,param
,middleware
Why doing this?
- Because the things above is required for most enterprise applications. It should be shared across projects.
- It's very important. But it's not as important as application logic. It can save your time to bootstrap a new project.
- The same structure will make DevOps happy when doing deployment/monitoring on many projects. It should be standardized.
- Together with Agent Framework; it can be automatically inject into other classes when required. It should be easy to use.
Installation
npm install agentstack --save
OR
yarn add agentstack
Show me the code
// TypeScript 2.2+; // Node 6+var Application = Application; const app = ; // enable config, logger supportapp; // default, same with `app.init({ confDir: 'conf', root: process.cwd() })`// orapp; // if your configuration folder is not 'conf' // orapp; // if your root folder is not current working folder console;applogger; // the log will be automatically save in `LOG_DIR` folder
or if you prefer using factory function instead of 'new'
// ES6 or TypeScript; // ES5var CreateApplication = CreateApplication; var app = ;// orvar app = ;// orvar app = ; console;applogger; // the log will be automatically save in `LOG_DIR` folder in JSON format
Others
How do I rotate log files?
Consider we output our logs to /usr/share/myapp/logs/agent.log
We would rotate our log files with logrotate, by adding the following to /etc/logrotate.d/myapp
:
/usr/share/myapp/logs/agent.log {
su root
daily
rotate 7
delaycompress
compress
notifempty
missingok
copytruncate
}