NATS Execution Engine

Leverage and extend your investment in NATS infrastructure to deploy functions and services, turning NATS into the ultimate platform for building distributed applications.

Quickstart

The easiest way to get started with Nex is to check out our Using Nex section in the NATS documentation.

If you're already familiar with Nex and how it works, then you can get going quickly by installing the Nex CLI:

curl -sSf https://nex.synadia.com/install.sh | sh 

Preflight Check

If you haven't already, please make sure that /usr/local/bin is in your path.

The nex node preflight command is here to help you bootstrap your system and ensure that you have all of the elements you need to start and operate Nex nodes.

The pre-flight check requires a configuration file so it can perform the appropriate checks. If you don't already have a configuration file, then Nex's preflight command will generate a new one for you in ./config.json, as shown below:

{
    "default_resource_dir":"/tmp/wd",
    "machine_pool_size": 1,
    "cni": {
        "network_name": "fcnet",
        "interface_name": "veth0"
    },
    "machine_template": {
        "vcpu_count": 1,
        "memsize_mib": 256
    },
    "tags": {
        "simple": "true"
    },
    "no_sandbox": false,
    "otlp_exporter_url": null
}

Run the following command to get everything set up using the above defaults:

$ nex node preflight

Nex Components

Nex is made up of the following components

• agent - Agent that runs inside a Firecracker VM, responsible for running untrusted workloads. Not something end users need to interact with.
• node - Service running on a NEX node. Exposes a control API, starts/stops firecracker processes, communicates with the agent inside each process.
• nex - CLI for communicating with NEX nodes
• tui - Interactive user interface for viewing the status of NEX nodes in a terminal. BETA feature, not yet fully functional.

Telemetry Data

Nex comes prewired with OpenTelemetry support for traces and metrics.

In order to enable OTel support, you will first need to provide the Nex node with access to an OTel exporter. We have provided a docker-compose solution for local development. In order to start the OTel evironment, you will need navigate to the _scripts/otel directory and run docker compose up. The following ports will be exposed:

Web UI (grafana)      -> 127.0.0.1:14524
Tempo (http)          -> 127.0.0.1:14530
Tempo OTLP (http)     -> 127.0.0.1:14531
OTel Collector (grpc) -> 127.0.0.1:14532
OTel Collector (http) -> 127.0.0.1:14533
Prometheus            -> 127.0.0.1:14534

In order to view the metrics and traces, you will need to navigate to http://localhost:14524 in your browser.

Traces

nex node up \
  --traces \                      # enables traces
  --otel_traces_exporter grpc     # controls where how traces are exported to collector

Valid exporters are grpc, http, and file. The file exporter will write traces to a file in the current working directory called traces.log.

Metrics

To enable metrics, include the flags when starting the node

nex node up \
  --metrics \                      # enables metrics
  --otel_metrics_exporter file \   # controls whether the metrics are printed to metrics.log or provided via prometheus
  --metrics_port 8085              # exposes prometheus data on provided port

Valid exporters are http and prometheus. The file exporter will write metrics to a file in the current working directory called metrics.log.

Using NATS Context with nex

In order to use your NATS context with Nex, you will need to set the XDG_CONFIG_HOME environment variable. On linux, this is typically $HOME/.config, but specifically, it will be wherever your nats/ configuration directory is located. This will allow nex to use the same configuration as your NATS context.

// Example usage
XDG_CONFIG_HOME=/home/jordan/.config sudo -E nex node up --loglevel debug --context default

Contributing

For information on how to contribute to Nex, please read our contributing guide.