Skip to content

Commit 51fb452

Browse files
committed
Update logging section of README
1 parent 0d5d78d commit 51fb452

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,22 @@ HTTP_PORT=3000
3535
npm start or gulp serve (requires gulp to be installed globally)
3636
```
3737

38+
## Logging
39+
40+
Universal logging library [winston](https://www.npmjs.com/package/winston) is used for logging. It has support for multiple transports. A transport is essentially a storage device for your logs. Each instance of a winston logger can have multiple transports configured at different levels. For example, one may want error logs to be stored in a persistent remote location (like a database), but all logs output to the console or a local file. We just log to the console, you can add more transports.
41+
42+
### API logging
43+
Logs detailed info about each api request to console during development
44+
![Detailed API logging](https://cloud.githubusercontent.com/assets/4172932/12563354/f0a4b558-c3cf-11e5-9d8c-66f7ca323eac.JPG)]
45+
46+
### Error logging
47+
Logs stacktrace of error to console
48+
![Error logging](https://cloud.githubusercontent.com/assets/4172932/12563361/fb9ef108-c3cf-11e5-9a58-3c5c4936ae3e.JPG)]
49+
50+
## Debug messages
51+
52+
Coming soon.
53+
3854
## Deploy to Heroku
3955

4056
Coming soon.

0 commit comments

Comments
 (0)