# cloudwatch-log-stream

> A readable stream of CloudWatch logs.

Latest version **0.1.0** (published 2017-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install cloudwatch-log-stream
pnpm add cloudwatch-log-stream
yarn add cloudwatch-log-stream
bun add cloudwatch-log-stream
```

Provides the command `cwlogs`.

## 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.1.0 |
| Published | 2017-05-29 |
| First published | 2017-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | segment-admin |
| Keywords | cloudwatch, aws, stream |

## Links

- npm: https://www.npmjs.com/package/cloudwatch-log-stream
- npm.io page: https://npm.io/package/cloudwatch-log-stream

## Dependencies (4)

- [debug](https://npm.io/package/debug.md) ^2.6.1
- [from2](https://npm.io/package/from2.md) ^2.3.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.22.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2017-05-29
- 0.0.0 — 2017-03-07

## README

# cloudwatch-log-stream

A readable stream of CloudWatch logs.

## API

### `logstream = getCloudWatchLogStream(options)`

Create a readable log stream with the given `options`:

- `group` (required) the log group name
- `region` (required) the AWS region
- `filter` optional filter for logs

### `logstream.destroy()`

Destroy the stream.

## Examples

Two contrived examples are in the `examples` directory.

### basic

Basic usage of the stream, piped to stdout.

### web

A primitive example using `WebSocket`s to show the basics of streaming logs to the browser.

## License

MIT

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