# good-console-logfmt

> Console broadcasting for Good process monitor, using the logfmt format

Latest version **1.1.0** (published 2018-06-06) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install good-console-logfmt
pnpm add good-console-logfmt
yarn add good-console-logfmt
bun add good-console-logfmt
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2018-06-06 |
| First published | 2015-11-24 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.11 |
| Dependencies | 7 |
| Unpacked size | 38.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | cadecairos |

## Links

- npm: https://www.npmjs.com/package/good-console-logfmt
- Repository: https://github.com/cadecairos/good-console-logfmt
- Homepage: https://github.com/cadecairos/good-console-logfmt#readme
- Issues: https://github.com/cadecairos/good-console-logfmt/issues
- npm.io page: https://npm.io/package/good-console-logfmt

## Dependencies (7)

- [good](https://npm.io/package/good.md) ^8.1.1
- [hoek](https://npm.io/package/hoek.md) ^5.0.3
- [logfmt](https://npm.io/package/logfmt.md) ^1.2.1
- [moment](https://npm.io/package/moment.md) ^2.22.2
- [through2](https://npm.io/package/through2.md) ^2.0.3
- [good-squeeze](https://npm.io/package/good-squeeze.md) ^5.1.0
- [json-stringify-safe](https://npm.io/package/json-stringify-safe.md) ^5.0.1

## Recent versions

- 1.1.0 (latest) — 2018-06-06
- 1.0.3 — 2018-06-05
- 1.0.2 — 2015-11-24
- 1.0.1 — 2015-11-24
- 1.0.0 — 2015-11-24

## README

# good-console-logfmt

Console broadcasting for Good process monitor, using logfmt formatting

[![Build Status](https://travis-ci.org/cadecairos/good-console-logfmt.svg?branch=master)](http://travis-ci.org/cadecairos/good-console-logfmt)![Current Version](https://img.shields.io/npm/v/good-console-logfmt.svg)

Lead Maintainer: [Christopher De Cairos](https://github.com/cadecairos)

## Usage

`good-console-logfmt` is a [good](https://github.com/hapijs/good) reporter implementation to write [hapi](http://hapijs.com/) server events to the console. It uses the [logfmt package](https://www.npmjs.com/package/logfmt) to format log output.

## `GoodConsoleLogfmt(events, [config])`
Creates a new GoodConsoleLogfmt object with the following arguments:

- `events` - an object of key value pairs.
	- `key` - one of the supported [good events](https://github.com/hapijs/good) indicating the hapi event to subscribe to
	- `value` - a single string or an array of strings to filter incoming events. "\*" indicates no filtering. `null` and `undefined` are assumed to be "\*"
- `[config]` - optional configuration object with the following available keys
	- `utc` - boolean controlling Moment using [utc mode](http://momentjs.com/docs/#/parsing/utc/) or not. Defaults to `true`.

## Good Console Logfmt Methods
### `goodconsolelogfmt.init(stream, emitter, callback)`
Initializes the reporter with the following arguments:

- `stream` - a Node readable stream that will be the source of data for this reporter. It is assumed that `stream` is in `objectMode`.
- `emitter` - an event emitter object.
- `callback` - a callback to execute when the start function has complete all the necessary set up steps and is ready to receive data.

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