# bunyan-syslog-udp

> UDP Syslog Stream for Bunyan

Latest version **0.2.0** (published 2019-03-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install bunyan-syslog-udp
pnpm add bunyan-syslog-udp
yarn add bunyan-syslog-udp
bun add bunyan-syslog-udp
```

## 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.2.0 |
| Published | 2019-03-25 |
| First published | 2015-09-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | doorman |

## Links

- npm: https://www.npmjs.com/package/bunyan-syslog-udp
- Repository: https://github.com/wikimedia/node-bunyan-syslog-udp
- Homepage: https://github.com/wikimedia/node-bunyan-syslog-udp#readme
- Issues: https://github.com/wikimedia/node-bunyan-syslog-udp/issues
- npm.io page: https://npm.io/package/bunyan-syslog-udp

## Recent versions

- 0.2.0 (latest) — 2019-03-25
- 0.1.0 — 2015-09-29

## README

# bunyan-syslog-udp [![Build Status](https://travis-ci.org/wikimedia/bunyan-syslog-udp.svg?branch=master)](https://travis-ci.org/wikimedia/bunyan-syslog-udp)
A pure-JS implementation of bunyan syslog stream on top of UDP protocol.

## Installation

```bash
npm install bunyan bunyan-syslog-udp
```

Verify that syslog via UDP is enabled on your system. By default, the syslog daemon listens on port 514.

In order to take advantage of the @CEE cookie functionality either `rsyslog` or `syslog-ng` must be installed.

For rsyslog, make sure the mmjsonparse module is loaded in `/etc/rsyslog.conf`

```bash
module(load="mmjsonparse") # for parsing CEE-enhanced syslog messages
```

## Usage

```javascript
var bunyan = require('bunyan');
var bsyslog = require('bunyan-syslog-udp');

var bstream = bsyslog.createBunyanStream({
      name: 'udptest',      // Optional. Defaults to process.title || process.argv[0]
      host: '127.0.0.1',    // Optional. Defaults to '127.0.0.1'
      port: 514,            // Optional. Defaults to 514
      facility: 'local0',   // Case-insensitive. Optional. Defaults to local0
      prefix: '@cee: '      // Add @cee cookie to message
    });

var log = bunyan.createLogger({
  streams: [{
    type: 'raw',    // Always use 'raw' bunyan stream
    level: 'trace', // Minimum log level
    stream: bstream
  }]
});

// Emit a log message
log.debug("This is a test");

// and close the socket
bstream.close();
```

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