metrics.lua

local cartridge = require('cartridge')
local argparse = require('cartridge.argparse')
local metrics = require('metrics')
local checks = require('checks')
local log = require('log')

local handlers = {
    ['json'] = function(req)
        local json_exporter = require('metrics.plugins.json')
        return req:render({ text = json_exporter.export() })
    end,
    ['prometheus'] = function(...)
        local http_handler = require('metrics.plugins.prometheus').collect_http
        return http_handler(...)
    end,
    ['health'] = function(...)
        local http_handler = require('cartridge.health').is_healthy
        return http_handler(...)
    end,
}

local function set_labels()
    local params, err = argparse.parse()
    assert(params, err)
    local this_instance = cartridge.admin_get_servers(box.info.uuid)
    local zone
    if this_instance and this_instance[1] then
        zone = this_instance[1].zone
    end
    metrics.set_global_labels({alias = params.alias or params.instance_name, zone = zone})
end

local function init()
    set_labels()
    metrics.enable_default_metrics()
    metrics.enable_cartridge_metrics()
end

local function check_config(_)
    checks({
        export = 'table',
    })
end

local function delete_route(httpd, name)
    httpd.routes[httpd.iroutes[name]] = nil
    httpd.iroutes[name] = nil
end

-- removes '/' from start and end of the path to avoid paths duplication
local function remove_side_slashes(path)
    if path:startswith('/') then
        path = path:sub(2)
    end
    if path:endswith('/') then
        path = path:sub(1, -2)
    end
    return path
end

local function validate_routes(export)
    local paths = {}
    for _, v in ipairs(export) do
        v.path = remove_side_slashes(v.path)
        assert(type(v.path) == 'string', 'export.path must be string')
        assert(handlers[v.format], 'format must be "json", "prometheus" or "health"')
        assert(paths[v.path] == nil, 'paths must be unique')
        paths[v.path] = true
    end
    return true
end

local function validate_config(conf_new)
    conf_new = conf_new.metrics
    if conf_new == nil then
        return true
    end
    check_config(conf_new)
    return validate_routes(conf_new.export)
end

-- table to store enabled routes
local current_paths = {}

local function apply_routes(export)
    local httpd = cartridge.service_get('httpd')
    if httpd == nil then
        return
    end
    for _, exporter in ipairs(export) do
        local path, format = remove_side_slashes(exporter.path), exporter.format
        if current_paths[path] ~= format then
            if current_paths[path] then
                delete_route(httpd, path)
            end
            httpd:route({method = 'GET', name = path, path = path}, handlers[format])
            current_paths[path] = format
        end
    end
    -- deletes paths that was enabled, but aren't in config now
    for path, _ in pairs(current_paths) do
        local is_present = false
        for _, exporter in ipairs(export) do
            if path == remove_side_slashes(exporter.path) then
                is_present = true
                break
            end
        end
        if not is_present then
            delete_route(httpd, path)
            current_paths[path] = nil
        end
    end
end

local metrics_config_present = false

-- removes routes that changed in config and adds new routes
local function apply_config(conf)
    local metrics_conf = conf.metrics
    -- if metrics is not present in config then skip reconfiguring routes
    if metrics_conf == nil then
        return
    else
        metrics_config_present = true
    end
    if not next(metrics_conf.export) then
        if next(current_paths) == nil then
            return
        end
        metrics_config_present = false
    end
    set_labels()
    apply_routes(metrics_conf.export)
end

local function set_export(export)
    if metrics_config_present then
        log.warn("Metrics config is present, set_export doesn't apply")
        return
    end
    local ok, err = pcall(validate_routes, export)
    if ok then
        apply_routes(export)
    else
        error(err)
    end
end

return setmetatable({
    role_name = 'metrics',
    permanent = true,
    init = init,
    validate_config = validate_config,
    apply_config = apply_config,
    set_export = set_export,
}, { __index = metrics })