Wingfoil

https://github.com/wingfoil-io/wingfoil
Admin
Wingfoil is a blazingly fast, highly scalable stream processing framework designed for...
Tokens:771,117
Snippets:4,448
Trust Score:5.4
License:Apache-2.0
Update:5 days ago
Show doc for...
Tokens:
Raw
### Setup: Start Fluvio cluster and create topics

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/fluvio/README.md

Commands to start a local Fluvio cluster and create the required topics 'fluvio-example-source' and 'fluvio-example-dest'. Requires the Fluvio CLI.

```sh
# Start cluster (requires the Fluvio CLI)
fluvio cluster start --local

# Create topics
fluvio topic create fluvio-example-source
fluvio topic create fluvio-example-dest
```

--------------------------------

### Run the ws_adapter example with cargo

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/ws/README.md

Run the example with the ws feature enabled. No service to start; the example runs its own in-process WebSocket server.

```sh
cargo run -p wingfoil --example ws_adapter --features ws
```

--------------------------------

### Run setup scripts

Source: https://github.com/wingfoil-io/wingfoil/blob/main/CONTRIBUTING.md

Use these scripts to install protoc and optional native dependencies for Aeron/ZeroMQ.

```bash
scripts/setup-dev.sh                 # protoc only
scripts/setup-dev.sh --all-features  # also Aeron/ZeroMQ native dependencies
```

--------------------------------

### Set up and run the browser client

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/web/README.md

Installs dependencies and starts the wingfoil-js client, which opens http://localhost:5173 against ws://127.0.0.1:8080/ws.

```sh
cd js
pnpm install
pnpm dev    # opens http://localhost:5173 against ws://127.0.0.1:8080/ws
```

--------------------------------

### Example server output

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/web/README.md

Shows the expected output when the server starts and receives a UI event.

```text
wingfoil web example listening on ws://127.0.0.1:8080/ws  (codec: Bincode, mode: realtime)
0.000_123 ui-event: UiEvent { kind: "click", note: "hello" }
...
```

--------------------------------

### Run the aeron_adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/aeron/README.md

Builds and runs the wingfoil example with the aeron feature. Requires the media driver to be running and system dependencies installed.

```sh
cargo run -p wingfoil --example aeron_adapter --features aeron
```

--------------------------------

### Start PostgreSQL container

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/postgres/README.md

Command to launch a PostgreSQL 16 instance for the example.

```sh
docker run --rm -p 5432:5432 -e POSTGRES_PASSWORD=postgres postgres:16-alpine
```

--------------------------------

### Run Rust example with web feature

Source: https://github.com/wingfoil-io/wingfoil/blob/main/js/README.md

Starts the Rust example server with the web feature enabled. After running this, open http://localhost:5173 to access the Solid dashboard, which connects to ws://127.0.0.1:8080/ws by default.

```sh
cargo run --example web --features web
```

--------------------------------

### Run the example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/fluvio/README.md

Command to run the example with the fluvio feature enabled.

```sh
cargo run -p wingfoil --example fluvio_adapter --features fluvio
```

--------------------------------

### Start KDB+ server on port 5000

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/kdb/read_cached/README.md

Starts a KDB+ process listening on port 5000. This is the first step in the setup to create the prices table.

```sh
q -p 5000
```

--------------------------------

### Run the ZeroMQ adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/zmq/README.md

Run the example with cargo, enabling the zmq feature.

```sh
cargo run -p wingfoil --example zmq_adapter --features zmq
```

--------------------------------

### Run OTLP adapter with collector

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/telemetry/README.md

Start an OTLP collector and run the otlp_adapter example with the necessary features enabled.

```sh
docker run --rm -p 4318:4318 otel/opentelemetry-collector:0.149.0
OTLP_ENDPOINT=http://localhost:4318 \
    cargo run -p wingfoil --example otlp_adapter --features otlp,prometheus
```

--------------------------------

### Run the postgres_adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/postgres/README.md

Command to execute the wingfoil postgres_adapter example with the required features.

```sh
cargo run -p wingfoil --example postgres_adapter --features postgres
```

--------------------------------

### One-time setup for Pulumi stack

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/showcase/trading_e2e/pulumi/baremetal/README.md

Initializes the Python virtual environment, installs dependencies, and configures the Pulumi stack with required LMAX credentials.

```bash
cd crates/wingfoil/examples/showcase/trading_e2e/pulumi/baremetal
python3 -m venv venv && source venv/bin/activate
pip install -r requirements.txt
pulumi stack init demo
pulumi config set --secret lmax_username <YOUR_LMAX_USERNAME>
pulumi config set --secret lmax_password <YOUR_LMAX_PASSWORD>
```

--------------------------------

### Run etcd adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/etcd/README.md

