# good-console-filtered

> Console broadcasting for Good process monitor that is filtered

Latest version **5.2.1** (published 2016-06-02) · ISC license · 0 weekly downloads

## Install

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

## 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 | 5.2.1 |
| Published | 2016-06-02 |
| First published | 2016-06-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.x |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | vannilaknight |

## Links

- npm: https://www.npmjs.com/package/good-console-filtered
- npm.io page: https://npm.io/package/good-console-filtered

## Dependencies (5)

- [hoek](https://npm.io/package/hoek.md) 2.x.x
- [moment](https://npm.io/package/moment.md) 2.8.x
- [through2](https://npm.io/package/through2.md) 0.6.x
- [good-squeeze](https://npm.io/package/good-squeeze.md) 2.x.x
- [json-stringify-safe](https://npm.io/package/json-stringify-safe.md) 5.0.x

## Recent versions

- 5.2.1 (latest) — 2016-06-02
- 5.2.0 — 2016-06-02

## README

# good-console

Console broadcasting for Good process monitor that ignores any route ending with `/health`

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

Lead Maintainer: [Adam Bretz](https://github.com/arb)

## Usage

`good-console` is a [good](https://github.com/hapijs/good) reporter implementation to write [hapi](http://hapijs.com/) server events to the console.

## `GoodConsole(events, [config])`
Creates a new GoodConsole 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
	- `format` - [MomentJS](http://momentjs.com/docs/#/displaying/format/) format string. Defaults to 'YYMMDD/HHmmss.SSS'.
	- `utc` - boolean controlling Moment using [utc mode](http://momentjs.com/docs/#/parsing/utc/) or not. Defaults to `true`.

## Good Console Methods
### `goodconsole.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.

## Output Formats

Below are example outputs for the designated event type:

- "ops" - 141225/093015.900, [ops, `event.tags`], memory: 10Mb, uptime (seconds): 1000, load: [ 1.650390625, 1.6162109375, 1.65234375 ]
- "error" - 141225/093015.900, [error, `event.tags`], message: there was an error, stack: `eventData.stack`
- "request" - 141225/093015.900, [request, `event.tags`], data: {"message":"you made a request to a resource"}
- "log" - 141225/093015.900, [log, `event.tags`], data: you logged a message
- "response" - 141223/164207.694, [response], localhost: post /data {"name":"adam"} 200 (150ms) response payload: {"foo":"bar","value":1}
- "wreck" - 141223/164207.694, [wreck], get: http://hapijs.com/test 200 OK (29ms)
- "wreck" (with error) - 151105/084704.603, [wreck], get: http://hapijs.com/test (7ms) error: some error stack: some stack trace

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