@sidmoitra/pino-sqs NPM

pino-sqs

This module provides a "transport" for pino that forwards messages to AWS SQS queue. For other transports, see here

Installation

To use globally from command line:

$ npm install -g @sidmoitra/pino-sqs

To include as a library in your project:

$ npm install @sidmoitra/pino-sqs

CLI

Want to use @sidmoitra/pino-sqs from the CLI?

Given an application my-app that logs via pino, you would use @sidmoitra/pino-sqs like so:

1. If installed globally

$ node my-app | pino-sqs <options>

2. If installed as a library

$ node my-app | npx pino-sqs <options>

Usage

You can pass the following options via cli arguments or use the environment variable associated:

Full command	Environment variable	Description
--queue-url	PS_QUEUE_URL	The AWS SQS URL
--aws-access-key	PS_AWS_ACCESS_KEY	AWS Access Key
--aws-secret-key	PS_AWS_SECRET_KEY	AWS Secret Key
--aws-region	PS_AWS_REGION	AWS Region where SQS is deployed. If the value is not provided, pino-sqs tries to get the value from SQS URL
--stdout-enabled	-	If stdout is enabled, logs are also piped to stdout. Defaults to FALSE

Examples

Case 1: Without stdout

$ node my-app | pino-sqs --queue-url <queueUrl> --aws-access-key <access_key> --aws-secret-key <secret_key>

Case 2: With stdout

$ node my-app | pino-sqs --queue-url <queueUrl> --aws-access-key <access_key> --aws-secret-key <secret_key> --stdout-enabled

{"level":20,"time":1585736923904,"pid":86640,"hostname":"INF-2018-049.local","msg":"Ad anim nostrud mollit fugiat non.","sqsMessageId":"c7d3ab68-01d6-42b0-879d-0146d9538e23"}

...