config: add metrics section to schema

Lord-KA · Lord-KA · commit fc2478aee6c9 · 2023-08-03T08:28:23.000Z
This patch introduces all metrics configuration. Part of tarantool#8861 NO_DOC=tarantool/doc#3544 links the most actual schema, no need to update the issue.
diff --git a/changelogs/unreleased/gh-8861-metrics-options.md b/changelogs/unreleased/gh-8861-metrics-options.md
@@ -0,0 +1,3 @@
+## feature/config
+
+* All metrics `box.cfg{}` options are now supported by config (gh-8861).
diff --git a/src/box/CMakeLists.txt b/src/box/CMakeLists.txt
@@ -43,6 +43,7 @@ lua_source(lua_sources lua/config/applier/box_cfg.lua     config_applier_box_cfg
 lua_source(lua_sources lua/config/applier/console.lua     config_applier_console_lua)
 lua_source(lua_sources lua/config/applier/credentials.lua config_applier_credentials_lua)
 lua_source(lua_sources lua/config/applier/fiber.lua       config_applier_fiber_lua)
+lua_source(lua_sources lua/config/applier/metrics.lua     config_applier_metrics_lua)
 lua_source(lua_sources lua/config/applier/mkdir.lua       config_applier_mkdir_lua)
 lua_source(lua_sources lua/config/cluster_config.lua      config_cluster_config_lua)
 lua_source(lua_sources lua/config/configdata.lua          config_configdata_lua)
diff --git a/src/box/lua/config/applier/metrics.lua b/src/box/lua/config/applier/metrics.lua
@@ -0,0 +1,30 @@
+local log = require('internal.config.utils.log')
+
+local function apply(config)
+    local configdata = config._configdata
+    local include = configdata:get('metrics.include', {use_default = true})
+    local exclude = configdata:get('metrics.exclude', {use_default = true})
+    local labels = configdata:get('metrics.labels', {use_default = true})
+
+    local default_include = { 'all' }
+    local default_exclude = { }
+    local default_labels = { alias = configdata._instance_name }
+
+    include = include or default_include
+    exclude = exclude or default_exclude
+    labels = labels or default_labels
+
+    box.cfg.metrics.include = include
+    log.verbose('metrics.apply: include applied')
+
+    box.cfg.metrics.exclude = exclude
+    log.verbose('metrics.apply: exclude applied')
+
+    box.cfg.metrics.labels = labels
+    log.verbose('metrics.apply: labels applied')
+end
+
+return {
+    name = 'metrics',
+    apply = apply,
+}
diff --git a/src/box/lua/config/init.lua b/src/box/lua/config/init.lua
@@ -122,6 +122,7 @@ function methods._initialize(self)
     self:_register_applier(require('internal.config.applier.console'))
     self:_register_applier(require('internal.config.applier.fiber'))
     self:_register_applier(require('internal.config.applier.app'))
+    self:_register_applier(require('internal.config.applier.metrics'))
 
     -- Tarantool Enterprise Edition has its own additions
     -- for this module.
diff --git a/src/box/lua/config/instance_config.lua b/src/box/lua/config/instance_config.lua
@@ -1357,6 +1357,50 @@ return schema.new('instance_config', schema.record({
             box_cfg = 'password_history_length',
         })),
     }),
