metrics_reporter.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 <string>
#include <string_view>
#include <unordered_map>
#include <utility>
#include <variant>
 
#include "iceberg/compat/unreachable.h"
#include "iceberg/iceberg_export.h"
#include "iceberg/metrics/commit_report.h"
#include "iceberg/metrics/scan_report.h"
#include "iceberg/result.h"
 
namespace iceberg {
 
enum class MetricsReportType {
  kScanReport,
  kCommitReport,
};
 
ICEBERG_EXPORT constexpr std::string_view ToString(MetricsReportType type) noexcept {
  switch (type) {
    case MetricsReportType::kScanReport:
      return "scan";
    case MetricsReportType::kCommitReport:
      return "commit";
  }
  ::iceberg::unreachable();
}
 
using MetricsReport = std::variant<ScanReport, CommitReport>;
 
ICEBERG_EXPORT inline MetricsReportType GetReportType(const MetricsReport& report) {
  return std::visit(
      [](const auto& r) -> MetricsReportType {
        using T = std::decay_t<decltype(r)>;
        if constexpr (std::is_same_v<T, ScanReport>) {
          return MetricsReportType::kScanReport;
        } else {
          return MetricsReportType::kCommitReport;
        }
      },
      report);
}
 
class ICEBERG_EXPORT MetricsReporter {
 public:
  virtual ~MetricsReporter() = default;
 
  virtual Status Initialize(
      [[maybe_unused]] const std::unordered_map<std::string, std::string>& properties) {
    return {};
  }
 
  virtual Status Report(const MetricsReport& report) = 0;
};
 
}  // namespace iceberg