# catch-logs

> Catch-Logs provides broswer-interface to analyse real-time logs.

Latest version **0.0.1** (published 2014-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install catch-logs
pnpm add catch-logs
yarn add catch-logs
bun add catch-logs
```

## 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.0.1 |
| Published | 2014-12-06 |
| First published | 2014-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Known vulnerabilities | 0 (+12 in 5 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Parag Gupta |
| Maintainers | paraggupta1993 |
| Keywords | Logger, broswer-interface, tail, search |

## Links

- npm: https://www.npmjs.com/package/catch-logs
- Repository: https://github.com/paraggupta1993/catch-logs
- Issues: https://github.com/paraggupta1993/catch-logs/issues
- npm.io page: https://npm.io/package/catch-logs

## Dependencies (12)

- [jade](https://npm.io/package/jade.md) ~1.3.0
- [debug](https://npm.io/package/debug.md) ~0.7.4
- [morgan](https://npm.io/package/morgan.md) ~1.0.0
- [stylus](https://npm.io/package/stylus.md) 0.42.3
- [CBuffer](https://npm.io/package/CBuffer.md) 0.1.4
- [express](https://npm.io/package/express.md) ~4.2.0
- [socket.io](https://npm.io/package/socket.io.md) latest
- [underscore](https://npm.io/package/underscore.md) 1.7.0
- [body-parser](https://npm.io/package/body-parser.md) ~1.0.0
- [coffee-script](https://npm.io/package/coffee-script.md) latest
- [cookie-parser](https://npm.io/package/cookie-parser.md) ~1.0.1
- [static-favicon](https://npm.io/package/static-favicon.md) ~1.0.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

- 0.0.1 (latest) — 2014-12-06

## README

## Catch-Logs
### Browser-interface to your real time logs

Clone the Repository:
```
git clone <repo>
```

[Install Node.js](http://nodejs.org/download/) if you dont have it.

Go into the application:
```
cd catch-logs
```

Install the required packages: (Npm comes with Node.js)
```
npm install
```

Configure the log filename which you want to watch (Make changes in `config.json`):
```
{
  "log_filename": "Your filename goes here"
}
```

Start the server:
```
npm start
```


Analyse your logs real-time at:
```
firefox localhost:4000/
```


#### Development :

Better start the server with nodemon, so that server automatically restart if any changes are made to the source files.
```
nodemon modules/server.coffee
```

#### Testing :
Logger : Use this command in different tab for testing
```
sec=0
while true; do echo $sec >> "<log_filename>"; sleep 1; sec=$(($sec + 1)); done
```

###Features:

* Dumps the file into the browser real-time using socket.io.
* Clear logs from the UI using `Clear Log` button or shortcut `g` or `G`.
* Regex Search through the logs.
* AutoScroll to latest log.
* AutoClear logs whenever server restarts. Works great with nodemon.
* Take care of the terminal Ansi-Colors coming as part of the logs. Convert them to CSS colors.

###Todo:

* Make it a npm package.
* Thorough testing: unit and integration.
* User-define filters for coloring: Example = `Exception:` - Red like bootstrap.
* Make lines Collapsable.
* Optimize on search: (show and hide) logic.
* Case insensitive search option.
* Fuzzy Search option.
* Multiple sources of log files.
* Multi-language support.

####Contributors:

[Parag Gupta](https://github.com/paraggupta1993)

#### Special Thanks to :
[Express]()
[Static-favicon]()
[Morgan]()
[Cookie-parser]()
[Body-parser]()
[Debug]()
[Jade]()
[Frontail](https://github.com/mthenw/frontail)
[Stylus]()
[Socket.io]()
[Coffee-script]()
[CBuffer]()

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