cartridge: clusterwide configuration for crud.cfg

After this patch, user may set crud.cfg with Cartridge clusterwide
configuration of `cartridge.roles.crud-router` role [1]. The behavior
is the same as in Lua crud.cfg call.

1. https://www.tarantool.io/en/doc/latest/book/cartridge/cartridge_dev/

Closes #332

Author: DifferentialOrange

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 * Added timeout condition for the validation of master presence in 
   replicaset and for the master connection (#95).
+* Support Cartridge clusterwide configuration for `crud.cfg` (#332).
 
 ### Changed
 * **Breaking**: forbid using space id in `crud.len` (#255).

README.md

@@ -1545,6 +1545,18 @@ return {
 
 4. Don't forget to bootstrap vshard.
 
+5. Configure the statistics with clusterwide configuration
+   (see `crud.cfg` options in [statistics](#statistics) section):
+```yaml
+crud:
+  stats: true
+  stats_driver: metrics
+  stats_quantiles: false
+  stats_quantile_tolerated_error: 0.001
+  stats_quantile_age_buckets_count: 5
+  stats_quantile_max_age_time: 180
+```
+
 Now your cluster contains storages that are configured to be used for
 CRUD-operations.
 You can simply call CRUD functions on the router to insert, select, and update

cartridge/roles/crud-router.lua

@@ -1,5 +1,10 @@
+local errors = require('errors')
+
 local crud = require('crud')
 local stash = require('crud.common.stash')
+local stats = require('crud.stats')
+
+local RoleConfigurationError = errors.new_class('RoleConfigurationError', {capture_stack = false})
 
 local function init()
     crud.init_router()
@@ -10,10 +15,73 @@ local function stop()
     crud.stop_router()
 end
 
+local cfg_types = {
+    stats = 'boolean',
+    stats_driver = 'string',
+    stats_quantiles = 'boolean',
+    stats_quantile_tolerated_error = 'number',
+    stats_quantile_age_buckets_count = 'number',
+    stats_quantile_max_age_time = 'number',
+}
+
+local cfg_values = {
+    stats_driver = function(value)
+        RoleConfigurationError:assert(
+            stats.is_driver_supported(value),
+            'Invalid crud configuration field "stats_driver" value: %q is not supported',
+            value
+        )
+    end,
+}
+
+local function validate_config(conf_new, _)
+    local crud_cfg = conf_new['crud']
+
+    if crud_cfg == nil then
+        return true
+    end
+
+    RoleConfigurationError:assert(
+        type(crud_cfg) == 'table',
+        'Configuration "crud" section must be a table'
+    )
+
+    RoleConfigurationError:assert(
+        crud_cfg.crud == nil,
+        '"crud" section is already presented as a name of "crud.yml", ' ..
+        'do not use it as a top-level section name'
+    )
+
+    for name, value in pairs(crud_cfg) do
+        RoleConfigurationError:assert(
+            cfg_types[name] ~= nil,
+            'Unknown crud configuration field %q', name
+        )
+
+        RoleConfigurationError:assert(
+            type(value) == cfg_types[name],
+            'Invalid crud configuration field %q type: expected %s, got %s',
+            name, cfg_types[name], type(value)
+        )
+
+        if cfg_values[name] ~= nil then
+            cfg_values[name](value)
+        end
+    end
+
+    return true
+end
+
+local function apply_config(conf)
+    crud.cfg(conf['crud'])
+end
+
 return {
     role_name = 'crud-router',
     init = init,
     stop = stop,
+    validate_config = validate_config,
+    apply_config = apply_config,
     implies_router = true,
     dependencies = {'cartridge.roles.vshard-router'},
 }

crud/cfg.lua

@@ -155,8 +155,12 @@ local function __call(self, opts)
         stats_quantile_age_buckets_count = '?number',
         stats_quantile_max_age_time = '?number',
     })
+    -- Value validation would be performed in stats checks, if required.
 
     opts = table.deepcopy(opts) or {}
+    -- opts from Cartridge clusterwide configuration is read-only,
+    -- but we want to work with copy anyway.
+    setmetatable(opts, {})
 
     configure_stats(cfg, opts)
 

crud/stats/init.lua

@@ -58,6 +58,18 @@ function stats.get_default_driver()
     end
 end
 
+--- Check if provided driver is supported.
+--
+-- @function is_driver_supported
+--
+-- @string opts.driver
+--
+-- @treturn boolean Returns `true` or `false`.
+--
+function stats.is_driver_supported(driver)
+    return drivers[driver] ~= nil
+end
+
 --- Initializes statistics registry, enables callbacks and wrappers.
 --
 --  If already enabled, do nothing.
@@ -124,9 +136,8 @@ function stats.enable(opts)
     end
 
     StatsError:assert(
-        drivers[opts.driver] ~= nil,
-        'Unsupported driver: %s', opts.driver
-    )
+        stats.is_driver_supported(opts.driver),
+        'Unsupported driver: %s', opts.driver)
 
     if opts.quantiles == nil then
         opts.quantiles = false

test/integration/cfg_test.lua

@@ -146,3 +146,63 @@ group.test_gh_284_preset_stats_quantile_max_age_time_is_preserved = function(g)
     t.assert_equals(cfg.stats_quantile_max_age_time, 30,
         'Preset stats_quantile_max_age_time presents')
 end
+
+group.test_role_cfg = function(g)
+    local cfg = {
+        stats = true,
+        stats_driver = 'local',
+        stats_quantiles = false,
+        stats_quantile_tolerated_error = 1e-2,
+        stats_quantile_age_buckets_count = 5,
+        stats_quantile_max_age_time = 180,
+    }
+
+    g.cluster.main_server:upload_config({crud = cfg})
+
+    local actual_cfg = g.cluster:server('router'):eval("return require('crud').cfg")
+    t.assert_equals(cfg, actual_cfg)
+end
+
+group.test_role_partial_cfg = function(g)
+    local router = g.cluster:server('router')
+    local cfg_before = router:eval("return require('crud').cfg()")
+
+    local cfg_after = table.deepcopy(cfg_before)
+    cfg_after.stats = not cfg_before.stats
+
+    g.cluster.main_server:upload_config({crud = {stats = cfg_after.stats}})
+
+    local actual_cfg = g.cluster:server('router'):eval("return require('crud').cfg")
+    t.assert_equals(cfg_after, actual_cfg, "Only requested field were updated")
+end
+
+local role_cfg_error_cases = {
+    wrong_section_type = {
+        args = {crud = 'enabled'},
+        err = 'Configuration \\\"crud\\\" section must be a table',
+    },
+    wrong_structure = {
+        args = {crud = {crud = {stats = true}}},
+        err = '\\\"crud\\\" section is already presented as a name of \\\"crud.yml\\\", ' ..
+              'do not use it as a top-level section name',
+    },
+    wrong_type = {
+        args = {crud = {stats = 'enabled'}},
+        err = 'Invalid crud configuration field \\\"stats\\\" type: expected boolean, got string',
+    },
+    wrong_value = {
+        args = {crud = {stats_driver = 'prometheus'}},
+        err = 'Invalid crud configuration field \\\"stats_driver\\\" value: \\\"prometheus\\\" is not supported',
+    }
+}
+
+for name, case in pairs(role_cfg_error_cases) do
+    group['test_rolce_cfg_' .. name] = function(g)
+        local success, error = pcall(function()
+            g.cluster.main_server:upload_config(case.args)
+        end)
+
+        t.assert_equals(success, false)
+        t.assert_str_contains(error.response.body, case.err)
+    end
+end

test/integration/stats_test.lua

@@ -5,13 +5,16 @@ local t = require('luatest')
 local stats_registry_utils = require('crud.stats.registry_utils')
 
 local pgroup = t.group('stats_integration', {
-    { driver = 'local' },
-    { driver = 'metrics', quantiles = false },
-    { driver = 'metrics', quantiles = true },
+    { way = 'call', args = { driver = 'local' }},
+    { way = 'call', args = { driver = 'metrics', quantiles = false }},
+    { way = 'call', args = { driver = 'metrics', quantiles = true }},
+    { way = 'role', args = { driver = 'local' }},
+    { way = 'role', args = { driver = 'metrics', quantiles = false }},
+    { way = 'role', args = { driver = 'metrics', quantiles = true }},
 })
 local group_metrics = t.group('stats_metrics_integration', {
-    { driver = 'metrics', quantiles = false },
-    { driver = 'metrics', quantiles = true },
+    { way = 'call', args = { driver = 'metrics', quantiles = false }},
+    { way = 'role', args = { driver = 'metrics', quantiles = true }},
 })
 
 local helpers = require('test.helper')
@@ -30,7 +33,7 @@ local function before_all(g)
     g.cluster:start()
     g.router = g.cluster:server('router').net_box
 
-    if g.params.driver == 'metrics' then
+    if g.params.args.driver == 'metrics' then
         local is_metrics_supported = g.router:eval([[
             return require('crud.stats.metrics_registry').is_supported()
         ]])
@@ -46,23 +49,37 @@ local function get_stats(g, space_name)
     return g.router:eval("return require('crud').stats(...)", { space_name })
 end
 
-local function enable_stats(g, params)
-    params = params or g.params
-    g.router:eval([[
-        local params = ...
-        require('crud').cfg{
-            stats = true,
-            stats_driver = params.driver,
-            stats_quantiles = params.quantiles,
-            stats_quantile_tolerated_error = 1e-3,
-            stats_quantile_age_buckets_count = 3,
-            stats_quantile_max_age_time = 60,
-        }
-    ]], { params })
+local call_cfg = function(g, way, cfg)
+    if way == 'call' then
+        g.router:eval([[
+            require('crud').cfg(...)
+        ]], { cfg })
+    elseif way == 'role' then
+        g.cluster.main_server:upload_config{crud = cfg}
+    end
+end
+
+local function enable_stats(g, args)
+    args = args or g.params.args
+
+    local cfg = {
+        stats = true,
+        stats_driver = args.driver,
+        stats_quantiles = args.quantiles,
+        stats_quantile_tolerated_error = 1e-3,
+        stats_quantile_age_buckets_count = 3,
+        stats_quantile_max_age_time = 60,
+    }
+
+    call_cfg(g, g.params.way, cfg)
 end
 
 local function disable_stats(g)
-    g.router:eval("require('crud').cfg{ stats = false }")
+    local cfg = {
+        stats = false,
+    }
+
+    call_cfg(g, g.params.way, cfg)
 end
 
 local function before_each(g)
@@ -643,7 +660,7 @@ for name, case in pairs(simple_operation_cases) do
         t.assert_le(changed_after.latency_average, ok_average_max,
             'Changed average has appropriate value')
 
-        if g.params.quantiles == true then
+        if g.params.args.quantiles == true then
             local ok_quantile_max = math.max(
                 changed_before.latency_quantile_recent or 0,
                 after_finish - before_start)
@@ -755,7 +772,7 @@ pgroup.before_test(
     generate_stats)
 
 pgroup.test_role_reload_do_not_reset_observations = function(g)
-    t.xfail_if(g.params.driver == 'metrics',
+    t.xfail_if(g.params.args.driver == 'metrics',
         'See https://github.com/tarantool/metrics/issues/334')
 
     local stats_before = get_stats(g)
@@ -870,7 +887,7 @@ end
 
 local function validate_metrics(g, metrics)
     local quantile_stats
-    if g.params.quantiles == true then
+    if g.params.args.quantiles == true then
         quantile_stats = find_metric('tnt_crud_stats', metrics)
         t.assert_type(quantile_stats, 'table', '`tnt_crud_stats` summary metrics found')
     end
@@ -885,7 +902,7 @@ local function validate_metrics(g, metrics)
     local expected_operations = { 'insert', 'insert_many', 'get', 'replace', 'replace_many', 'update',
         'upsert', 'upsert_many', 'delete', 'select', 'truncate', 'len', 'count', 'borders' }
 
-    if g.params.quantiles == true then
+    if g.params.args.quantiles == true then
         t.assert_items_equals(get_unique_label_values(quantile_stats, 'operation'), expected_operations,
             'Metrics are labelled with operation')
     end
@@ -899,7 +916,7 @@ local function validate_metrics(g, metrics)
 
     local expected_statuses = { 'ok', 'error' }
 
-    if g.params.quantiles == true then
+    if g.params.args.quantiles == true then
         t.assert_items_equals(
             get_unique_label_values(quantile_stats, 'status'),
             expected_statuses,
@@ -915,7 +932,7 @@ local function validate_metrics(g, metrics)
 
     local expected_names = { space_name }
 
-    if g.params.quantiles == true then
+    if g.params.args.quantiles == true then
         t.assert_items_equals(
             get_unique_label_values(quantile_stats, 'name'),
             expected_names,
@@ -931,7 +948,7 @@ local function validate_metrics(g, metrics)
         expected_names,
         'Metrics are labelled with space name')
 
-    if g.params.quantiles == true then
+    if g.params.args.quantiles == true then
         local expected_quantiles = { 0.99 }
         t.assert_items_equals(get_unique_label_values(quantile_stats, 'quantile'), expected_quantiles,
             'Quantile metrics presents')