graftorio2
Fork of graftorio
visualize metrics from your factorio game in grafana
What is this?
grafana is an open-source project for rendering time-series metrics. by using graftorio, you can create a dashboard with various charts monitoring aspects of your factorio factory. this dashboard is viewed using a web browser outside of the game client. (works great in a 2nd monitor!)
in order to use graftorio, you need to run the grafana software and a database called prometheus locally. graftorio automates this process using docker, or you can set these up by hand.
Installation
- download the latest release, and extract it into the location you want to host the local database
- install docker
- if using windows, you will need to be running Windows 10 Pro
- if using macOS or Linux, open the extracted
docker-compose.ymlin a text editor and uncomment the correct path to your factorio install - using a terminal, run
docker-compose upinside the extracted directory - load
localhost:3000in a browser, don't need to login and prometheus is already the default datasource - launch factorio
- install the "graftorio2" mod via the mods menu
- load up your game, and see your statistics in the grafana dashboard
Debugging
mod
to see if factorio is generating stats, confirm a game.prom file exists at the configured exporter volume directory. when opened, it should look something like this:
# HELP factorio_item_production_input items produced
# TYPE factorio_item_production_input gauge
factorio_item_production_input{force="player",name="burner-mining-drill"} 3
factorio_item_production_input{force="player",name="iron-chest"} 1
prometheus
to see if prometheus is scraping the data, load localhost:9090/targets in a browser and confirm that the status is "UP"
grafana
to see if the grafana data source can read correctly, start a new dashboard and add a graph with the query factorio_item_production_input. the graph should render the total of every item produced in your game.