{"id":20020597,"url":"https://github.com/sleavely/satisfactory-savegame-prometheus-exporter","last_synced_at":"2025-05-05T01:30:42.091Z","repository":{"id":259125683,"uuid":"876345554","full_name":"Sleavely/satisfactory-savegame-prometheus-exporter","owner":"Sleavely","description":"A Prometheus exporter for savegame metrics from Satisfactory","archived":false,"fork":false,"pushed_at":"2025-01-21T09:48:49.000Z","size":512,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-25T15:00:24.953Z","etag":null,"topics":["metrics","prometheus","prometheus-exporter","satisfactory"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/sleavely/satisfactory-savegame-prometheus-exporter","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sleavely.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-21T20:10:17.000Z","updated_at":"2025-03-30T18:59:05.000Z","dependencies_parsed_at":"2024-10-25T00:47:27.596Z","dependency_job_id":"1388780d-fafa-4522-92aa-0dff462fb23c","html_url":"https://github.com/Sleavely/satisfactory-savegame-prometheus-exporter","commit_stats":null,"previous_names":["sleavely/satisfactory-savegame-prometheus-exporter"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sleavely%2Fsatisfactory-savegame-prometheus-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sleavely%2Fsatisfactory-savegame-prometheus-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sleavely%2Fsatisfactory-savegame-prometheus-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sleavely%2Fsatisfactory-savegame-prometheus-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sleavely","download_url":"https://codeload.github.com/Sleavely/satisfactory-savegame-prometheus-exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252422921,"owners_count":21745515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["metrics","prometheus","prometheus-exporter","satisfactory"],"created_at":"2024-11-13T08:33:10.999Z","updated_at":"2025-05-05T01:30:42.080Z","avatar_url":"https://github.com/Sleavely.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# satisfactory-savegame-prometheus-exporter\n\nA Prometheus Exporter that generates metrics from local or remote Satisfactory save game files.\n\n[ ![npm version](https://img.shields.io/npm/v/satisfactory-savegame-prometheus-exporter.svg?style=flat) ](https://npmjs.org/package/satisfactory-savegame-prometheus-exporter \"View this project on npm\") [ ![Docker Image Version](https://img.shields.io/docker/v/sleavely/satisfactory-savegame-prometheus-exporter?label=Docker)\n](https://hub.docker.com/r/sleavely/satisfactory-savegame-prometheus-exporter) [ ![Issues](https://img.shields.io/github/issues/Sleavely/satisfactory-savegame-prometheus-exporter.svg?label=Github+issues) ](https://github.com/Sleavely/satisfactory-savegame-prometheus-exporter/issues)\n\n![Sample Grafana dashboard using the metrics recorded by satisfactory-savegame-prometheus-exporter](https://i.imgur.com/yTaaXr4.png)\n\n## Usage\n\nThe `SAVEGAME_LOCATION` environment variable can be a URL or a local path to a file or a folder. If a folder is supplied, it will recursively find the latest file.\n\nWhile you can run the `bin` scripts with `npm exec cli \u003csavegamelocation\u003e` or `npm exec express \u003csavegamelocation\u003e`, the recommended approach is to use Docker as shown below.\n\n```sh\ndocker run \\\n  --rm \\\n  -p 9772:9772 \\\n  -e SAVEGAME_LOCATION=https://example.com/satisfactory-savegame.sav \\\n  sleavely/satisfactory-savegame-prometheus-exporter:latest\n```\n\nWith Docker Compose:\n\n```yaml\n  savegame_metrics_exporter:\n    image: sleavely/satisfactory-savegame-prometheus-exporter:latest\n    restart: unless-stopped\n    volumes:\n      - ./config/saved/server:/savegames:ro\n    environment:\n      - HOST=0.0.0.0\n      - PORT=9772\n      - SAVEGAME_LOCATION=/savegames\n    networks:\n      - grafana\n    hostname: satisfactory-savegame-metrics\n```\n\nOn Windows you can mount your savegame directory by referring to `%LocalAppData%`, like this:\n\n```sh\ndocker run \\\n  --rm \\\n  -p 9772:9772 \\\n  -v %LocalAppData%\\FactoryGame\\Saved\\SaveGames\\:/savegames:ro \\\n  -e SAVEGAME_LOCATION=/savegames \\\n  sleavely/satisfactory-savegame-prometheus-exporter:latest\n```\n\nThen, in your Prometheus configuration `scrape_configs`:\n\n```yaml\n  - job_name: \"satisfactory-savegame-exporter\"\n    # How often metrics will be collected.\n    # Recommended value is half of your autosave interval.\n    scrape_interval: 5m\n    static_configs:\n      # Only one of these targets is really necessary, but it depends on\n      # how you've configured networking for the exporter container and Prometheus.\n      - targets:\n        - 'localhost:9772'\n        - 'host.docker.internal:9772'\n        - 'satisfactory-savegame-metrics:9772'\n```\n\nFor local development we rely on [`tsx`](https://tsx.is/) to skip the build step. Simply call `npm run dev` with your savegame location as an argument:\n\n```sh\nnpm run dev /mnt/c/Users/potato/AppData/Local/FactoryGame/Saved/SaveGames/\n```\n\n## Grafana Dashboard\n\n[grafana.json](./grafana.json) contains a dashboard configuration for metrics using this exporter in tandem with [`Shinigami92/satisfactory-server-prometheus-exporter`](https://github.com/Shinigami92/satisfactory-server-prometheus-exporter)\n\n## Related\n\n- [wolveix/satisfactory-server](https://github.com/wolveix/satisfactory-server) - A Docker image for running a Satisfactory Dedicated Server.\n- [Shinigami92/satisfactory-server-prometheus-exporter](https://github.com/Shinigami92/satisfactory-server-prometheus-exporter) - Prometheus Exporter for the metrics exposed from the Satisfactory Dedicated Server\n- [etothepii4/satisfactory-file-parser](https://github.com/etothepii4/satisfactory-file-parser) - TypeScript Module to parse Satisfactory save files\n- [greeny/SatisfactoryTools](https://github.com/greeny/SatisfactoryTools) - Satisfactory Tools for planning and building the perfect base.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsleavely%2Fsatisfactory-savegame-prometheus-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsleavely%2Fsatisfactory-savegame-prometheus-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsleavely%2Fsatisfactory-savegame-prometheus-exporter/lists"}