You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ja...@apache.org on 2022/10/14 03:51:47 UTC
[couchdb] branch main updated: Quiet prometheus end to end tests
This is an automated email from the ASF dual-hosted git repository.
jaydoane pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/couchdb.git
The following commit(s) were added to refs/heads/main by this push:
new bdf8acd6c Quiet prometheus end to end tests
bdf8acd6c is described below
commit bdf8acd6c8a89990e35cef0012ec501551b34e8e
Author: Jay Doane <ja...@apache.org>
AuthorDate: Wed Oct 12 15:19:01 2022 -0700
Quiet prometheus end to end tests
Currently, applications are restarted during individual tests,
resulting in noisy output:
module 'couch_prometheus_e2e_tests'
Prometheus E2E Tests
couch_prometheus_e2e_tests:66: node_call_chttpd...ok
Application config was left running!
Application asn1 was left running!
Application b64url was left running!
Application public_key was left running!
Application ssl was left running!
Application couch_dist was left running!
Application couch_epi was left running!
Application khash was left running!
Application couch_event was left running!
Application folsom was left running!
Application couch_stats was left running!
Application hyper was left running!
Application ibrowse was left running!
Application inets was left running!
Application hqueue was left running!
Application compiler was left running!
Application syntax_tools was left running!
Application xmerl was left running!
Application mochiweb was left running!
Application sasl was left running!
Application ets_lru was left running!
Application rexi was left running!
Application fabric was left running!
couch_prometheus_e2e_tests:98: node_call_prometheus_http...ok
Application config was left running!
Application asn1 was left running!
Application b64url was left running!
Application public_key was left running!
Application ssl was left running!
Application couch_dist was left running!
Application couch_epi was left running!
Application khash was left running!
Application couch_event was left running!
Application folsom was left running!
Application couch_stats was left running!
Application hyper was left running!
Application ibrowse was left running!
Application inets was left running!
Application hqueue was left running!
Application compiler was left running!
Application syntax_tools was left running!
Application xmerl was left running!
Application mochiweb was left running!
Application sasl was left running!
Application ets_lru was left running!
Application rexi was left running!
Application fabric was left running!
couch_prometheus_e2e_tests:109: deny_prometheus_http...ok
couch_prometheus_e2e_tests:82: node_see_updated_metrics...ok
[done in 6.595 s]
[done in 8.739 s]
To reduce the noise, this factors the current test generator into two:
one where a separate prometheus HTTP server is started on a dedicated
port, and one where it is not.
Additionally, tests have been changed to use the TDEF_FE macro,
cleaned up, and renamed to make them easier to understand.
Finally, this simplifies the test for observing metric updates by
picking a metric that increments automatically with the passage of
time.
---
.../test/eunit/couch_prometheus_e2e_tests.erl | 218 ++++++++++-----------
1 file changed, 107 insertions(+), 111 deletions(-)
diff --git a/src/couch_prometheus/test/eunit/couch_prometheus_e2e_tests.erl b/src/couch_prometheus/test/eunit/couch_prometheus_e2e_tests.erl
index f986fc6b0..160c1bea7 100644
--- a/src/couch_prometheus/test/eunit/couch_prometheus_e2e_tests.erl
+++ b/src/couch_prometheus/test/eunit/couch_prometheus_e2e_tests.erl
@@ -13,7 +13,6 @@
-module(couch_prometheus_e2e_tests).
-include_lib("couch/include/couch_eunit.hrl").
--include_lib("couch/include/couch_db.hrl").
-define(USER, "prometheus_test_admin").
-define(PASS, "pass").
@@ -21,131 +20,128 @@
-define(PROM_PORT, "17986").
-define(CONTENT_JSON, {"Content-Type", "application/json"}).
-start() ->
- test_util:start_couch([chttpd, couch_prometheus]).
-
-setup() ->
- Hashed = couch_passwords:hash_admin_password(?PASS),
- ok = config:set("admins", ?USER, ?b2l(Hashed), _Persist = false),
- ok = config:set_integer("stats", "interval", 2),
- ok = config:set_integer("couch_prometheus", "interval", 1),
- Port = mochiweb_socket_server:get(chttpd, port),
- construct_url(Port).
-
-teardown(_) ->
- ok.
-
-couch_prometheus_e2e_test_() ->
+e2e_test_() ->
{
- "Prometheus E2E Tests",
+ "With dedicated port",
{
setup,
- fun start/0,
- fun test_util:stop_couch/1,
+ fun() ->
+ setup_prometheus(true)
+ end,
+ fun(Ctx) ->
+ test_util:stop_couch(Ctx)
+ end,
{
foreach,
- fun setup/0,
- fun teardown/1,
+ fun() ->
+ mochiweb_socket_server:get(chttpd, port)
+ end,
[
- fun node_call_chttpd/1,
- fun node_call_prometheus_http/1,
- fun deny_prometheus_http/1,
- fun node_see_updated_metrics/1
+ ?TDEF_FE(t_chttpd_port),
+ ?TDEF_FE(t_prometheus_port),
+ ?TDEF_FE(t_metric_updated)
]
}
}
}.
-% normal chttpd path via cluster port
-node_call_chttpd(Url) ->
- {ok, RC1, _, _} = test_request:get(
- Url,
- [?CONTENT_JSON, ?AUTH],
- []
- ),
- ?_assertEqual(200, RC1).
-
-% normal chttpd path via cluster port
-node_see_updated_metrics(Url) ->
- TmpDb = ?tempdb(),
- Addr = config:get("chttpd", "bind_address", "127.0.0.1"),
- Port = mochiweb_socket_server:get(chttpd, port),
- DbUrl = lists:concat(["http://", Addr, ":", Port, "/", ?b2l(TmpDb)]),
- create_db(DbUrl),
- [create_doc(DbUrl, "testdoc" ++ integer_to_binary(I)) || I <- lists:seq(1, 100)],
- delete_db(DbUrl),
- InitMetrics = wait_for_metrics(Url, "couchdb_httpd_requests_total 0", 5000),
- UpdatedMetrics = wait_for_metrics(Url, "couchdb_httpd_requests_total", 10000),
- % since the puts happen so fast, we can't have an exact
- % total requests given the scraping interval. so we just want to acknowledge
- % a change as occurred
- ?_assertNotEqual(InitMetrics, UpdatedMetrics).
+reject_test_() ->
+ {
+ "Without dedicated port",
+ {
+ setup,
+ fun() ->
+ setup_prometheus(false)
+ end,
+ fun(Ctx) ->
+ test_util:stop_couch(Ctx)
+ end,
+ {
+ foreach,
+ fun() ->
+ ?PROM_PORT
+ end,
+ [
+ ?TDEF_FE(t_reject_prometheus_port)
+ ]
+ }
+ }
+ }.
-% normal chttpd path via cluster port
-node_call_prometheus_http(_) ->
- maybe_start_http_server("true"),
- Url = construct_url(?PROM_PORT),
- {ok, RC1, _, _} = test_request:get(
- Url,
- [?CONTENT_JSON, ?AUTH]
- ),
- % since this port doesn't require auth, this should work
- {ok, RC2, _, _} = test_request:get(
- Url,
- [?CONTENT_JSON]
+setup_prometheus(WithAdditionalPort) ->
+ Ctx = test_util:start_couch([chttpd]),
+ Persist = false,
+ Hashed = couch_passwords:hash_admin_password(?PASS),
+ ok = config:set("admins", ?USER, binary_to_list(Hashed), Persist),
+ ok = config:set_integer("stats", "interval", 1, Persist),
+ ok = config:set_integer("prometheus", "interval", 1, Persist),
+ ok = config:set_boolean(
+ "prometheus",
+ "additional_port",
+ WithAdditionalPort,
+ Persist
),
- delete_db(Url),
- ?_assertEqual({200, 200}, {RC1, RC2}).
-
-% we don't start the http server
-deny_prometheus_http(_) ->
- maybe_start_http_server("false"),
- Url = construct_url(?PROM_PORT),
- Response = test_request:get(
- Url,
- [?CONTENT_JSON, ?AUTH],
- []
+ % It's already started by default, so restart to pick up config
+ ok = application:stop(couch_prometheus),
+ ok = application:start(couch_prometheus),
+ Ctx.
+
+t_chttpd_port(Port) ->
+ {ok, RC, _, _} = test_request:get(node_local_url(Port), [?CONTENT_JSON, ?AUTH]),
+ ?assertEqual(200, RC).
+
+t_prometheus_port(_) ->
+ Url = node_local_url(?PROM_PORT),
+ {ok, RC1, _, _} = test_request:get(Url, [?CONTENT_JSON, ?AUTH]),
+ ?assertEqual(200, RC1),
+ % Since this port doesn't require auth, this should work
+ {ok, RC2, _, _} = test_request:get(Url, [?CONTENT_JSON]),
+ ?assertEqual(200, RC2).
+
+t_reject_prometheus_port(Port) ->
+ Response = test_request:get(node_local_url(Port), [?CONTENT_JSON, ?AUTH]),
+ ?assertEqual({error, {conn_failed, {error, econnrefused}}}, Response).
+
+t_metric_updated(Port) ->
+ % The passage of time should increment this metric
+ Metric = "couchdb_uptime_seconds",
+ Url = node_local_url(Port),
+ % We may need to wait until the metric appears
+ InitialValue = test_util:wait(
+ fun() ->
+ Stats = get_stats(Url),
+ case metric_value(Stats, Metric) of
+ not_found -> wait;
+ Val -> Val
+ end
+ end
),
- ?_assertEqual({error, {conn_failed, {error, econnrefused}}}, Response).
-
-maybe_start_http_server(Additional) ->
- test_util:stop_applications([couch_prometheus, chttpd]),
- Hashed = couch_passwords:hash_admin_password(?PASS),
- ok = config:set("admins", ?USER, ?b2l(Hashed), _Persist = false),
- ok = config:set("prometheus", "additional_port", Additional),
- ok = config:set("prometheus", "port", ?PROM_PORT),
- test_util:start_applications([couch_prometheus, chttpd]).
-
-construct_url(Port) ->
- Addr = config:get("chttpd", "bind_address", "127.0.0.1"),
- lists:concat(["http://", Addr, ":", Port, "/_node/_local/_prometheus"]).
-
-create_db(Url) ->
- {ok, Status, _, _} = test_request:put(Url, [?CONTENT_JSON, ?AUTH], "{}"),
- ?assert(Status =:= 201 orelse Status =:= 202).
-
-delete_db(Url) ->
- {ok, 200, _, _} = test_request:delete(Url, [?AUTH]).
-
-create_doc(Url, Id) ->
- test_request:put(
- Url ++ "/" ++ Id,
- [?CONTENT_JSON, ?AUTH],
- "{\"mr\": \"rockoartischocko\"}"
- ).
-
-wait_for_metrics(Url, Value, Timeout) ->
test_util:wait(
fun() ->
- {ok, _, _, Body} = test_request:get(
- Url,
- [?CONTENT_JSON, ?AUTH],
- []
- ),
- case string:find(Body, Value) of
- nomatch -> wait;
- M -> M
+ NewValue = metric_value(get_stats(Url), Metric),
+ case NewValue > InitialValue of
+ true -> ok;
+ false -> wait
end
- end,
- Timeout
+ end
).
+
+node_local_url(Port) ->
+ Addr = config:get("chttpd", "bind_address", "127.0.0.1"),
+ lists:concat(["http://", Addr, ":", Port, "/_node/_local/_prometheus"]).
+
+get_stats(Url) ->
+ {ok, _, _, Body} = test_request:get(Url, [?CONTENT_JSON, ?AUTH]),
+ Body.
+
+metric_value(StatsBin, Metric) ->
+ % Prefix metric with newline to avoid matching lines starting with "# TYPE"
+ case string:find(StatsBin, "\n" ++ Metric, trailing) of
+ nomatch ->
+ not_found;
+ Leading ->
+ Trimmed = string:trim(Leading, leading),
+ [Line, _Rest] = string:split(Trimmed, "\n"),
+ [_MetricBin, Value] = string:split(Line, " "),
+ binary_to_integer(Value)
+ end.