<commit_before># punxsutawney
An tool that allows for replaying load over and over and over (and over) again.

It uses Mesos/Marathon for running its HTTP clients.
It uses Kafka to read traffic data.

Primary components are:
- CLI - CLI to start HttpClients on Mesos (see Main);
- HttpClient - client running on Mesos, that generates HTTP traffic;
- Emitter - emitter (see SampleEmitter), producing traffic to Kafka topic (consumed by HttpClient(s));

# Running
In order to run the tool following steps should be executed:
1. Build via `./gradlew jar`
2. Start `./punxsutawney.sh`
3. Verify app is running via Mesos & Marathon UIs
4. Start emitting traffic to Kafka topic `punxsutawney` (see SampleEmitter)
5. Monitor stdout of each HttpClient to see rps, failures, etc

Note: if running N HttpClient instances, Kafka topic should contain at least N partitions,
in order for HttpClients to be able to consume concurrently.

# Traffic generation
HttpClient consumes Kafka messages, containing serialized Requests instances.
Each Requests instance is designed to carry a batch of HTTP requests.
Emitter should batch 1k - 10k requests together to populate Requests object.<commit_msg>updated README.md to contain more info about using the tool<commit_after># punxsutawney
An tool that allows for replaying load over and over and over (and over) again.

It uses Mesos/Marathon for running its HTTP clients.
It uses Kafka to read traffic data.

Primary components are:
- CLI - CLI to start HttpClients on Mesos (see Main);
- HttpClient - client running on Mesos, that generates HTTP traffic;
- Emitter - emitter (see SampleEmitter), producing traffic to Kafka topic (consumed by HttpClient(s));

# Running
In order to run the tool following steps should be executed:
1. Build via `./gradlew jar`
2. Start `./punxsutawney.sh`
3. Verify app is running via Mesos & Marathon UIs
4. Start emitting traffic to Kafka topic `punxsutawney` (see SampleEmitter)
5. Monitor stdout (via Mesos UI) of each HttpClient to see rps, failures, etc

Note: if running N HttpClient instances, Kafka topic should contain at least N partitions,
in order for HttpClients to be able to consume concurrently.

# Traffic generation
HttpClient consumes Kafka messages, containing serialized Requests instances.
Each Requests instance is designed to carry a batch of HTTP requests.
Emitter should batch 1k - 10k requests together to populate Requests object.
{'fraction_non_alphanumeric': 0.05323978539001238, 'fraction_numerical': 0.006603384234420141, 'mean_word_length': 4.559633027522936, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6828078', 'n_tokens_mistral': 668, 'n_tokens_neox': 639, 'n_words': 355}