mod_log_rate/README.wiki
changeset 1786 29f3d6b7ad16
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_log_rate/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,23 @@
+#summary Collect statistics on rate of log messages
+
+= Introduction =
+
+If you ever wanted to collect statistics on the number of log messages, this is the module for you!
+
+= Setup =
+
+After [https://prosody.im/doc/installing_modules installing the module] and adding it to modules_enabled as most other modules, you also need to add it to your logging config:
+
+{{{
+log = {
+	-- your other log sinks
+	info = "/var/log/prosody/prosody.log"
+	-- add this:
+	{ to = "measure" }
+}}}
+
+Then log messages will be counted by [https://prosody.im/doc/developers/core/statsmanager statsmanager].
+
+= Compatibility =
+
+Reqires Prosody 0.10 or above.