Execute the etcd adapter example using cargo.

```sh
cargo run -p wingfoil --example etcd_adapter --features etcd
```

--------------------------------

### Run the spawn example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/core/spawn/README.md

Command to execute the spawn example using cargo.

```sh
cargo run -p wingfoil --example spawn
```

--------------------------------

### Run the kdb_read example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/kdb/read/README.md

Runs the example with `RUST_LOG=info` and the `kdb` feature enabled.

```sh
RUST_LOG=info cargo run -p wingfoil --example kdb_read --features kdb
```

--------------------------------

### Run the web adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/web/README.md

Runs the example server with default settings, binding to 127.0.0.1:8080.

```sh
cargo run -p wingfoil --example web_adapter --features web
```

--------------------------------

### Start trading_e2e observability stack with Docker Compose

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/showcase/README.md

Starts the full observability stack (Prometheus, Grafana, Tempo, etc.) for the trading_e2e example. Requires Docker Compose.

```sh
docker compose -f crates/wingfoil/examples/showcase/trading_e2e/docker-compose.yml up -d
```

--------------------------------

### Run the parquet_adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/parquet/README.md

Runs the example with the parquet feature enabled. No prerequisites; the output tree is written under the OS temp directory.

```sh
cargo run -p wingfoil --example parquet_adapter --features parquet
```

--------------------------------

### Scrape metrics via curl

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/prometheus/README.md

Verify the metrics endpoint is serving data after starting the example.

```sh
curl http://localhost:9091/metrics
```

--------------------------------

### Deployment workflow for spin-up

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/showcase/trading_e2e/pulumi/baremetal/README.md

Builds the required release binaries, provisions infrastructure via Pulumi, and retrieves the server URL after bootstrapping.

```bash
# 1. Build release binaries (Pulumi reads them from target/release/examples)
cargo build --release -p wingfoil --example trading_e2e_ws_server \
    --features "web-tls,iceoryx2,prometheus,otlp"
cargo build --release -p wingfoil --example trading_e2e_fix_gw \
    --features "fix,iceoryx2,execution"

# 2. Bring the stack up — uploads binaries to S3, provisions infra
pulumi up

# 3. Wait ~5–8 min for the box to bootstrap
#    (cold boot + grub rewrite + reboot + service start + LMAX FIX logon)
pulumi stack output ws_server_url
# → https://<eip>:8080  (self-signed cert; click through the browser warning)

# 4. Open the URL, click start, watch real per-hop numbers
```

--------------------------------

### Run the Prometheus adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/prometheus/README.md

Execute the example using cargo with the required prometheus feature enabled.

```sh
cargo run -p wingfoil --example prometheus_adapter --features prometheus
```

--------------------------------

### Start Docker Compose stack for Prometheus integration tests

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/src/adapters/prometheus/CLAUDE.md

Starts the telemetry example's compose stack, which includes Prometheus scraping port 9091 on the host. The Grafana service comes up unused because the integration test reads Prometheus only.

```sh
docker compose -f crates/wingfoil/examples/adapters/telemetry/docker/docker-compose.yml up -d
```

--------------------------------

### Start local Docker Compose demo

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/showcase/trading_e2e/DOCKER_BUILD.md

Starts the original demo locally for reference. Run from the trading_e2e directory.

```bash
cd crates/wingfoil/examples/showcase/trading_e2e

# Start the original demo (for reference)
docker-compose up
```

--------------------------------

### Stamping::Precise

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/showcase/latency/README.md

Reads Ctx::wall_time_precise() for a fresh TSC read (~5-10 ns). Gives intra-cycle resolution so in-process stages get distinct timestamps. This example uses it.

```APIDOC
## Stamping::Precise

### Description
Reads Ctx::wall_time_precise() for a fresh TSC read (~5-10 ns). Gives intra-cycle resolution so in-process stages get distinct timestamps. This example uses it.

### Mode
Precise

### Usage
Use .stamp_as::<X>(Stamping::Precise) or .stamp_precise::<X>() shorthand.

### Notes
- Fresh TSC read (~5-10 ns).
- Provides intra-cycle resolution.
- Suitable for in-process stages.
```

--------------------------------

### Run lines adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/src/adapters/lines/CLAUDE.md

Command to run the example for the lines adapter with the async feature.

```bash
cargo run -p wingfoil --features async --example lines_adapter
```

--------------------------------

### Wingfoil server setup with JSON codec (Rust)

Source: https://github.com/wingfoil-io/wingfoil/blob/main/js/README.md

Starts the Wingfoil WebSocket server bound to 127.0.0.1:8080 with the JSON codec. This matches the client's default codec and is required for data payloads.

```rust
WebServer::bind("127.0.0.1:8080")
    .codec(CodecKind::Json)
    .start()?;
```

