Fotis Voutsas e5a5aaa4cb Add metadata.csv to python.d.plugin (#14959) 1 year ago
..
Makefile.inc d802f83e4a Fix make dist (#4401) 6 years ago
README.md 0ae02c9fb6 Change H1 of collector docs to separate from the website (#14715) 2 years ago
metrics.csv e5a5aaa4cb Add metadata.csv to python.d.plugin (#14959) 1 year ago
spigotmc.chart.py 7bf63905a8 fix tps decode, add memory usage chart (#11797) 3 years ago
spigotmc.conf 1657c10c6d :pencil2: fix typos. (#6680) 5 years ago

README.md

SpigotMC collector

Performs basic monitoring for Spigot Minecraft servers.

It provides two charts, one tracking server-side ticks-per-second in 1, 5 and 15 minute averages, and one tracking the number of currently active users.

This is not compatible with Spigot plugins which change the format of the data returned by the tps or list console commands.

Configuration

Edit the python.d/spigotmc.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata   # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/spigotmc.conf
host: localhost
port: 25575
password: pass

By default, a connection to port 25575 on the local system is attempted with an empty password.

Troubleshooting

To troubleshoot issues with the spigotmc module, run the python.d.plugin with the debug option enabled. The output will give you the output of the data collection job or error messages on why the collector isn't working.

First, navigate to your plugins directory, usually they are located under /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo su -s /bin/bash netdata

Now you can manually run the spigotmc module in debug mode:

./python.d.plugin spigotmc debug trace