factorio-obs

Send Factorio circuit-network readings to Splunk as JSON events via a Splunk file monitor.

 Factorio (Lua mod)                script-output/                shipping
 ─────────────────────            ────────────────              ─────────────────────────
 Display Panel (named)            circuit-logger/               Splunk monitor://
   ├ red / green wires    ──►     factorio-1.ndjson        ──►     tails the files → events index
   └ signals read each 1s         factorio-2.ndjson
                                   (one JSON event / panel,
                                    new file per session)

The one thing to understand

Factorio mods cannot do network I/O — the Lua sandbox has no sockets, no HTTP, no os/io. They also have no wall clock (so no timestamps and no real epoch — a per-session counter names the files instead). The only output a mod has is helpers.write_file. So this project is deliberately two halves:

The mod (src/) reads circuit signals and writes JSON events.
A shipper moves those events to Splunk — a Splunk file monitor, no extra process at all.

Layout

Path	What
`src/`	The Factorio mod (`circuit-logger`). See its README for in-game usage.
`splunk/`	`inputs.conf` / `props.conf` for the file-monitor path.
`docs/plans/`	Design doc.

Quick start

Install the mod: symlink or copy src/ into your Factorio mods/ folder as circuit-logger (the install folder must match the mod name), and enable it.
In-game: build a Display Panel, wire signals into it, and type a name in its text field.
Point Splunk at the output — see splunk/README.md.

Output format

One JSON event per named panel per sample. Signals are a nested tree wire.<color>.<item_type>.<item_name>[.<quality>] = value:

{"surface":"nauvis","exporter":"iron smelting","wire":{"green":{"network_id":17,"item":{"iron-plate":{"normal":4200,"legendary":40}},"fluid":{"water":5000}}}}

Top level: surface, exporter. Each wire.<color> has its own network_id (red and green are distinct networks). Item signals nest by quality; non-item signals (fluids, virtuals) sit directly under their name.

Status

Verified end-to-end against Factorio 2.0.77 + Space Age on a headless server: the mod loads clean, reads a wired+named Display Panel (items with quality nested, a fluid via a storage tank), and both the automatic 1-second scheduler and the manual trigger produce the correct nested JSON event. Per-session file naming was confirmed across a save+reload (factorio-1 → factorio-2). Forward-compatible with 2.1 (handles the messages→records API rename).

Published

Circuit Logger for Splunk on the Factorio Mod Portal.

License

MIT — see LICENSE.

Bre77/factorio-obs