metrics_reporters.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 <functional>
#include <memory>
#include <string>
#include <string_view>
#include <unordered_map>
#include <unordered_set>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/metrics/metrics_reporter.h"
#include "iceberg/result.h"
 
namespace iceberg {
 
constexpr std::string_view kMetricsReporterImpl = "metrics-reporter-impl";
 
constexpr std::string_view kMetricsReporterTypeNoop = "noop";
 
using MetricsReporterFactory = std::function<Result<std::unique_ptr<MetricsReporter>>(
    const std::unordered_map<std::string, std::string>& properties)>;
 
class ICEBERG_EXPORT CompositeMetricsReporter : public MetricsReporter {
 public:
  explicit CompositeMetricsReporter(
      std::unordered_set<std::shared_ptr<MetricsReporter>> reporters);
 
  Status Report(const MetricsReport& report) override;
 
  const std::unordered_set<std::shared_ptr<MetricsReporter>>& Reporters() const;
 
 private:
  std::unordered_set<std::shared_ptr<MetricsReporter>> reporters_;
};
 
class ICEBERG_EXPORT MetricsReporters {
 public:
  static Result<std::unique_ptr<MetricsReporter>> Load(
      const std::unordered_map<std::string, std::string>& properties);
 
  static Status Register(std::string_view reporter_type, MetricsReporterFactory factory);
 
  static std::shared_ptr<MetricsReporter> Combine(
      std::shared_ptr<MetricsReporter> first, std::shared_ptr<MetricsReporter> second);
};
 
}  // namespace iceberg