changeset 4595:bac3dae031ee

Add note of incompatibility with trunk since 5f15ab7c6ae5
author Kim Alvefur <zash@zash.se>
date Sat, 19 Jun 2021 12:55:14 +0200 (2021-06-19)
parents 1da63fe35ef3
children c406e4bf7ee5
files mod_http_stats_stream/README.markdown mod_http_stats_stream/mod_http_stats_stream.lua mod_nodeinfo2/README.markdown mod_nodeinfo2/mod_nodeinfo2.lua mod_prometheus/mod_prometheus.lua mod_statistics_statsman/README.markdown mod_statistics_statsman/mod_statistics_statsman.lua mod_stats39/README.markdown mod_stats39/mod_stats39.lua
diffstat 9 files changed, 42 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/mod_http_stats_stream/README.markdown	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_http_stats_stream/README.markdown	Sat Jun 19 12:55:14 2021 +0200
@@ -36,4 +36,5 @@
 
 # Compatibility
 
-Prosody \>= 0.11.0
+* Prosody \>= 0.11.0
+* Trunk < [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)
--- a/mod_http_stats_stream/mod_http_stats_stream.lua	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_http_stats_stream/mod_http_stats_stream.lua	Sat Jun 19 12:55:14 2021 +0200
@@ -4,6 +4,8 @@
 local http = require "net.http.server";
 local json = require "util.json";
 
+assert(statsman.get_stats, "not compatible with trunk based on openmetrics");
+
 local sessions = {};
 
 local function updates_client_closed(response)
--- a/mod_nodeinfo2/README.markdown	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_nodeinfo2/README.markdown	Sat Jun 19 12:55:14 2021 +0200
@@ -42,7 +42,10 @@
 Compatibility
 =============
 
-  ----- -----------
-  trunk Works
-  0.11  Should work
-  ----- -----------
+  ------- --------------------
+  trunk   Does not work [^1]
+  0.11    Should work
+  ------- --------------------
+
+[^1]: not after
+    [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)
--- a/mod_nodeinfo2/mod_nodeinfo2.lua	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_nodeinfo2/mod_nodeinfo2.lua	Sat Jun 19 12:55:14 2021 +0200
@@ -5,6 +5,8 @@
 local list_users = require "core.usermanager".users;
 local os_time = os.time;
 
+assert(get_stats, "not compatible with trunk based on openmetrics");
+
 module:depends("http");
 
 local expose_users = module:get_option_boolean("nodeinfo2_expose_users", true);
--- a/mod_prometheus/mod_prometheus.lua	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_prometheus/mod_prometheus.lua	Sat Jun 19 12:55:14 2021 +0200
@@ -17,6 +17,8 @@
 local get_metric_registry = statsman.get_metric_registry;
 local collect = statsman.collect;
 
+assert(get_stats, "not compatible with trunk based on openmetrics");
+
 local function escape(text)
 	return text:gsub("\\", "\\\\"):gsub("\"", "\\\""):gsub("\n", "\\n");
 end
--- a/mod_statistics_statsman/README.markdown	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_statistics_statsman/README.markdown	Sat Jun 19 12:55:14 2021 +0200
@@ -13,3 +13,15 @@
 Then, in `modules_enabled`, replace `"statistics"` with
 `"statistics_statsman"` and the various `"statistics_<something>"`
 with equivalent `"measure_<something>"`.
+
+
+# Compatibility
+
+  ------- --------------------
+  trunk   Does not work [^1]
+  0.11    Should work
+  0.10    Should work
+  ------- --------------------
+
+[^1]: not after
+    [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)
--- a/mod_statistics_statsman/mod_statistics_statsman.lua	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_statistics_statsman/mod_statistics_statsman.lua	Sat Jun 19 12:55:14 2021 +0200
@@ -5,6 +5,8 @@
 local filters = require "util.filters";
 local serialize = require "util.serialization".serialize;
 
+assert(statsman.get_stats, "not compatible with trunk based on openmetrics");
+
 local statistics_interval = module:context("*"):get_option_number("statistics_interval", 60);
 if module:context("*"):get_option("statistics", "internal") ~= "internal" then
 	module:log("error", "Not using internal statistics, can't do anyting");
--- a/mod_stats39/README.markdown	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_stats39/README.markdown	Sat Jun 19 12:55:14 2021 +0200
@@ -61,3 +61,14 @@
 </iq>
 ```
 
+# Compatibly
+
+  Prosody version   Works
+  ----------------- -------
+  0.9.x             No
+  0.10.x            Yes
+  0.11.x            Yes
+  Trunk[^1]         No
+
+[^1]: Does not work with trunk since the [change to
+    OpenMetrics](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)
--- a/mod_stats39/mod_stats39.lua	Wed Jun 16 17:32:43 2021 +0200
+++ b/mod_stats39/mod_stats39.lua	Sat Jun 19 12:55:14 2021 +0200
@@ -2,6 +2,8 @@
 local st = require "util.stanza";
 local s_format = string.format;
 
+assert(statsman.get_stats, "not compatible with trunk based on openmetrics");
+
 module:add_feature("http://jabber.org/protocol/stats");
 
 module:hook("iq/host/http://jabber.org/protocol/stats:query", function (event)