ELK Kinesis Logger
Send logs to an ELK stack via an AWS Kinesis stream.
The ELK stack should be using the Kinesis Input Plugin.
Why
The main use case is for AWS Lambdas. When you console.log
within a Lambda, they go into CloudWatch Logs.
Whilst CloudWatch Logs is good, an ELK stack is better!
Using this module, we can easily get logs into an ELK stack.
Installation
npm install @guardian/elk-kinesis-logger
Usage
Import the module:
const ELKKinesisLogger = require('elk-kinesis-logger');
Create a new logger:
const logger = new ELKKinesisLogger({
stage: 'PROD',
stack: 'my-stack',
app: 'my-app',
streamName: 'my-stream'
});
Open the logger:
logger.open();
Write a log message:
logger.log('something happened');
Ensure all logs have written by closing the logger:
logger.close().then(() => {
});
Authentication
ELKKinesisLogger uses a credential provider chain, loading credentials from:
- EnvironmentCredentials
- SharedIniFileCredentials
- TemporaryCredentials
You can set the AWS profile to use with SharedIniFileCredentials
by calling .withProfile()
:
const logger = new ELKKinesisLogger({
stage: 'PROD',
stack: 'my-stack',
app: 'my-app',
streamName: 'my-stream'
}).withProfile('profile1');
If the stream's access is restricted, you can specify a role arn to assume:
const logger = new ELKKinesisLogger({
stage: 'PROD',
stack: 'my-stack',
app: 'my-app',
streamName: 'my-stream'
}).withRole('arn:aws:iam::000000000000:role/my-role');
Complete example
const ELKKinesisLogger = require('elk-kinesis-logger');
const logger = new ELKKinesisLogger({
stage: 'PROD',
stack: 'my-stack',
app: 'my-app',
streamName: 'my-stream'
}).open();
const value = 5 * 5;
logger.log(`the value is ${value}`);
logger.close().then((writtenLogs) => {
// other work
});
Further examples
See the examples.
Contributing
- clone the repo
- update the code
- write a test
npm test
- commit
Publishing
npm publish