metrics_context.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 <string_view>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/metrics/counter.h"
#include "iceberg/metrics/timer.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT MetricsContext {
 public:
  virtual ~MetricsContext() = default;
 
  virtual std::shared_ptr<Counter> GetCounter(std::string_view name,
                                              CounterUnit unit) = 0;
 
  std::shared_ptr<Counter> GetCounter(std::string_view name) {
    return GetCounter(name, CounterUnit::kCount);
  }
 
  virtual std::shared_ptr<Timer> GetTimer(std::string_view name, TimerUnit unit) = 0;
 
  std::shared_ptr<Timer> GetTimer(std::string_view name) {
    return GetTimer(name, TimerUnit::kNanoseconds);
  }
 
  static const std::shared_ptr<MetricsContext>& Noop();
 
  static std::unique_ptr<MetricsContext> Default();
};
 
class ICEBERG_EXPORT DefaultMetricsContext : public MetricsContext {
 public:
  using MetricsContext::GetCounter;  // expose the one-arg base overload
  using MetricsContext::GetTimer;    // expose the one-arg base overload
 
  std::shared_ptr<Counter> GetCounter(std::string_view name, CounterUnit unit) override;
 
  std::shared_ptr<Timer> GetTimer(std::string_view name, TimerUnit unit) override;
};
 
}  // namespace iceberg