jr

README

JR: streaming Quality Random Data from the Command line

JR is a CLI program that helps you to stream quality random data for your applications.

Documentation

For full documentation about emitters, referential integrity, how to write templates and more, pls see the full JR Documentation.

Building and compiling

JR requires Go 1.22

you can use the make_install.sh to install JR. This script does everything needed in one simple command.

./make_install.sh

These are the steps in the make_install.sh script if you want to use them separately:

make all
make copy_templates
sudo make install

If you want to run the Unit tests, you have a make target for that too:

make test

Basic usage

JR is very straightforward to use. Here are some examples:

Listing existing templates

jr template list

Templates are in the directory $JR_SYSTEM_DIR/templates. JR_SYSTEM_DIR defaults to $XDG_CONFIGDIR and can be changed to a different dir, for example:

JR_SYSTEM_DIR=~/jrconfig/ jr template list

Templates with parsing issues are showed in red, Templates with no parsing issues are showed in green

Create random data from one of the provided templates

Use for example the predefined net_device template to generate a random JSON network device

jr template run net_device

or, with a shortcut:

jr run net_device

Using Docker

You can also use a image if you prefer.

docker run -it jrndio/jr:latest jr run net_device

Other options for templates

If you want to use your own template, you can:

• put it in the templates directory
• embed it directly in the command using the --embedded flag

For a quick and dirty test, the best option is to embed directly a template in the command:

jr run --embedded "name:{{name}}"

Create more random data

Using -n option you can create more data in each pass. This example creates 3 net_device objects at once:

jr run net_device -n 3

Continuous streaming data

Using --frequency option you can repeat the creation every f milliseconds

This example creates 2 net_device every second, for ever:

jr run net_device -n 2 -f 1s 

Using --duration option you can time bound the entire object creation.

This example creates 2 net_device every 100ms for 1 minute:

jr run net_device -n 2 -f 100ms -d 1m 

Results are by default written on standard out (--output "stdout") with this output template:

"{{.V}}\n"

which means that only the "Value" is in the output. You can change this behaviour embedding a different template with --outputTemplate

If you want syntax colouring and your output is just json, you can pipe to jq

jr run net_device -n 2 -f 100ms -d 1m | jq

Beware that if you, for example, include the key in the output, it won't be possible to use jq:

jr run net_device -n 2 -f 100ms -d 1m --kcat | jq

parse error: Expected value before ',' at line 1, column 5

Producing to Kafka

Just use the --output kafka (which defaults to console) flag and --topic flag to indicate the topic name:

jr run net_device -n 5 -f 500ms -o kafka -t test

Producing to other stores

You can use JR to stream data to many different stores, not only Kafka. JR supports natively several different producers: you can also easily jr run template | CLI-tool-to-your-store if your preferred store is not natively supported. If you think that your preferred store should be supported, why not implement it? Or just open up an issue and we'll do that for you!

jr producer list

You'll get an output similar to:

List of JR producers:

Console * (--output = stdout)
Kafka (--output = kafka)
Redis (--output = redis)
Mongodb (--output = mongo)
Elastic (--output = elastic)
S3 (--output = s3)
GCS (--output = gcs)
Azure Blob Storage (--output = azblobstorage)
Azure Cosmos DB (--output = azcosmosdb)
Cassandra (--output = cassandra)
HTTP (--output = http)

to use an output, just set the corresponding value in --output

Distributed Testing

JR can be run as a distributed data generation. At the moment the following testing tools are supported:

• k6
• locust

Documentation

Overview

JR is a CLI program that helps you to create quality random data for your applications.

JR is very straightforward to use. To list existing templates: > jr list

Templates are in the directory $JR_SYSTEM_DIR/jr/templates. You can override with the --system_dir command flag. Templates with parsing issues are showed in red, Templates with no parsing issues are showed in green

To use for example one of the predefined templates, net_device:

> jr template run net_device

Using -n option you can create more data in each pass. This example creates 3 net_device objects at once:

> jr template run net_device -n 3

Using --frequency option you can repeat the creation every f milliseconds. This example creates 2 net_device every second, for ever:

> jr template run net_device -n 2 -f 1s

Using --duration option you can time bound the entire object creation. This example creates 2 net_device every 100ms for 1 minute:

> jr template run net_device -n 2 -f 100ms -d 1m