LOENS2 / pterodactyl_exporter

Python script that extracts metrics from the Pterodactyl API and provides a metrics endpoint for Prometheus
GNU General Public License v3.0
30 stars 12 forks source link

Readme not precise about the meaning of the port config parameter #24

Closed freaki2010 closed 6 months ago

freaki2010 commented 6 months ago

Describe the bug When I enter everything except the port into the config file the docker container starts and an error is shown when opening the logs. But when I enter the port as well only following output is shown.

docker compose up
[+] Running 1/0
 ✔ Container pterodactyl-exporter  Created                                                                                                                                                                    0.0s 
Attaching to pterodactyl-exporter

To Reproduce Steps to reproduce the behavior:

Expected behavior A clear and concise description of what you expected to happen. After I entered the port the docker container should start

Additional context Add any other context about the problem here.

LOENS2 commented 6 months ago

Well, based on what you tell me, I don't see any problem. If you don't configure a port the obviously fails to start, showing an error in the logs. When providing a complete config, compose does its startup procedure (showing to output you send me) and your good to go. When running without errors, the docker log is empty. That is the normal behaviour. Please further specify your problem, because I don't think I fully understand it.

LOENS2 commented 6 months ago

Ok, but does the exporter work while you're stuck on that message or not?

LOENS2 commented 6 months ago

And did you try to run the exporter on a different device? Just to rule out your specific device.

freaki2010 commented 6 months ago

okay yeah my bad... :D

Container is running, but the /metrics endpoint isn't working. I entered the port of the panel from which the login mask is available in the internet. 443 Or is it a special port the exporter need to connect to the panel?

LOENS2 commented 6 months ago

The port of the exporter usually is 9531. This does in fact not refer to the panels api endpoint nor the login mask.

LOENS2 commented 6 months ago

Ah now i see where the problem is coming from. In the README, I don't mention at all what the port option is actually for, so my bad. I just updated the README to contain the information in that.

freaki2010 commented 6 months ago

ah okay... Thank you very much! :) I was a bit confused that I need to enter the port for the panel but now it makes sense ^^

freaki2010 commented 6 months ago

Now everything is working fine. Maybe you can set it as standard parameter to the config. with a comment :)

Thank you very much for this exporter!

LOENS2 commented 6 months ago

I'll do that to prevent further confusion! Thank you for making me aware of that. I'll mark this issue as solved now.