commit_report.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 <memory>
#include <optional>
#include <string>
#include <unordered_map>
 
#include "iceberg/constants.h"
#include "iceberg/iceberg_export.h"
#include "iceberg/metrics/metrics_context.h"
#include "iceberg/metrics/metrics_types.h"
#include "iceberg/metrics/timer.h"
 
namespace iceberg {
 
// Forward declaration: CommitMetrics is defined later in this header.
class CommitMetrics;
 
struct ICEBERG_EXPORT CommitMetricsResult {
  std::optional<TimerResult> total_duration;
  std::optional<CounterResult> attempts;
  std::optional<CounterResult> added_data_files;
  std::optional<CounterResult> removed_data_files;
  std::optional<CounterResult> total_data_files;
  std::optional<CounterResult> added_delete_files;
  std::optional<CounterResult> added_equality_delete_files;
  std::optional<CounterResult> added_positional_delete_files;
  std::optional<CounterResult> added_dvs;
  std::optional<CounterResult> removed_delete_files;
  std::optional<CounterResult> removed_positional_delete_files;
  std::optional<CounterResult> removed_dvs;
  std::optional<CounterResult> removed_equality_delete_files;
  std::optional<CounterResult> total_delete_files;
  std::optional<CounterResult> added_records;
  std::optional<CounterResult> removed_records;
  std::optional<CounterResult> total_records;
  std::optional<CounterResult> added_files_size_bytes;
  std::optional<CounterResult> removed_files_size_bytes;
  std::optional<CounterResult> total_files_size_bytes;
  std::optional<CounterResult> added_positional_deletes;
  std::optional<CounterResult> removed_positional_deletes;
  std::optional<CounterResult> total_positional_deletes;
  std::optional<CounterResult> added_equality_deletes;
  std::optional<CounterResult> removed_equality_deletes;
  std::optional<CounterResult> total_equality_deletes;
  std::optional<CounterResult> kept_manifest_count;
  std::optional<CounterResult> created_manifest_count;
  std::optional<CounterResult> replaced_manifest_count;
  std::optional<CounterResult> processed_manifest_entries_count;
 
  bool operator==(const CommitMetricsResult&) const = default;
 
  static CommitMetricsResult From(
      const CommitMetrics& live_metrics,
      const std::unordered_map<std::string, std::string>& snapshot_summary);
};
 
class ICEBERG_EXPORT CommitMetrics {
 public:
  static std::unique_ptr<CommitMetrics> Make(MetricsContext& context);
 
  static std::unique_ptr<CommitMetrics> Noop();
 
  CommitMetricsResult ToResult() const;
 
  std::shared_ptr<Timer> total_duration;
 
  std::shared_ptr<Counter> attempts;
 
 private:
  CommitMetrics() = default;
};
 
struct ICEBERG_EXPORT CommitReport {
  std::string table_name;
  int64_t snapshot_id = kInvalidSnapshotId;
  int64_t sequence_number = kInvalidSequenceNumber;
  std::string operation;
  CommitMetricsResult commit_metrics;
  std::unordered_map<std::string, std::string> metadata;
};
 
}  // namespace iceberg