+    metrics = schema.record({
+        include = schema.set({
+            'all',
+            'network',
+            'operations',
+            'system',
+            'replicas',
+            'info',
+            'slab',
+            'runtime',
+            'memory',
+            'spaces',
+            'fibers',
+            'cpu',
+            'vinyl',
+            'memtx',
+            'luajit',
+            'clock',
+            'event_loop',
+        }),
+        exclude = schema.set({
+            'all',
+            'network',
+            'operations',
+            'system',
+            'replicas',
+            'info',
+            'slab',
+            'runtime',
+            'memory',
+            'spaces',
+            'fibers',
+            'cpu',
+            'vinyl',
+            'memtx',
+            'luajit',
+            'clock',
+            'event_loop',
+        }),
+        labels = schema.map({
+            key = schema.scalar({type = 'string'}),
+            value = schema.scalar({type = 'string'}),
+        }),
+    }),
 }, {
     -- This kind of validation cannot be implemented as the
     -- 'validate' annotation of a particular schema node. There
diff --git a/src/box/lua/init.c b/src/box/lua/init.c
@@ -142,6 +142,7 @@ extern char session_lua[],
 	config_applier_console_lua[],
 	config_applier_credentials_lua[],
 	config_applier_fiber_lua[],
+	config_applier_metrics_lua[],
 	config_applier_mkdir_lua[],
 	config_cluster_config_lua[],
 	config_configdata_lua[],
@@ -372,6 +373,10 @@ static const char *lua_sources[] = {
 	"internal.config.applier.fiber",
 	config_applier_fiber_lua,
 
+	"config/applier/metrics",
+	"internal.config.applier.metrics",
+	config_applier_metrics_lua,
+
 	"config/applier/mkdir",
 	"internal.config.applier.mkdir",
 	config_applier_mkdir_lua,
diff --git a/test/config-luatest/config_test.lua b/test/config-luatest/config_test.lua
@@ -688,3 +688,81 @@ g.test_security_options = function()
         t.assert_equals(box.cfg.password_history_length, 3)
     end)
 end
+
+g.test_metrics_options_default = function()
+    local dir = treegen.prepare_directory(g, {}, {})
+    local config = [[
+        credentials:
+          users:
+            guest:
+              roles:
+              - super
+
+        iproto:
+          listen: unix/:./{{ instance_name }}.iproto
+
+        groups:
+          group-001:
+            replicasets:
+              replicaset-001:
+                instances:
+                  instance-001: {}
+    ]]
+
+    -- Test defaults.
+    local config_file = treegen.write_script(dir, 'base_config.yaml', config)
+    local opts = {
+        config_file = config_file,
+        alias = 'instance-001',
+        chdir = dir,
+    }
+    g.server = server:new(opts)
+    g.server:start()
+    g.server:exec(function()
+        t.assert_equals(box.cfg.metrics.include, {'all'})
+        t.assert_equals(box.cfg.metrics.exclude, { })
+        t.assert_equals(box.cfg.metrics.labels, {alias = 'instance-001'})
+    end)
+    g.server:stop()
+end
+
+g.test_metrics_options = function()
+    local dir = treegen.prepare_directory(g, {}, {})
+    local config = [[
+        credentials:
+          users:
+            guest:
+              roles:
+              - super
+
+        iproto:
+          listen: unix/:./{{ instance_name }}.iproto
+
+        metrics:
+          include: [cpu]
+          exclude: [all]
+          labels:
+            foo: bar
+
+        groups:
+          group-001:
+            replicasets:
+              replicaset-001:
+                instances:
+                  instance-001: {}
+    ]]
+
+    local config_file = treegen.write_script(dir, 'base_config.yaml', config)
+    local opts = {
+        config_file = config_file,
+        alias = 'instance-001',
+        chdir = dir,
+    }
+    g.server = server:new(opts)
+    g.server:start()
+    g.server:exec(function()
+        t.assert_equals(box.cfg.metrics.include, {'cpu'})
+        t.assert_equals(box.cfg.metrics.exclude, {'all'})
+        t.assert_equals(box.cfg.metrics.labels, {foo = 'bar'})
+    end)
+end
diff --git a/test/config-luatest/instance_config_schema_test.lua b/test/config-luatest/instance_config_schema_test.lua
@@ -1037,7 +1037,7 @@ g.test_box_cfg_coverage = function()
         audit_format = true,
         audit_filter = true,
 
-        -- TODO: Will be added in the scope of gh-8861.
+        -- For now defaults are managed by options applier.
         metrics = true,
     }
 
@@ -1280,3 +1280,16 @@ g.test_security_community = function()
 
     instance_config:validate(iconfig)
 end
+
+g.test_metrics = function()
+    local iconfig = {
+        metrics = {
+            include = {'network', 'info', 'cpu'},
+            exclude = {'info'},
+            labels = {foo = 'bar'},
+        }
+    }
+
+    instance_config:validate(iconfig)
+    validate_fields(iconfig.metrics, instance_config.schema.fields.metrics)
+end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## feature/config`
	`2`	`+`
	`3`	+* All metrics `box.cfg{}` options are now supported by config (gh-8861).