There's a trove of information the game save files. Look into using https://github.com/cheahjs/palworld-save-tools to parse the game save and reports metrics like:

• Player levels
• Bases
• Pals captured
• etc
• etc

The current road block is the amount of resources used to parse Levels.sav.

There's no indication in the logs when a successful connection has been made. The exporter should log the first success so people know it was least works.

Problem

In Source RCON protocol, packet body is defined as Null-terminated ASCII String. But we can set palworld player name as non-ascii characters(ex. Korean, Chinese, Cyrillic, ...) and this sets showplayers response packet body as non-ascii character, finally RCON client is failed or stuck.

Similar issues:

• radj307/ARRCON#16
• radj307/ARRCON#20

I think this should be mainly handled by RCON client.

But it looks like exporter's polling is somewhat problematic.

This is timeline of my server when non-ascii name user joined. After user joined, somehow player count is keep exported(which is outdated) and players info is not exported. (2~3 persons playing in the server at the time)

Suggestion

• disable polling (or add on/off option)
  • I believe this would be more appropriate to control this in prometheus. So every attempt to get metric => generate current snapshot.
• replace or modify RCON client package
  • For now, I haven't tested which python RCON package can handle this situation 🥲

# HELP python_gc_objects_collected_total Objects collected during gc
# TYPE python_gc_objects_collected_total counter
python_gc_objects_collected_total{generation="0"} 233.0
python_gc_objects_collected_total{generation="1"} 24.0
python_gc_objects_collected_total{generation="2"} 0.0
# HELP python_gc_objects_uncollectable_total Uncollectable objects found during GC
# TYPE python_gc_objects_uncollectable_total counter
python_gc_objects_uncollectable_total{generation="0"} 0.0
python_gc_objects_uncollectable_total{generation="1"} 0.0
python_gc_objects_uncollectable_total{generation="2"} 0.0
# HELP python_gc_collections_total Number of times this generation was collected
# TYPE python_gc_collections_total counter
python_gc_collections_total{generation="0"} 39.0
python_gc_collections_total{generation="1"} 3.0
python_gc_collections_total{generation="2"} 0.0
# HELP python_info Python platform information
# TYPE python_info gauge
python_info{implementation="CPython",major="3",minor="12",patchlevel="1",version="3.12.1"} 1.0
# HELP process_virtual_memory_bytes Virtual memory size in bytes.
# TYPE process_virtual_memory_bytes gauge
process_virtual_memory_bytes 3.2514048e+07
# HELP process_resident_memory_bytes Resident memory size in bytes.
# TYPE process_resident_memory_bytes gauge
process_resident_memory_bytes 2.4301568e+07
# HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
# TYPE process_start_time_seconds gauge
process_start_time_seconds 1.70696266891e+09
# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
# TYPE process_cpu_seconds_total counter
process_cpu_seconds_total 0.29
# HELP process_open_fds Number of open file descriptors.
# TYPE process_open_fds gauge
process_open_fds 7.0
# HELP process_max_fds Maximum number of open file descriptors.
# TYPE process_max_fds gauge
process_max_fds 1.073741816e+09
# HELP palworld_player_count Current player count
# TYPE palworld_player_count gauge
palworld_player_count 0.0
# HELP palworld_player Palworld player information
# TYPE palworld_player gauge
# HELP palworld_server Palworld server information
# TYPE palworld_server gauge
# HELP palworld_up Was last scrape of Palworld metrics successful
# TYPE palworld_up gauge
palworld_up 1.0
# HELP palworld_player_save_count Number of player save files
# TYPE palworld_player_save_count gauge
palworld_player_save_count 0.0

First of all, thank you for this awesome exporter 😎

This is exported metrics and I don't need extra metrics like python_gc_objects_collected_total.

Of course I can exclude it from prometheus scrape config, but I think it can be done in exporter side. How do you think?

I have already had palworld server running in docker and the RCON has enabled, but it could connect to the RCON. Oh my server is in the docker on macos(M1)

When i try to run it in my docker env i get this error:
2024-02-06:13:19:14.934 WARNING [save_collector.py:21] expected str, bytes or os.PathLike object, not NoneType

Compose file:
services:
exporter:
image: docker.io/bostrt/palworld-exporter:latest
restart: unless-stopped
container_name: exporter
ports:
- 9000:9000/tcp
depends_on:
- palworld
environment:
- RCON_HOST=palworld
- RCON_PORT=25575
- RCON_PASSWORD=####REDACTED####
palworld:
image: thijsvanloef/palworld-server-docker:latest
restart: unless-stopped
container_name: palworld-server
ports:
- 8211:8211/udp
- 27015:27015/udp
environment:
- PUID=1000
- PGID=1000
- PORT=8211
- PLAYERS=10
- SERVER_PASSWORD=####REDACTED####
- MULTITHREADING=true
- RCON_ENABLED=true
- RCON_PORT=25575
- TZ=CET
- ADMIN_PASSWORD=####REDACTED####
- COMMUNITY=false
- SERVER_NAME=####REDACTED####
- AUTO_REBOOT_ENABLED=true
- AUTO_REBOOT_CRON_EXPRESSION="0 7 * * *"
- AUTO_UPDATE_ENABLED=true
volumes:
- ./data:/palworld/

https://tech.palworldgame.com/category/rest-api

Nothing happens on port 9000 with the example

It would be cool to get server fps exported as well. I feel like it's a good metric to track to quickly view the health of the server.

First, thank you for making this! I added it to my Helm chart here: https://github.com/caleb-devops/palworld-helm

One feature I'd like to see is the ability to auto detect the save directory given a base path. For example, if SAVE_DIRECTORY=/palworld/Pal/Saved, can the exporter auto detect the remaining path given there is only one save? This would enable the player save exporters to work without first identifying the UUID of the save directory.