Ficsit Remote Monitoring Companion
Ficsit Remote Monitoring Companion (FRMC) is a companion application for the Ficsit Remote Montioring mod for Satisfactory.
The Ficsit Remote Monitoring mod exports metrics about the loaded save in Satisfactory, via a web server serving JSON. This companion application provides a visulisation tool on top of those metrics.
Installation instructions
How do I use it?
Once installed, sign in (button in bottom left), using the username and password ficsit:pioneer.
Ficsit Remote Monitoring Companion comes with some preconfigured dashboards, under the Dashboards > Manage menu.
From the manage dashboards screen, you can create your own dashboards. How to do that is out of scope here, but the Grafana documentation is a good place to start.
FRMC offers two tools for visualising the data being collected:
The realtime map shows your factory buildings on the Satisfactory game world map, and charts their production levels in the last 5 minutes.
The Prometheus mertics server allows you to explore the data being exported using the full power of Prometheus.
(* Link goes to the address on your local system. If FRMC is not running, you will see an error)
What metrics are available
| Name | Description | Labels |
|---|---|---|
| power_capacity_mw | Total capacity of all generators in a circuit | circuit_id |
| power_consumed_mw | Amount of power being consumed in a circuit | circuit_id |
| power_max_consumed_mw | Highest amount of power consumed in a circuit | circuit_id |
| power_produced_mw | Amount of power being produced in a circuit | circuit_id |
| power_battery_differential_pc | Amount of battery capacity as a percentage of total capacity in a circuit | circuit_id |
| power_battery_pc | Amount of battery power available as a percentage of total battery capacity in a circuit | circuit_id |
| power_battery_capacity_mw | Total battery capacity in a circuit | circuit_id |
| power_battery_time_empty_seconds | Amount of time batteries have been empty in a circuit | circuit_id |
| power_fuse_blown | Whether the fuse has been blown in a circuit | circuit_id |
| item_production_capacity_per_min | The factory's capacity for the production of an item, per minute | item_name |
| item_production_capacity_pc | The percentage of an item's production capacity being used | item_name |
| item_consumption_capacity_per_min | The factory's capacity for the consumption of an item, per minute | item_name |
| item_consumption_capacity_pc | The percentage of an item's consumption capacity being used | item_name |
| items_produced_per_min | The number of an item being produced, per minute | item_name |
| items_consumed_per_min | The number of an item being consumed, per minute | item_name |
| Name | Description | Labels |
|---|---|---|
| machine_items_produced_per_min | How much of an item a building is producing | item_name, machine_name, x, y, z |
| machine_items_produced_pc | The efficiency with which a building is producing an item | item_name, machine_name, x, y, z |
| item_production_capacity_per_min | The factory's capacity for the production of an item, per minute | item_name |
| item_production_capacity_pc | The percentage of an item's production capacity being used | item_name |
| item_consumption_capacity_per_min | The factory's capacity for the consumption of an item, per minute | item_name |
| item_consumption_capacity_pc | The percentage of an item's consumption capacity being used | item_name |
| items_produced_per_min | The number of an item being produced, per minute | item_name |
| items_consumed_per_min | The number of an item being consumed, per minute | item_name |
How it works
Ficsit Remote Monitoring Companion runs, configures, and coordinates the following components:
- Prometheus for storing metric data
- Grafana for creating visualisations of the metrics stored in prometheus
- PrometheusExporter for converting the information exposed by Ficsit Remote Monitoring in to the text-based Prometheus exposition format
- Companion for coordinating all of the above, and providing easy access to Grafana
It takes care of all the heavy lifting, so you can get on with building factories.
Ficsit Remote Monitoring Companion reads metric data from the Ficsit Remote Montioring mod, stores it in a local Prometheus instance, and enables to users to visualise it using a realtime map or the Prometheus query interface.
Building FRMC
To build FRMC, run make from the Companion/ directory. This will download all the necessary dependencies and build FRMC.
Commit guidlines
Commits should contain a title on the first line, followed by a blank line, followed by as much detail as necessary to undertstand what the commit does and why. Lines should avoid being more than 80 characters wide.
Commit titles prefixed with feat:, fix: or improvement: will appear in the release notes. If a change sensibly spans multiple commits, either use the last commit to add informationt to the release notes, or use en empty commit.
An example of a good commit looks like this
Update building data in marker popups on each request
Previously, the map was requesting new data regularly but wasn't
updating the marker contents. This meant that if a building's recipe
changed, it would never be reflected in the map.