Tenzir Example Plugin

We think that learning how to build a plugin is best done by example. This example plugin implements a simple operator read_custom_log that parses a custom line-based log format.

The operators C++ implementation can be found in builtins/operators/read_custom_log.cpp and is extensively commented.

Build and run

Simply run docker compose up --build to build and start a Tenzir node with your additional plugin.

Use docker compose run --build tenzir '<pipeline>' to interact with the node on the command-line, or set the following environment variables connect your node to app.tenzir.com:

export TENZIR_PLUGINS__PLATFORM__API_KEY='<api-key>'
export TENZIR_PLUGINS__PLATFORM__TENANT_ID='<tenant-id>'

Run tests

Every plugin defines additional tests using BATS. Use docker compose run --build tests to execute your tests and update the reference files automatically.

Further Resources

Tenzir ships with a variety of plugins and builtins to get inspired by and to learn from.

If you have any questions, feel free to reach out in the #developers channel on Discord.

Contribute your plugin

If you want to upstream your plugin so that it is bundled with every Tenzir installation, open a PR that adds it to the plugins/ directory in the tenzir/tenzir repository. If your plugin has no dependencies, consider contributing it as a builtin instead. Builtins are located in the libtenzir/builtins/ directory in the tenzir/tenzir repository.