metrics_registration.hh

Go to the documentation of this file.

/*
 * This file is open source software, licensed to you under the terms
 * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership.  You may not use this file except in compliance with the License.
 *
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
/*
 * Copyright (C) 2016 ScyllaDB.
 */
 
#pragma once
 
#ifndef SEASTAR_MODULE
#include <memory>
#include <vector>
 
#include <seastar/core/sstring.hh>
#include <seastar/util/modules.hh>
#endif
 
namespace seastar {
 
namespace metrics {
 
namespace impl {
class metric_groups_def;
struct metric_definition_impl;
class metric_groups_impl;
}
 
SEASTAR_MODULE_EXPORT_BEGIN
 
using group_name_type = sstring; 
class metric_groups;
 
class metric_definition {
    std::unique_ptr<impl::metric_definition_impl> _impl;
public:
    metric_definition(const impl::metric_definition_impl& impl) noexcept;
    metric_definition(metric_definition&& m) noexcept;
    ~metric_definition();
    friend metric_groups;
    friend impl::metric_groups_impl;
};
 
class metric_group_definition {
public:
    group_name_type name;
    std::initializer_list<metric_definition> metrics;
    metric_group_definition(const group_name_type& name, std::initializer_list<metric_definition> l);
    metric_group_definition(const metric_group_definition&) = delete;
    ~metric_group_definition();
};
 
class metric_groups {
    std::unique_ptr<impl::metric_groups_def> _impl;
public:
    metric_groups() noexcept;
    metric_groups(metric_groups&&) = default;
    virtual ~metric_groups();
    metric_groups& operator=(metric_groups&&) = default;
    metric_groups(std::initializer_list<metric_group_definition> mg);
 
    metric_groups& add_group(const group_name_type& name, const std::initializer_list<metric_definition>& l);
 
    metric_groups& add_group(const group_name_type& name, const std::vector<metric_definition>& l);
 
    void clear();
};
 
 
class metric_group : public metric_groups {
public:
    metric_group() noexcept;
    metric_group(const metric_group&) = delete;
    metric_group(metric_group&&) = default;
    virtual ~metric_group();
    metric_group& operator=(metric_group&&) = default;
 
    metric_group(const group_name_type& name, std::initializer_list<metric_definition> l);
};
 
SEASTAR_MODULE_EXPORT_END
 
}
}