log4js appender - AWS CloudWatch

This module provides a custom appender for [log4js][log4js_github] that
sends logs to AWS [CloudWatch][aws_cloudwatch] using the AWS [v3 SDK][cloudwatch_sdk].

[aws_cloudwatch]: https://aws.amazon.com/cloudwatch/
[cloudwatch_sdk]: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-logs/
[log4js_github]: https://log4js-node.github.io/log4js-node/

Features

- Batching: Send multiple log events in a single request to CloudWatch
- Buffering: Send logs after a specified timeout, regardless of the batch size
- Log Group and Stream Creation: Automatically create log groups and streams

Overview

Installation

$3

``sh
npm install log4js-appender-cloudwatch
`

Configuration

$3

Required

`plain
logs:PutLogEvents
`

**To enable the appender to create a group and log stream in AWS, adition roleare
required.**

`plain
logs:PutLogEvents
logs:CreateLogGroup
logs:CreateLogStream
logs:DescribeLogStreams
logs:DescribeLogGroups
`

Reqired for testing.

To run tests, create .env with AWS access and secret keys.

`plain
logs:PutLogEvents
logs:GetLogEvents
`

`json
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"logs:PutLogEvents",
"logs:GetLogEvents"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
`

$3

If you're using TypeScript, importing this library as a side effect will
automatically merge the log4js interface Appenders. This merging enables
autocomplete for the appenders configuration, providing convenient access to its
properties.

`ts
import "log4js-appender-cloudwatch";
`

$3

`ts
import log4js from "log4js";

import "log4js-appender-cloudwatch";

log4js.configure({
appenders: {
cloudwatch: {
type: "log4js-appender-cloudwatch",
accessKeyId: "",
secretAccessKey: "",
region: "",
logGroupName: "",
logStreamName: "",
batchSize: 10,
bufferTimeout: 1000, // in ms
},
},
categories: {
default: {
level: "debug",
appenders: [
"cloudwatch",
],
},
},
});

const log = log4js.getLogger();
// ...
`

Options

$3

_Required_\
Type: log4js-appender-cloudwatch

Type of appender that's loaded from node_modules.

$3

_Required_\
Type: number

Maximum number of log events to include in a single batch when sending. Once the
batch size is reached, it will be sent to CloudWatch.

$3

_Required_\
Type: number

Maximum time (in milliseconds) to wait before sending a batch of logs,
regardless of the batch size. If the timeout is reached before the batch size is
met, the logs will be sent.

$3

_Required_\
Type: string

The name of the log group in AWS CloudWatch Logs where your logs are stored.

$3

_Required_\
Type: string

The name of the log stream within the specified log group where your logs are
stored.

$3

_Required_\
Type: string

The AWS region where your log group and log stream are located.

$3

_Required_\
Type: string

Your AWS access key ID for authentication.

$3

_Required_\
Type: string

Your AWS secret access key for authentication.

$3

_Optional_\
Type: string

Your AWS session token for authentication. This is used when you are using temporary security credentials.

Testing

To test this library during development, you'll need to provide your AWS
credentials. These credentials should be stored securely in a .env file
located at the root of your project directory.

`sh


.env


ACCESSKEY_ID=""
SECRET_ACCESS_KEY=""
`

Then, you're ready to run tests:

`sh
npm test
``