A docker compose setup for Ficsit Remote Monitoring and alerting. Requires FicsitRemoteMonitoring plugin.
With FicsitRemoteMonitoring plugin, make sure you boot the http server /frmweb start in game or autostart the webserver.
Configured to view dashboards and alerts including:
View global production stats - current vs max production, and production/consumption per item, over time.
View overconsumption/underproduction alerts so your factories can stay efficient.
Overview of power and battery, as well as a map of what locations the power grid is serving.
View power alerts so you are alerted of power problems before any circuits trip.
View drone paths, round trip times, and battery consumption rates.
View train paths, timetables, round trip times, and station travel times. Timeseries allows you to view how changes to tracks or added trains affect station travel times.
View truck paths, round trip times, and fuel consumption.
View drop pod locations of opened vs unopened drop pods, using a map that updates in real time.
Inspect a square grid subsection of production buildings. Allows you to inspect the group's production vs consumption rates.
Inspect machines' efficiency for producting specific items. Heatmap of color from red to green indicates 0-100% efficiency.
Search for items in containers on the map.
Discord alerting for tripped grids.
FRM_HOST- Host where the Ficsit Remote Monitoring webserver is running. Generally this is your computer's IP address, EG:192.168.1.20. (Default:fakeserver)FRM_PORT- Port where the Ficsit Remote Monitoring webserver is running.8080is FRM's default at the time of writing. (Default:8080)FRM_HOSTS- Comma separated list of servers. Advanced option for players interested in monitoring multiple Ficsit Remote Monitoring webservers simultaneously. EG:server1:8080,server2:9090Uses this value over FRM_HOST + FRM_PORT if defined. (Defaults to an empty string)DISCORD_WEBHOOK- Webhook for discord fuse and low battery notifications. Something likehttps://discord.com/api/webhooks/12345/abcd12345.DISCORD_WEBHOOKS- Comma separated list of webhooks. Advanced option for players interested in alerting multiple Ficsit Remote Monitoring webservers simultaneously. EGhttps://discord.com/api/webhooks/12345/abcd12345,https://discord.com/api/webhooks/12345/hjkl.
When using FRM_HOSTS or DISCORD_WEBHOOKS, the hosts are paired with the corresponding webhook at the same index position.
The configuration associates the first webhook with the first host, the second webhook with the second host, etc.
If there are more hosts than webhooks, the remaining hosts do not have webhooks. If there are more webhooks than hosts, the remaining webhooks are ignored.
- grafana: Time series graphing dashboard. Default username/password is
admin/admin. This is the main front end for the app. - frmcompanion: A webapp that converts JSON data from FRM into Prometheus metrics at
localhost:9000/metrics. - prometheus: Ingest metrics from the remote monitoring companion. Generates alert metrics for interesting anomalies.
- alertmanager: Forwards critical alerts to notification components.
- frmcache: a caching server that pushes json metrics to a running postgres container
- postgres - the database server that frm cache pushes to, and acts as an additional data source for grafana.
- fakeserver: Test server for fake metrics used for testing. Maps to host port 8082 to avoid port conflicts if FRM is running on localhost. For testing, runs with
--profile debug.
This monitoring stack may require a minimum of 2GB of RAM, the stack may not run properly otherwise.
Install the ficsit remote monitoring mod with the Satisfactory Mod Manager.
Edit the web server config -- on steam this is something like C:\\Program Files (x86)\Steam\steamapps\common\Satisfactory\FactoryGame\Configs\FicsitRemoteMonitoring\WebServer.cfg You may need to enter the game once with the mod installed for the config file to be generated.
We are interested in Web_Autostart: we want to set this to true to autostart the webserver when we load the game. While this is optional, otherwise you will have to run /frm http start every time you launch the game.
An example configuration can look like the following:
{
"HTTP_Port": 8080,
"Web_Autostart": true,
"Web_Root": "",
"SML_ModVersion_DoNotChange": "1.3.0"
}
Follow a docker engine install guide. At the end of it, running docker compose from a command line or terminal should print out help options for docker-compose.
Consult the following docker topics for troubleshooting. TLDR, you need virtualization enabled in your bios, and windows features for WSL/Hyper-V.
Download the project files, either cloned through git, or Download the zip and extract it.
You can set up a webhook for Discord by creating a webhook following the guide. Save the webhook link. It will look something like https://discord.com/api/webhooks/12345/abcd12345.
If running the monitoring app on a separate computer, find the IP address for the computer running Satisfactory eg, in windows running ipconfig in command line and note the IPv4 address, it will look something like 192.168.1.30.
In linux, use ip a in a terminal window.
Create an .env file in the satisfactory-monitoring directory. We will store our configuration in here.
Add the saved data (IP address and webhook, if desired) to the .env file. It will look something like the following:
FRM_HOST=192.168.1.30
DISCORD_WEBHOOK=https://discord.com/api/webhooks/12345/abcd12345
You may omit the DISCORD_WEBHOOK if you are not using discord for alerts.
You may omit the FRM_HOST if you're running the monitoring on the same computer as Satisfactory on windows.
You do not need to create the .env file at all if you are running both the game and the monitoring stack locally on one computer, and you do not need discord webhooks.
For Linux, the FRM_HOST will need to be set. The default host IP on the networking stack is 172.17.0.1, and your .env can be:
FRM_HOST=172.17.0.1
Start satisfactory, and run docker compose up -d from the satisfactory-monitoring directory.
Navigate to localhost:3000. Log in with username: admin, password: admin. You should now be able to see the dashboards. Use the navigation on the left side to view available dashboards.
If you do not see any data or your server populate in the top, the monitoring stack most likely cannot reach your game.
In case you need to hide IPs from the dashboard, you may update docker-compose.yml to include extra_hosts - this is a way of telling the internal services how to access the FRM host by a hostname alias.
Uncomment (remove the # character) on both extra_hosts lines and replace 192.168.1.100 lines with your IP. Then use FRM_HOST=my-server in your .env file. The resulting configuration will allow the FRM companion and cache to access the data by IP, and the dashboards will list the server(s) by their alias (my-server).
EG:
extra_hosts:
- "my-server:192.168.1.100"
When you're done with stack, you can run docker compose down which will completely delete and remove the monitoring stack.
Data is saved to docker volumes. To stop the stack AND remove the data run:
docker compose down --volumes
Make sure you destroy your old environment and pull in the new stack to upgrade and fully restart.
If you installed via git:
docker compose down
git pull
docker compose pull
docker compose up -d
If you installed via a zip, run docker compose down, download and replace the folder, and then run
docker compose pull
docker compose up -d
If you are getting blank dashboards, you can view logs with docker compose logs to check for any errors. Specifically: docker compose logs frmcompanion and docker compose logs frmcache as those are the two apps that are pulling data.
You are able to run docker compose build --no-cache to build the local docker images.
There is a fake server you can run with docker compose up -d --profile debug that will report some fake metrics. The FRM_HOST and FRM_PORT is: fakeserver:8080.