From 305699a1fd258eb1c8d9221b7c81a1d8095a8cd7 Mon Sep 17 00:00:00 2001
From: RuscalWorld <me@ruscalworld.ru>
Date: Tue, 25 May 2021 22:24:13 +0300
Subject: [PATCH] Add comments to the default config

---
 src/main/resources/config/exporter.properties | 48 ++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/src/main/resources/config/exporter.properties b/src/main/resources/config/exporter.properties
index 22aaa35..e9024c1 100644
--- a/src/main/resources/config/exporter.properties
+++ b/src/main/resources/config/exporter.properties
@@ -1,3 +1,49 @@
+# On which port webserver should be started?
+# Default: 25585
 server-port=25585
+
+# FabricExporter updates gauge metrics every N milliseconds
+# You can change this value if you want metrics to be updated more or less frequently
+# Value must be provided in milliseconds, 1 second = 1000 milliseconds
+# Default: 1000
 update-interval=1000
-use-spark=true
\ No newline at end of file
+
+# Should FabricExporter use Spark mod (https://spark.lucko.me) to collect TPS and MSPT metrics?
+# If disabled, TPS and MSPT metrics will not be collected, values of enable-mspt and enable-tps are overridden in this case
+# If enabled, Fabric version of Spark must be installed
+# Default: true
+use-spark=true
+
+# You can disable any metric that registered via MetricRegistry (all metrics by default) using the settings below
+# Names of properties consist of "enabled" and metric name without prefix and "_" replaced with "-"
+# For example, if you want to disable "minecraft_players_online", you should set "enable-players-online" to "false"
+# If you can't find property for some metrics, you can manually add them
+# All metrics are enabled by default
+
+# Exports amount of currently loaded chunks on server
+# Collected by Minecraft
+enable-loaded-chunks=true
+
+# Exports amount of total loaded chunks on server
+# Collected by Minecraft
+enable-total-loaded-chunks=true
+
+# Exports count of milliseconds per tick (MSPT)
+# Collected by Spark. If enabled, requires Spark to be installed
+enable-mspt=true
+
+# Exports count of ticks per second (TPS)
+# Collected by Spark. If enabled, requires Spark to be installed
+enable-tps=true
+
+# Exports amount of currently online players on your server
+# Collected by FabricExporter
+enable-players-online=true
+
+# Exports amount of currently loaded entities on your server
+# Collected by FabricExporter
+enable-entities=true
+
+# Exports count of handshake requests
+# Collected by FabricExporter
+enable-handshakes=true
\ No newline at end of file