README.md

ffwd-java »

This is a Java implementation of ffwd

This project is currently: experimental, use at your own risk.

• Protobuf Protocol
• JSON Protocol
• HTTP Protocol
• Hacking
• On-disk Persistent Queue (WIP)

Building

This project is built using Maven.

$> mvn package

You can run the client using tools/ffwd.

$> tools/ffwd agent/ffwd.yaml

Building a Debian Package

This project does not provide a single Debian package, this is primarily because the current nature of the service (alpha state) does not mesh well with stable releases.

Instead, you are encouraged to build your own using the provided scripts in this project.

First run the prepare-sources script:

$ debian/bin/prepare-sources myrel 1

myrel will be the name of your release, it will be part of your package name ffwd-myrel.

For the next step you'll need a Debian environment:

$ dpkg-buildpackage -uc -us

If you encounter problems, you can troubleshoot the build with DH_VERBOSE:

$ env DH_VERBOSE=1 dpkg-buildpackage -uc -us

Testing

We run unit tests with Maven:

$ mvn test

A more comprehensive test suite is enabled with the environment=test property.

$ mvn -D environment=test verify

This adds:

• Checkstyle
• FindBugs

It is strongly recommended that you run the full test suite before setting up a pull request, otherwise it will be rejected by Travis.

Local Debugging

Assuming you have Maven installed, you can run the following to setup a local debug agent:

$> tools/ffwd agent/ffwd-local-debug.yaml

This will setup a ffwd with a lot of input plugins that are printed to stdout.

Clients

• Java
• Java-HTTP
• Python
• c++

Libraries

• semantic-metrics (ffwd-reporter)

Code of Conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.