Skip to content

Some stats for the auto-purge plugin #5961

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickva merged 1 commit into from
Apr 7, 2026
+33 −3
Merged

Some stats for the auto-purge plugin #5961

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/couch/priv/stats_descriptions.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,3 +494,19 @@
{type, gauge},
{desc, <<"set to 1 when upgrade_in_progress is toggled">>}
]}.
{[auto_purge, start], [
{type, counter},
{desc, <<"count of auto-purge starts or resumes">>}
]}.
{[auto_purge, complete], [
{type, counter},
{desc, <<"count of auto-purge completions">>}
]}.
{[auto_purge, db_open], [
{type, counter},
{desc, <<"count of db opens by auto-purge plugin">>}
]}.
{[auto_purge, purge], [
{type, counter},
{desc, <<"count of purges by auto-purge plugin">>}
]}.
10 changes: 8 additions & 2 deletions src/couch/src/couch_auto_purge_plugin.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ start(ScanId, #{}) ->
skip;
false ->
St = init_config(ScanId),
couch_stats:increment_counter([auto_purge, start]),
?LOG(level(), "Starting.", [], St),
{ok, St}
end.
Expand All @@ -45,12 +46,14 @@ resume(ScanId, #{}) ->
skip;
false ->
St = init_config(ScanId),
couch_stats:increment_counter([auto_purge, start]),
?LOG(level(), "Resuming.", [], St),
{ok, St}
end.

complete(St) ->
?LOG(level(), "Completed.", [], St),
couch_stats:increment_counter([auto_purge, complete]),
{ok, #{}}.

checkpoint(St) ->
Expand All @@ -74,6 +77,7 @@ db(St, DbName) ->
end.

db_opened(#{} = St, Db) ->
couch_stats:increment_counter([auto_purge, db_open]),
#{ttl := TTL, queue := Queue} = St,
?assert(Queue == [], "Queue is not empty from previous operations"),
EndSeq = couch_time_seq:since(couch_db:get_time_seq(Db), couch_time_seq:timestamp() - TTL),
Expand Down Expand Up @@ -144,12 +148,14 @@ flush_queue(#{queue := IdRevs} = St, Db) ->
meta(St)
),
#{count := Count, limiter := Limiter0} = St,
ResCount = length(Results),
couch_stats:increment_counter([auto_purge, purge], ResCount),
{Wait, Limiter1} = couch_scanner_rate_limiter:update(
Limiter0, doc_write, length(Results)
Limiter0, doc_write, ResCount
),
timer:sleep(Wait),
St#{
count := Count + length(Results),
count := Count + ResCount,
limiter := Limiter1,
queue := []
};
Expand Down
10 changes: 9 additions & 1 deletion src/couch/test/eunit/couch_auto_purge_plugin_tests.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ t_auto_purge_after_db_ttl({_, DbName}) ->
config:set("couch_scanner_plugins", atom_to_list(?PLUGIN), "true", false),
wait_exit(10000),
?assertEqual(0, doc_del_count(DbName)),
?assertEqual(1, couch_stats:sample([auto_purge, start])),
?assertEqual(1, couch_stats:sample([auto_purge, complete])),
?assertEqual(2, couch_stats:sample([auto_purge, db_open])),
?assertEqual(1, couch_stats:sample([auto_purge, purge])),
ok.

t_no_auto_purge_after_config_ttl_set_to_infinity({_, DbName}) ->
Expand Down Expand Up @@ -249,7 +253,11 @@ reset_stats() ->
Counters = [
[couchdb, query_server, process_error_exits],
[couchdb, query_server, process_errors],
[couchdb, query_server, process_exits]
[couchdb, query_server, process_exits],
[auto_purge, start],
[auto_purge, complete],
[auto_purge, db_open],
[auto_purge, purge]
],
[reset_counter(C) || C <- Counters].

Expand Down