# winston-loggly

> A Loggly transport for winston

Latest version **1.3.1** (published 2016-01-21) · 0 weekly downloads

## Install

```sh
npm install winston-loggly
pnpm add winston-loggly
yarn add winston-loggly
bun add winston-loggly
```

## 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.3.1 |
| Published | 2016-01-21 |
| First published | 2012-05-08 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 86 |
| Author | Charlie Robbins |
| Maintainers | indexzero, chjj, jcrugzz |
| Keywords | logging, sysadmin, tools |

## Links

- npm: https://www.npmjs.com/package/winston-loggly
- Repository: https://github.com/indexzero/winston-loggly
- Homepage: https://github.com/indexzero/winston-loggly#readme
- Issues: https://github.com/indexzero/winston-loggly/issues
- npm.io page: https://npm.io/package/winston-loggly

## Dependencies (1)

- [loggly](https://npm.io/package/loggly.md) ~1.1.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

- 1.3.1 (latest) — 2016-01-21
- 1.3.0 — 2016-01-19
- 1.2.0 — 2015-10-28
- 1.1.0 — 2015-04-11
- 1.0.5 — 2015-03-28
- 1.0.4 — 2015-03-06
- 1.0.3 — 2015-03-06
- 1.0.2 — 2014-09-15
- 1.0.1 — 2013-12-30
- 1.0.0 — 2013-12-02
- 0.6.0 — 2012-05-31
- 0.5.0 — 2012-05-08

## README

# winston-loggly

A [Loggly][0] transport for [winston][1].

## Usage
``` js
  var winston = require('winston');

  //
  // Requiring `winston-loggly` will expose
  // `winston.transports.Loggly`
  //
  require('winston-loggly');

  winston.add(winston.transports.Loggly, options);
```

The Loggly transport is based on [Nodejitsu's][2] [node-loggly][3] implementation of the [Loggly][0] API. If you haven't heard of Loggly before, you should probably read their [value proposition][4]. The Loggly transport takes the following options. Either 'inputToken' or 'inputName' is required:

* __level:__ Level of messages that this transport should log.
* __subdomain:__ The subdomain of your Loggly account. *[required]*
* __auth__: The authentication information for your Loggly account. *[required with inputName]*
* __inputName:__ The name of the input this instance should log to.
* __inputToken:__ The input token of the input this instance should log to.
* __json:__ If true, messages will be sent to Loggly as JSON.
* __tags:__ An array of tags to send to loggly.
* __isBulk:__ If true, sends messages using bulk url
* __stripColors:__ Strip color codes from the logs before sending


*Metadata:* Logged in suggested [Loggly format][5]

## Motivation
`tldr;?`: To break the [winston][1] codebase into small modules that work together.

The [winston][1] codebase has been growing significantly with contributions and other logging transports. This is **awesome**. However, taking a ton of additional dependencies just to do something simple like logging to the Console and a File is overkill.

## Installation

### Installing npm (node package manager)

``` bash
  $ curl http://npmjs.org/install.sh | sh
```

### Installing winston-loggly

``` bash
  $ npm install winston
  $ npm install winston-loggly
```

## Run Tests
All of the winston tests are written in [vows][6], and cover all of the use cases described above. You will need to add valid credentials for the various transports included to test/config.json before running tests:

``` js
  {
    "transports": {
      "loggly": {
        "subdomain": "your-subdomain",
        "inputToken": "really-long-token-you-got-from-loggly",
        "auth": {
          "username": "your-username",
          "password": "your-password"
        }
      }
    }
  }
```

Once you have valid configuration and credentials you can run tests with [npm][7]:

```
  npm test
```

#### Author: [Charlie Robbins](http://blog.nodejitsu.com)
#### License: MIT

[0]: http://loggly.com
[1]: https://github.com/flatiron/winston
[2]: http://nodejitsu.com
[3]: https://github.com/nodejitsu/node-loggly
[4]: http://www.loggly.com/product/
[5]: http://www.loggly.com/docs/automated-parsing/
[6]: http://vowsjs.org
[7]: http://npmjs.org

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