--------------------------------

### Run FIX adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/fix/README.md

Command to execute the FIX loopback example. RUST_LOG=info is required to see output from the logged taps.

```sh
RUST_LOG=info cargo run -p wingfoil --example fix_adapter --features fix
```

--------------------------------

### Install and build commands for Wingfoil JS package

Source: https://github.com/wingfoil-io/wingfoil/blob/main/js/README.md

Run these commands from the js/ directory to set up and build the package. pnpm install installs dependencies, pnpm run build:wasm compiles the Rust WASM module, pnpm build runs the full build, pnpm dev starts the Vite dev server, pnpm run lint runs TypeScript type checking, and pnpm test runs the vitest suite (requires build:wasm first).

```sh
pnpm install
pnpm run build:wasm   # wasm-pack → ./src/wasm
pnpm build            # build:wasm + tsc + copy ./src/wasm to ./dist/wasm
pnpm dev              # Vite dev server for examples/solid-dashboard
pnpm run lint         # tsc --noEmit
pnpm test             # vitest suite (tests/) — needs build:wasm first
```

--------------------------------

### Run hello_graph example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/README.md

Executes the hello_graph example to demonstrate wiring, building, and running in historical and realtime modes.

```sh
cargo run -p wingfoil --example hello_graph
```

--------------------------------

### Setup Script for All-Features System Dependencies

Source: https://github.com/wingfoil-io/wingfoil/blob/main/CLAUDE.md

Installs native Aeron and ZeroMQ build dependencies. Checks that CMake is at least 3.30. Missing libbsd surfaces at link time as 'rust-lld: error: unable to find library -lbsd'.

```bash
scripts/setup-dev.sh --all-features
```

--------------------------------

### Run the Kafka adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/kafka/README.md

Runs the Kafka adapter example with the kafka feature enabled. Requires a running Kafka-compatible broker.

```sh
cargo run -p wingfoil --example kafka_adapter --features kafka
```

--------------------------------

### Install wingfoil via pip

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil-python/README.md

Install the wingfoil package from PyPI. This is the standard installation method for users.

```bash
pip install wingfoil
```

--------------------------------

### Run the dynamic_manual example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/core/dynamism/dynamic_manual/README.md

Command to execute the dynamic_manual example with the required dynamic-graph feature enabled.

```bash
cargo run -p wingfoil --example dynamic_manual --features dynamic-graph
```

--------------------------------

### Run the introspect example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/core/introspect/README.md

Runs the example binary with cargo. The example prints a text snapshot of the graph to stdout.

```sh
cargo run -p wingfoil --example introspect
```

--------------------------------

### Run Wingfoil examples via Cargo

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/README.md

Standard commands to execute core examples or examples requiring specific feature flags.

```sh
cargo run -p wingfoil --example <name>                      # core examples
cargo run -p wingfoil --example <name> --features <feature> # anything gated
```

--------------------------------

### Run the threading example with cargo

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/core/threading/README.md

Use this command to run the threading example. It executes the example binary named 'threading' from the wingfoil package.

```sh
cargo run -p wingfoil --example threading
```

--------------------------------

### Run the statistics example with cargo

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/core/statistics/README.md

Run the example with the statistics feature enabled. The command uses cargo run with the wingfoil package and the example named statistics.

```sh
cargo run -p wingfoil \
    --features statistics --example statistics
```

--------------------------------

### Run the lines adapter example

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/adapters/lines/README.md

Execute the lines adapter example using cargo with the required async feature enabled.

```sh
cargo run -p wingfoil --example lines_adapter --features async
```

--------------------------------

### Install TypeScript client

Source: https://github.com/wingfoil-io/wingfoil/blob/main/docs/release-notes/9.0.0.md

Install the @wingfoil/client package for TypeScript.

```sh
npm install @wingfoil/client@9
```

--------------------------------

### Run the four examples with cargo run

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/core/dynamism/README.md

Commands to run each example. Only the graph-mutating examples (dynamic, dynamic_manual) need the dynamic-graph feature; demux and demux_map are always available.

```bash
cargo run -p wingfoil --example dynamic        --features dynamic-graph
cargo run -p wingfoil --example dynamic_manual --features dynamic-graph
cargo run -p wingfoil --example demux
cargo run -p wingfoil --example demux_map
```

--------------------------------

### Run latency example (subscriber first, then publisher)

Source: https://github.com/wingfoil-io/wingfoil/blob/main/crates/wingfoil/examples/showcase/README.md

Run the subscriber first to create the shared-memory service, then the publisher. Both commands use `--release` for meaningful latency numbers.

```sh
cargo run -p wingfoil --release --example latency_sub --features iceoryx2
cargo run -p wingfoil --release --example latency_pub --features iceoryx2
```
Tokens:
Raw