# feedr

**Repository Path**: mirrors_nir0s/feedr

## Basic Information

- **Project Name**: feedr
- **Description**: feedr feeds formatted data using different types of transports
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

feedr
=======

[![Build Status](https://travis-ci.org/nir0s/feedr.svg?branch=master)](https://travis-ci.org/nir0s/feedr)

[![Gitter chat](https://badges.gitter.im/nir0s/feedr.png)](https://gitter.im/nir0s/feedr)

[![PyPI](http://img.shields.io/pypi/dm/feedr.svg)](http://img.shields.io/pypi/dm/feedr.svg)

[![PypI](http://img.shields.io/pypi/v/feedr.svg)](http://img.shields.io/pypi/v/feedr.svg)

[![Documentation Status](https://readthedocs.org/projects/feedr/badge/?version=latest)](https://readthedocs.org/projects/feedr/?badge=latest)

feedr generates events/logs using a specified formatter and sends them using the specified transport.
It can also generate fake data using fake-factory.

### Quick Start
[Quick Start](http://feedr.readthedocs.org/en/latest/quick_start.html)

### Documentation
[feedr Documentation](http://feedr.readthedocs.org)

### Installation
```shell
 pip install feedr
 # or, for dev:
 pip install https://github.com/nir0s/feedr/archive/master.tar.gz
```

### Usage Examples
see [feedr config](http://feedr.readthedocs.org/en/latest/configuration.html) and [advanced config](http://feedr.readthedocs.org/en/latest/advanced_configuration.html)
to configure your transports and formatters.
```shell
 # this will assume config.py in the cwd and assume default for each option
 mouth feed
 # or.. you can specify whatever you want in the cli..
 mouth feed -c /my/config/file/path.py -t AMQP -f Json -g 0.001 -m 100000000
 mouth feed -t UDP -f Custom -g 0.00001 -m 102831028
 # you can also send in batches
 mouth feed -t UDP -f Custom -g 0.01 -m 102831028 -b 1000
 # and even use some common formatters like apache's..
 mouth feed -t Stream -f ApacheError
 # print fake data types that you can use in the config...
 mouth list fake
 # print a list of available transports
 mouth list transports
 # print a list of available formatters
 mouth list formatters
```

### Additional Information
- [Use Case](http://feedr.readthedocs.org/en/latest/case_study.html)
- [Configuration](http://feedr.readthedocs.org/en/latest/configuration.html)
- [formatters](http://feedr.readthedocs.org/en/latest/formatters.html)
- [transports](http://feedr.readthedocs.org/en/latest/transports.html)
- [API](http://feedr.readthedocs.org/en/latest/api.html)
- [InHouseFaker](http://feedr.readthedocs.org/en/latest/in_house_faker.html)

### Vagrant
A vagrantfile is provided: It will load a machine and install feedr on it in a virtualenv so that you can experiment with it.
For a machine containing feedr, ELK and RabbitMQ see the [elk-workshop repo](https://github.com/nir0s/elk-workshop).