Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbhowell/pino-cloudwatch
AWS CloudWatch Logs transport for pino
https://github.com/dbhowell/pino-cloudwatch
cloudwatch-logs pino
Last synced: about 2 months ago
JSON representation
AWS CloudWatch Logs transport for pino
- Host: GitHub
- URL: https://github.com/dbhowell/pino-cloudwatch
- Owner: dbhowell
- License: mit
- Created: 2017-09-19T04:52:21.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T05:47:04.000Z (over 1 year ago)
- Last Synced: 2024-07-18T15:26:20.393Z (2 months ago)
- Topics: cloudwatch-logs, pino
- Language: JavaScript
- Size: 327 KB
- Stars: 37
- Watchers: 1
- Forks: 13
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pino-cloudwatch
#### Send pino logs to AWS CloudWatch Logs.
## About
`pino-cloudwatch` is a simple [pino](https://getpino.io/#/) transport that buffers and holds [pino](https://getpino.io/#/) logs until one of the following conditions are met:
* the number of logs reaches 10,000
* the 'size' of the logs reaches 1,048,576 bytes OR
* there is at least 1 log buffered and 1,000ms (default) has passed without another log item being buffered
This is to minimise the number of calls to CloudWatch Logs.
The log group name is specified via the CLI (`--prefix`) and the log stream name is built based on the following information:
* An optional `prefix`,
* the hostname (via `os.hostname()`),
* the process ID (via `process.id`),
* the epoch when the first log are sent to CloudWatch Logs
## Usage
```
# ./bin/pino-cloudwatch.js
Sends pino logs to AWS CloudWatch Logs.
Usage: node index.js | pino-cloudwatch [options]
Options:
--help Show help [boolean]
--version Show version number [boolean]
--aws_access_key_id AWS Access Key ID
--aws_secret_access_key AWS Secret Access Key
--aws_region AWS Region
--group AWS CloudWatch log group name [required]
--prefix AWS CloudWatch log stream name prefix
--stream AWS CloudWatch log stream name, overrides --prefix option.
--interval The maxmimum interval (in ms) before flushing the log
queue. [default: 1000]
```
## Options
### `group`: `String` (required)
### `prefix`: `String`
### `interval`: `Integer` (default `1000`ms, `0` to disable)
The `interval` is the amount of time in ms that must elapse before attempting to send logs to CloudWatch Logs. Increase this to reduce the number of calls to CloudWatch Logs.
If you set this to `0` then it will only send logs when:
* It reaches the maxiumum number of logs
* It reaches the maximum size of the logs
__note__: Disabling the interval could mean that logs will *never* be sent to CloudWatch Logs.
### `aws_access_key_id`: `String`
### `aws_secret_access_key`: `String`
### `aws_region`: `String`
## Other uses
### Writable Stream
This module can be required and used as a writable stream:
```javascript
var pump = require('pump');
var split = require('split2');
var pinoCloudWatch = require('pino-cloudwatch');
pump(process.stdin, split(), pinoCloudWatch({ group: 'test' }));
```
#### Writeable Stream Events
Since pino-cloudwatch returns a writable stream, you can attach event handlers like any other writeable stream (see https://nodejs.org/dist/v10.19.0/docs/api/stream.html#stream_writable_streams).
In addition, a `flushed` event is emitted once the logs are successfully pushed / saved in AWS CloudWatch Logs.
```javascript
var pump = require('pump');
var split = require('split2');
var pinoCloudWatch = require('pino-cloudwatch');
var streamToCloudWatch = pinoCloudWatch({ group: 'test' });
streamToCloudWatch.on('flushed', function () {
console.log('Logs were successfully sent to AWS CloudWatch');
});
pump(process.stdin, split(), pinoCloudWatch({ group: 'test' }));
```
### Arbitrary logs
Technically `pino-cloudwatch` can send any object mode stream to CloudWatch Logs. This includes *any* text-based log file. For example: tailing a standard log file like nginx access.log.
## Test
```
# npm test
```