# @timberio/bunyan

> Timber.io - Bunyan writable stream

Latest version **0.35.0** (published 2019-08-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @timberio/bunyan
pnpm add @timberio/bunyan
yarn add @timberio/bunyan
bun add @timberio/bunyan
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.35.0 |
| Published | 2019-08-19 |
| First published | 2019-01-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 36 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 44 |
| Author | Lee Benson |
| Maintainers | binarylogic, jszwedko, leebenson, luciofranco, zsherman |
| Keywords | Timber, logger, logging, node, winston |

## Links

- npm: https://www.npmjs.com/package/@timberio/bunyan
- Repository: https://github.com/timberio/timber-js
- Homepage: https://github.com/timberio/timber-js/tree/master/bunyan#readme
- Issues: https://github.com/timberio/timber-js/issues
- npm.io page: https://npm.io/package/@timberio/bunyan

## Dependencies (1)

- [@timberio/types](https://npm.io/package/@timberio/types.md) ^0.35.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.35.0 (latest) — 2019-08-19
- 0.34.2 — 2019-08-19
- 0.34.1 — 2019-06-27
- 0.33.0 — 2019-03-09
- 0.32.0 — 2019-03-09
- 0.31.0 — 2019-03-09
- 0.30.0 — 2019-01-22
- 0.29.0 — 2019-01-22
- 0.28.0 — 2019-01-16

## README

# 🌲 Timber - Bunyan writable stream

![Beta: Ready for testing](https://img.shields.io/badge/early_release-beta-green.svg)
![Speed: Blazing](https://img.shields.io/badge/speed-blazing%20%F0%9F%94%A5-brightgreen.svg)
[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)

**New to Timber?** [Here's a low-down on logging in Javascript.](https://github.com/timberio/timber-js)

## `@timberio/bunyan`

This NPM library provides a [Bunyan](https://github.com/trentm/node-bunyan) writable stream that transmits logs to Timber.io via the `@timberio/node` logger.

Here's how to get started:

## Installation

Install the Node.js Timber logger and the Bunyan stream plugin via NPM:

```
npm i @timberio/node @timberio/bunyan
```

## Importing

In ES6/Typescript, import both the `Timber` logger class and the Timber Bunyan stream class:

```typescript
import { Timber } from "@timberio/node";
import { TimberStream } from "@timberio/bunyan";
```

For CommonJS, require the packages instead:

```js
const { Timber } = require("@timberio/node");
const { TimberStream } = require("@timberio/bunyan");
```

## Creating a client/stram

You can [create a client](https://github.com/timberio/timber-js/tree/master/packages/node#creating-a-client) the usual way for `@timberio/node`, and then pass it into a new instance of `TimberStream`:

```typescript
// Assuming you've imported the Timber packages above, also import Bunyan...
import bunyan from "bunyan";

// Create a Timber client
const timber = new Timber("timber-organization-key", "timber-source-key");

// Create a Bunyan logger - passing in the Timber stream
const logger = bunyan.createLogger({
  name: "Example logger",
  level: "debug",
  streams: [
    {
      stream: new TimberStream(timber)
    }
  ]
});

// Log as normal in Bunyan - your logs will sync with Timber.io!
logger.info("Hello from Bunyan");
```

## Log levels

Timber will log at the `debug` level and above. Trace logs or any log level below `20` will be ignored.

The `fatal` log level is transformed to `error` in the Timber logger.

## LICENSE

[ISC](LICENSE.md)

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