# bunyan-firehose

> An AWS Firehose extension for the Bunyan logger

Latest version **0.0.5** (published 2017-10-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install bunyan-firehose
pnpm add bunyan-firehose
yarn add bunyan-firehose
bun add bunyan-firehose
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2017-10-07 |
| First published | 2017-08-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+12 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Eli Goldberg |
| Maintainers | slygon |

## Links

- npm: https://www.npmjs.com/package/bunyan-firehose
- Repository: https://github.com/Eli-Goldberg/bunyan-firehose
- Homepage: https://github.com/Eli-Goldberg/bunyan-firehose#readme
- Issues: https://github.com/Eli-Goldberg/bunyan-firehose/issues
- npm.io page: https://npm.io/package/bunyan-firehose

## Dependencies (4)

- [retry](https://npm.io/package/retry.md) 0.10.1
- [bunyan](https://npm.io/package/bunyan.md) 1.8.12
- [lodash](https://npm.io/package/lodash.md) 4.17.4
- [aws-sdk](https://npm.io/package/aws-sdk.md) 2.104.0

## Recent versions

- 0.0.5 (latest) — 2017-10-07
- 0.0.2 — 2017-08-29
- 0.0.1 — 2017-08-29

## README

# bunyan-firehose

An AWS Firehose extension for the Bunyan logger

inspired by [[@crccheck/kinesis-streams](https://github.com/crccheck/kinesis-streams)]

Installing
----------

    npm install bunyan-firehose

Writeable stream
----------------

    'use strict'

    const bunyan         = require('bunyan')
    const bunyanFirehose = require('./src')
    const AWS            = require('aws-sdk')

    const config = {
      streamName:  'logs-stream',
      region:      'eu-west-1',
      credentials: new AWS.Credentials({
        accessKeyId:     '<ACCESS_KEY_ID',
        secretAccessKey: '<SECRET_ACCESS_KEY>',
        sessionToken:    '<SESSION_TOKEN>'
      })
    }

    const stream = bunyanFirehose.createStream(config)

    stream.on('error', (err) => console.error(`Firehose log error: `, err))

    const loggerConfig = {
      name:        'Firehose Demo App',
      level:       'info',
      serializers: bunyan.stdSerializers,
      streams: [
        { stream: process.stdout, level: 'info' },
        { stream, type: 'raw' }
      ]
    }

    const msg  = 'Well hello there, firehose!'
    const data = { demo: 'data' }

    logger.info({ msg, data })
    logger.info('Simple strings are converted to objects in bunyan')
    logger.warn('This is a warning')

---
_Source: https://npm.io/package/bunyan-firehose · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
