Program Listing for File metric_reader.h

↰ Return to documentation for file (/tmp/B.puc0r6hi/BUILD/opentelemetry-cpp-1.27.0-build/opentelemetry-cpp-1.27.0/sdk/include/opentelemetry/sdk/metrics/metric_reader.h)

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

#pragma once

#include <atomic>
#include <chrono>

#include "opentelemetry/nostd/function_ref.h"
#include "opentelemetry/sdk/metrics/export/metric_producer.h"
#include "opentelemetry/sdk/metrics/instruments.h"
#include "opentelemetry/version.h"

OPENTELEMETRY_BEGIN_NAMESPACE
namespace sdk
{
namespace metrics
{
class MetricReader
{
public:
  MetricReader()                                = default;
  MetricReader(const MetricReader &)            = delete;
  MetricReader(MetricReader &&)                 = delete;
  MetricReader &operator=(const MetricReader &) = delete;
  MetricReader &operator=(MetricReader &&)      = delete;

  void SetMetricProducer(MetricProducer *metric_producer);

  bool Collect(nostd::function_ref<bool(ResourceMetrics &metric_data)> callback) noexcept;

  virtual AggregationTemporality GetAggregationTemporality(
      InstrumentType instrument_type) const noexcept = 0;

  bool Shutdown(std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept;

  bool ForceFlush(std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept;

  bool IsShutdown() const noexcept;

  virtual ~MetricReader() = default;

private:
  virtual bool OnForceFlush(std::chrono::microseconds timeout) noexcept = 0;

  virtual bool OnShutDown(std::chrono::microseconds timeout) noexcept = 0;

  virtual void OnInitialized() noexcept {}

protected:
private:
  MetricProducer *metric_producer_{nullptr};
  std::atomic<bool> shutdown_{false};
};
}  // namespace metrics
}  // namespace sdk
OPENTELEMETRY_END_NAMESPACE