Program Listing for File simple_fixed_size_exemplar_reservoir.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/exemplar/simple_fixed_size_exemplar_reservoir.h)

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

#pragma once

#ifdef ENABLE_METRICS_EXEMPLAR_PREVIEW

#  include <memory>
#  include <vector>

#  include "opentelemetry/sdk/metrics/data/exemplar_data.h"
#  include "opentelemetry/sdk/metrics/exemplar/filter_type.h"
#  include "opentelemetry/sdk/metrics/exemplar/fixed_size_exemplar_reservoir.h"
#  include "opentelemetry/sdk/metrics/exemplar/reservoir.h"
#  include "opentelemetry/sdk/metrics/exemplar/reservoir_cell_selector.h"
#  include "opentelemetry/version.h"
#  include "src/common/random.h"

OPENTELEMETRY_BEGIN_NAMESPACE
namespace context
{
class Context;
}  // namespace context

namespace sdk
{
namespace metrics
{

class SimpleFixedSizeExemplarReservoir : public FixedSizeExemplarReservoir
{
public:
  static const size_t kDefaultSimpleReservoirSize = 1;

  static std::shared_ptr<ReservoirCellSelector> GetSimpleFixedSizeCellSelector(
      size_t size = kDefaultSimpleReservoirSize)
  {
    return std::shared_ptr<ReservoirCellSelector>{new SimpleFixedSizeCellSelector{size}};
  }

  SimpleFixedSizeExemplarReservoir(
      size_t size,
      const std::shared_ptr<ReservoirCellSelector> &reservoir_cell_selector,
      MapAndResetCellType map_and_reset_cell)
      : FixedSizeExemplarReservoir(size, reservoir_cell_selector, map_and_reset_cell)
  {}

  class SimpleFixedSizeCellSelector : public ReservoirCellSelector
  {
  public:
    SimpleFixedSizeCellSelector(size_t size) : size_(size) {}

    int ReservoirCellIndexFor(const std::vector<ReservoirCell> &cells,
                              int64_t value,
                              const MetricAttributes &attributes,
                              const opentelemetry::context::Context &context) override
    {
      return ReservoirCellIndexFor(cells, static_cast<double>(value), attributes, context);
    }

    int ReservoirCellIndexFor(const std::vector<ReservoirCell> & /* cells */,
                              double /* value */,
                              const MetricAttributes & /* attributes */,
                              const opentelemetry::context::Context & /* context */) override
    {
      //
      // The simple reservoir sampling algorithm from the spec below is used.
      // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#simplefixedsizeexemplarreservoir
      //

      size_t measurement_num = measurements_seen_++;
      size_t index           = static_cast<size_t>(-1);

      if (measurement_num < size_)
      {
        index = measurement_num;
      }
      else
      {
        size_t random_index = sdk::common::Random::GenerateRandom64() % measurement_num;

        if (random_index < size_)
        {
          index = random_index;
        }
      }

      return static_cast<int>(index);
    }

    void reset() override {}

  private:
    size_t measurements_seen_ = 0;
    size_t size_;
  };  // class SimpleFixedSizeCellSelector

};  // class SimpleFixedSizeExemplarReservoir

}  // namespace metrics
}  // namespace sdk
OPENTELEMETRY_END_NAMESPACE

#endif  // ENABLE_METRICS_EXEMPLAR_PREVIEW