powerful-pipes-notifier 1.0.5

Powerful pipes Notifier tool

---

Powerful Pipes Notifier - Multi-Channel notification tool with the power of UNIX Pipes

---

In a nutshell Powerful Pipes Notifier is a notification tool to forward STDIN data to different destinations.

Install

> pip install powerful-pipes-notifier 

Quick Start

Powerful pipes notifier send to a destination the stdin data, line by line.

Examples:

HTTP Web Hook

> notifier -d http://localhost/webhook

Web Socket Hook

> notifier ws://localhost/websocket-hook

Allowed destinations

Currently, these are the implemented schemas:

• http://URI -> webhook
• ws://URI -> websocket
• mongodb://user:password@host:port/?db=DATABASE&collection=COLLECTION

MongoDB examples

> docker-compose -f docker-compose.mongo.yaml up -d
> cat examples/localhost_meta.txt | notifier -d "mongodb://root:example@127.0.0.1:27900/?db=notifier&collection=logs" 

NOTE: Pay attention of symbol "?" in the URI after the port slash.

Rules engine

You can set a rule that tell to notifier if notify or not.

Rules are based in JSONPath standard and will try to match it in the input JSON data.

Usage example:

> notifier -d http://localhost/webhook -R "_meta.dataSource.sourceName == 'har asdf'"
> notifier -d http://localhost/webhook -R "_meta.summary.current == _meta.summary.total"

Documentation

You can find the complete documentation at: Documentation.

Authors

Powerful Pipes Notifier was made by 42Crunch Research Team:

• jc42
• cr0hn

License

Powerful Pipes Notifier is Open Source and available under the AGPLv3+.

Contributions

Contributions are very welcome. See CONTRIBUTING.md or skim existing tickets to see where you could help out.

Acknowledgements

Project logo thanks to Pipe icons created by starline - Flaticon .