# winston-highstorm

> A Winston Transport to Stream Data to Highstorm

Latest version **0.0.4** (published 2023-05-23) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2023-05-23 |
| First published | 2023-05-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Khushal Bhardwaj |
| Maintainers | celeron |
| Keywords | winston, winston-transport, highstorm |

## Links

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

## Dependencies (3)

- [winston](https://npm.io/package/winston.md) ^3.8.2
- [@highstorm/client](https://npm.io/package/@highstorm/client.md) ^0.0.2
- [winston-transport](https://npm.io/package/winston-transport.md) ^4.5.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
- [@luma.gl/experimental](https://npm.io/package/@luma.gl/experimental.md) — 77.1K 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

## Recent versions

- 0.0.4 (latest) — 2023-05-23
- 0.0.3 — 2023-05-23
- 0.0.2 — 2023-05-22
- 0.0.1 — 2023-05-22

## README

# winston-highstorm

It's a package to upload [winston](https://www.npmjs.com/package/winston)'s log steam to [Highstorm](https://highstorm.app).

## Usage

This is how you can use this package:

```js
// highstorm-transport.js
const { HighstormTransport } =  require("@celeroncoder/highstorm-winston");

const { HIGHSTORM_KEY } = process.env;

const highstorm = new HighstormTransport({
  token: HIGHSTORM_KEY!, // required
  channelName: "<chanel_name>", // required
});

export default highstorm;
```

```js
// logger.js
const winston = require('winston');
const highstorm = require("./highstorm-transport.js")

const logger = winston.createLogger({
  ...
  transports: [
	highstorm
  ],
  ...
});

```

- Add `HIGHSTORM_KEY` environment variable from the Highstorm dashboard.
- Make sure to use the recommended highstorm channel name format.

- You can also add default transport option when initializing the `HighstormTransport`.

## License

This package is under MIT License

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