winston-cloudwatch2.0.5 • Public • Published
Send logs to Amazon Cloudwatch using Winston
- logging to AWS CloudWatchLogs
- logging to multiple streams
- programmatically flush logs and exit
- logging with multiple levels
- creates group / stream if they don't exist
- waits for an upload to suceed before trying the next
- truncates messages that are too big
- batches messages taking care of the AWS limit (you should use more streams if you hit this a lot)
- support for Winston's uncaught exception handler
- support for TypeScript, see TypeScript definition
- see options for more
$ npm install --save winston winston-cloudwatch
AWS configuration works using
As a best practice remember to use one stream per resource, so for example if you have 4 servers you should setup 4 streams on AWS CloudWatch Logs, this is a general best practice to avoid incurring in token clashes and to avoid limits of the service (see usage for more).
As specified in the docs:
The AWS SDK for Node.js doesn't select the region by default.
so you should take care of that. See the examples below.
If either the group or the stream do not exist they will be created for you.
For displaying time in AWS CloudWatch UI you should click on the gear in the top right corner in the page with your logs and enable checkbox "Creation Time".
Remember to install types for both winston and this library.
var winston =WinstonCloudWatch = ;
You can also specify a function for the
logStreamName options. This is handy if you are using this module in a server, say with express, as it enables you to easily split streams across dates, for example. There is an example of this here.
Logging to multiple streams
You could also log to multiple streams with / without different log levels, have a look at this example.
Consider that when using this feature you will have two instances of winston-cloudwatch, each with its own
Programmatically flush logs and exit
Think AWS Lambda for example, you don't want to leave the process running there for ever waiting for logs to arrive.
You could have winston-cloudwatch to flush and stop the setInterval loop (thus exiting), have a look at this example.
This is the list of options you could pass as argument to
- level - defaults to
- logGroupName -
- logStreamName -
- awsOptions -
object, params as per docs, values in
awsOptionsare overridden by any other if specified, run this example to have a look
- jsonMessage -
boolean, format the message as JSON
- messageFormatter -
function, format the message the way you like. This function will receive a
logobject that has the following properties:
meta, which are passed by winston to the
logfunction (see CustomLogger.prototype.log as an example)
- proxyServer -
proxyServeras proxy in httpOptions
- uploadRate -
Number, how often logs have to be sent to AWS. Be careful of not hitting AWS CloudWatch Logs limits, the default is 2000ms.
- errorHandler -
function, invoked with an error object, if not provided the error is sent to
- retentionInDays -
Number, defaults to
0, if set to one of the possible values
1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653the retention policy on the log group written will be set to the value provided.
AWS keys are usually picked by
aws-sdk so you don't have to specify them, I provided the option just in case. Remember that
awsRegion should still be set if you're using IAM roles.
Please refer to the provided examples for more hints.
Note that when running the examples the process will not exit because of the
You could simulate how winston-cloudwatch runs by using the files in
running-process.jsrepresents a winston-cloudwatch process that sits there, sends a couple logs then waits for a signal to send more
log.shis a script that you could run to send logs to the above
At this point you could for example run
log.sh in a tight loop, like so
and see what happens in the library, this might be useful to test if you need
more streams for example, all you need to do is change
better reflect your needs.
If you want more detailed information you could do
$ WINSTON_CLOUDWATCH_DEBUG=true node examples/simulate/running-process.js
which will print lots of debug statements as you might've guessed.