9.2/includes/prometheus/registry.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * 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.
 */
 
#pragma once
 
#include <memory>
#include <mutex>
#include <string>
#include <vector>
 
#include "prometheus/collectable.h"
#include "prometheus/detail/core_export.h"
#include "prometheus/family.h"
#include "prometheus/labels.h"
#include "prometheus/metric_family.h"
 
namespace prometheus {
 
class Counter;
class Gauge;
class Histogram;
class Info;
class Summary;
 
namespace detail {
 
template <typename T>
class Builder;  // IWYU pragma: keep
 
}
class PROMETHEUS_CPP_CORE_EXPORT Registry : public Collectable {
 public:
  enum class InsertBehavior {
    Merge,
    Throw,
  };
 
  explicit Registry(InsertBehavior insert_behavior = InsertBehavior::Merge);
 
  Registry(const Registry&) = delete;
 
  Registry& operator=(const Registry&) = delete;
 
  Registry(Registry&&) = delete;
 
  Registry& operator=(Registry&&) = delete;
 
  ~Registry() override;
 
  std::vector<MetricFamily> Collect() const override;
 
  template <typename T>
  bool Remove(const Family<T>& family);
 
 private:
  template <typename T>
  friend class detail::Builder;
 
  template <typename T>
  std::vector<std::unique_ptr<Family<T>>>& GetFamilies();
 
  template <typename T>
  bool NameExistsInOtherType(const std::string& name) const;
 
  template <typename T>
  Family<T>& Add(const std::string& name, const std::string& help,
                 const Labels& labels);
 
  const InsertBehavior insert_behavior_;
  std::vector<std::unique_ptr<Family<Counter>>> counters_;
  std::vector<std::unique_ptr<Family<Gauge>>> gauges_;
  std::vector<std::unique_ptr<Family<Histogram>>> histograms_;
  std::vector<std::unique_ptr<Family<Info>>> infos_;
  std::vector<std::unique_ptr<Family<Summary>>> summaries_;
  mutable std::mutex mutex_;
};
 
}  // namespace prometheus