Zilla Runtime CLI

The Zilla Runtime command line interface uses the Zilla Runtime Configuration to control and observe the Zilla runtime.

Commands

• zilla dump
  • -a --affinity <affinity>
  • -b --bindings <bindings>
  • -i --install <plugin-directory>
  • -v --verbose
  • -w --write <output>
• zilla help
• zilla version
• zilla metrics
  • --namespace <namespace>
• zilla start
  • -c --config
  • -e --exception-traces
  • -p --properties
  • -P --property
  • -v --verbose
  • -w --workers
• zilla stop
• zilla tune

Commands

zilla dump

Feature is in Incubator

Read how to enable incubator features. Star and watch the Zilla repo for new releases!

The zilla dump command creates a pcap file that can be opened in Wireshark. Using the Zilla dissector plugin, Wireshark shows detailed information about the internal state of the current Zilla instance.

-a --affinity <affinity>

Only dump the frames that match the specified affinity mask.

-b --bindings <bindings>

Only dump the frames for the specified bindings.

-i --install <plugin-directory>

Install the dissector plugin zilla.lua to the plugin directory of Wireshark. This is only necessary if you run the dump command for the first time or if you want to update the plugin to the current version.

To find the Wireshark plugin directory navigate the menu: About Wireshark -> Folders -> Personal Lua Plugins; or use this command:

tshark -G folders | grep "Personal Lua Plugins"

To find out the plugin version navigate the menu: About Wireshark -> Plugins -> search: zilla; or use this command:

tshark -G plugins | grep zilla

You may need to reload Lua plugins from the menu: Analyze -> Reload Lua Plugins or with the keyboard shortcut (Command+Shift+L or Ctrl+Shift+L).

Example:

./zilla dump -v -w zilla.pcap -i ~/.local/lib/wireshark/plugins

-v --verbose

Show verbose output

-w --write <output>

Write the pcap output to this file.

Example:

./zilla dump -v -w zilla.pcap

zilla help

The zilla help command shows help information about available commands, or more information for a specific command.

zilla help [command]

Examples:

./zilla help start

zilla version

The zilla version command prints the version information of Zilla.

zilla version

zilla version 0.9.85

zilla metrics

The zilla metrics command provides metrics for each binding in the configuration.

zilla metrics

Optionally specify a binding name to output metrics for that binding only.

zilla metrics [binding-name]

--namespace <namespace>

Filters bindings by namespace

Examples:

./zilla metrics echo_server

namespace    binding         metric                    value
example      echo_server    stream.opens.received        24
example      echo_server    stream.opens.sent            24
example      echo_server    stream.closes.received       24
example      echo_server    stream.closes.sent           24
example      echo_server    stream.data.received         13
example      echo_server    stream.data.sent             13
example      echo_server    stream.errors.received        0
example      echo_server    stream.errors.sent            0

zilla start

The zilla start command resolves the Zilla Runtime Configuration in a zilla.yaml to start the runtime engine.

zilla start -ve

name: example
bindings:
  tcp:
    type: tcp
    kind: server
    options:
      host: 0.0.0.0
      port:
      - 12345
      - 12346
    exit: echo
  echo:
    type: echo
    kind: server
started

-c --config

string

Set the path to the local zilla.yaml configuration file or remote URI.

zilla start -c ./path/to/zilla.yaml

zilla start -c http://example.com/zilla.yaml

-e --exception-traces

flag

Log exception traces to stdout.

zilla start -e

-p --properties

string

Set Zilla properties via a file.

zilla start -p /path/to/zilla.properties

-P --property

name=value

Set individual Zilla properties.

zilla start -P zilla.engine.prop=value -P zilla.other.thing=value

-v --verbose

flag

Log verbose output to stdout.

zilla start -v

-w --workers

integer | Default: CPU cores

Set the Worker count in Zilla. Defaults to the number of CPU cores available.

zilla start -w 2

zilla stop

The zilla stop command signals the runtime engine to stop.

zilla stop

stopped

zilla tune

Feature is in Incubator

Read how to enable incubator features. Star and watch the Zilla repo for new releases!

The zilla tune command tunes the mapping from runtime engine workers to bindings.

zilla tune [NAME=VALUE]

./zilla tune

xxxx  example.tcp
xxxx  example.echo

./zilla tune example.echo=2

..x.  example.echo

./zilla tune

xxxx  example.tcp
.x..  example.echo