Add configuration options for Aggregation creation (open-telemetry#1513)

yxue · Dec 5, 2022 · 37783e3 · 37783e3
1 parent bd35f8b
commit 37783e3
Show file tree

Hide file tree

Showing 16 changed files with 182 additions and 54 deletions.
diff --git a/examples/common/metrics_foo_library/foo_library.cc b/examples/common/metrics_foo_library/foo_library.cc
@@ -5,10 +5,12 @@
 #  include "foo_library.h"
 #  include <chrono>
 #  include <map>
+#  include <memory>
 #  include <thread>
 #  include <vector>
 #  include "opentelemetry/context/context.h"
 #  include "opentelemetry/metrics/provider.h"
+#  include "opentelemetry/nostd/shared_ptr.h"
 
 namespace nostd       = opentelemetry::nostd;
 namespace metrics_api = opentelemetry::metrics;
@@ -72,8 +74,8 @@ void foo_library::histogram_example(const std::string &name)
   std::string histogram_name                  = name + "_histogram";
   auto provider                               = metrics_api::Provider::GetMeterProvider();
   nostd::shared_ptr<metrics_api::Meter> meter = provider->GetMeter(name, "1.2.0");
-  auto histogram_counter                      = meter->CreateDoubleHistogram(histogram_name);
-  auto context                                = opentelemetry::context::Context{};
+  auto histogram_counter = meter->CreateDoubleHistogram(histogram_name, "des", "unit");
+  auto context           = opentelemetry::context::Context{};
   while (true)
   {
     double val                                = (rand() % 700) + 1.1;

diff --git a/examples/metrics_simple/metrics_ostream.cc b/examples/metrics_simple/metrics_ostream.cc
@@ -72,8 +72,14 @@ void initMetrics(const std::string &name)
       new metric_sdk::InstrumentSelector(metric_sdk::InstrumentType::kHistogram, histogram_name)};
   std::unique_ptr<metric_sdk::MeterSelector> histogram_meter_selector{
       new metric_sdk::MeterSelector(name, version, schema)};
-  std::unique_ptr<metric_sdk::View> histogram_view{
-      new metric_sdk::View{name, "description", metric_sdk::AggregationType::kHistogram}};
+  std::shared_ptr<opentelemetry::sdk::metrics::AggregationConfig> aggregation_config{
+      new opentelemetry::sdk::metrics::HistogramAggregationConfig<double>};
+  static_cast<opentelemetry::sdk::metrics::HistogramAggregationConfig<double> *>(
+      aggregation_config.get())
+      ->boundaries_ =
+      std::list<double>{0.0, 50.0, 100.0, 250.0, 500.0, 750.0, 1000.0, 2500.0, 5000.0, 10000.0};
+  std::unique_ptr<metric_sdk::View> histogram_view{new metric_sdk::View{
+      name, "description", metric_sdk::AggregationType::kHistogram, aggregation_config}};
   p->AddView(std::move(histogram_instrument_selector), std::move(histogram_meter_selector),
              std::move(histogram_view));
   metrics_api::Provider::SetMeterProvider(provider);

diff --git a/sdk/include/opentelemetry/sdk/metrics/aggregation/aggregation_config.h b/sdk/include/opentelemetry/sdk/metrics/aggregation/aggregation_config.h
@@ -0,0 +1,29 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+#ifndef ENABLE_METRICS_PREVIEW
+#  include <list>
+#  include "opentelemetry/version.h"
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace sdk
+{
+namespace metrics
+{
+class AggregationConfig
+{
+public:
+  virtual ~AggregationConfig() = default;
+};
+
+template <typename T>
+class HistogramAggregationConfig : public AggregationConfig
+{
+public:
+  std::list<T> boundaries_;
+};
+}  // namespace metrics
+}  // namespace sdk
+OPENTELEMETRY_END_NAMESPACE
+
+#endif  // ENABLE_METRICS_PREVIEW
diff --git a/sdk/include/opentelemetry/sdk/metrics/aggregation/default_aggregation.h b/sdk/include/opentelemetry/sdk/metrics/aggregation/default_aggregation.h
@@ -3,12 +3,15 @@
 
 #pragma once
 #ifndef ENABLE_METRICS_PREVIEW
+#  include <memory>
 #  include "opentelemetry/common/spin_lock_mutex.h"
 #  include "opentelemetry/sdk/metrics/aggregation/aggregation.h"
+#  include "opentelemetry/sdk/metrics/aggregation/aggregation_config.h"
 #  include "opentelemetry/sdk/metrics/aggregation/drop_aggregation.h"
 #  include "opentelemetry/sdk/metrics/aggregation/histogram_aggregation.h"
 #  include "opentelemetry/sdk/metrics/aggregation/lastvalue_aggregation.h"
 #  include "opentelemetry/sdk/metrics/aggregation/sum_aggregation.h"
+#  include "opentelemetry/sdk/metrics/data/point_data.h"
 #  include "opentelemetry/sdk/metrics/instruments.h"
 
 #  include <mutex>
@@ -18,11 +21,13 @@ namespace sdk
 {
 namespace metrics
 {
+
 class DefaultAggregation
 {
 public:
   static std::unique_ptr<Aggregation> CreateAggregation(
-      const opentelemetry::sdk::metrics::InstrumentDescriptor &instrument_descriptor)
+      const opentelemetry::sdk::metrics::InstrumentDescriptor &instrument_descriptor,
+      const opentelemetry::sdk::metrics::AggregationConfig *aggregation_config)
   {
     switch (instrument_descriptor.type_)
     {
@@ -34,11 +39,17 @@ class DefaultAggregation
                    ? std::move(std::unique_ptr<Aggregation>(new LongSumAggregation()))
                    : std::move(std::unique_ptr<Aggregation>(new DoubleSumAggregation()));
         break;
-      case InstrumentType::kHistogram:
+      case InstrumentType::kHistogram: {
         return (instrument_descriptor.value_type_ == InstrumentValueType::kLong)
-                   ? std::move(std::unique_ptr<Aggregation>(new LongHistogramAggregation()))
-                   : std::move(std::unique_ptr<Aggregation>(new DoubleHistogramAggregation()));
+                   ? std::move(std::unique_ptr<Aggregation>(new LongHistogramAggregation(
+                         static_cast<
+                             const opentelemetry::sdk::metrics::HistogramAggregationConfig<long> *>(
+                             aggregation_config))))
+                   : std::move(std::unique_ptr<Aggregation>(new DoubleHistogramAggregation(
+                         static_cast<const opentelemetry::sdk::metrics::HistogramAggregationConfig<
+                             double> *>(aggregation_config))));
         break;
+      }
       case InstrumentType::kObservableGauge:
         return (instrument_descriptor.value_type_ == InstrumentValueType::kLong)
                    ? std::move(std::unique_ptr<Aggregation>(new LongLastValueAggregation()))
@@ -88,7 +99,7 @@ class DefaultAggregation
         }
         break;
       default:
-        return DefaultAggregation::CreateAggregation(instrument_descriptor);
+        return DefaultAggregation::CreateAggregation(instrument_descriptor, nullptr);
     }
   }
 
@@ -135,7 +146,7 @@ class DefaultAggregation
               new DoubleSumAggregation(nostd::get<SumPointData>(point_data)));
         }
       default:
-        return DefaultAggregation::CreateAggregation(instrument_descriptor);
+        return DefaultAggregation::CreateAggregation(instrument_descriptor, nullptr);
     }
   }
 };

diff --git a/sdk/include/opentelemetry/sdk/metrics/aggregation/histogram_aggregation.h b/sdk/include/opentelemetry/sdk/metrics/aggregation/histogram_aggregation.h
@@ -5,6 +5,7 @@
 #ifndef ENABLE_METRICS_PREVIEW
 #  include "opentelemetry/common/spin_lock_mutex.h"
 #  include "opentelemetry/sdk/metrics/aggregation/aggregation.h"
+#  include "opentelemetry/sdk/metrics/aggregation/aggregation_config.h"
 
 #  include <mutex>
 
@@ -17,7 +18,7 @@ namespace metrics
 class LongHistogramAggregation : public Aggregation
 {
 public:
-  LongHistogramAggregation();
+  LongHistogramAggregation(const HistogramAggregationConfig<long> *aggregation_config = nullptr);
   LongHistogramAggregation(HistogramPointData &&);
   LongHistogramAggregation(const HistogramPointData &);
 
@@ -46,7 +47,8 @@ class LongHistogramAggregation : public Aggregation
 class DoubleHistogramAggregation : public Aggregation
 {
 public:
-  DoubleHistogramAggregation();
+  DoubleHistogramAggregation(
+      const HistogramAggregationConfig<double> *aggregation_config = nullptr);
   DoubleHistogramAggregation(HistogramPointData &&);
   DoubleHistogramAggregation(const HistogramPointData &);
 

diff --git a/sdk/include/opentelemetry/sdk/metrics/meter.h b/sdk/include/opentelemetry/sdk/metrics/meter.h
@@ -148,9 +148,9 @@ class Meter final : public opentelemetry::metrics::Meter
           {
             view_instr_desc.description_ = view.GetDescription();
           }
-          auto storage = std::shared_ptr<AsyncMetricStorage<T>>(
-              new AsyncMetricStorage<T>(view_instr_desc, view.GetAggregationType(), callback,
-                                        &view.GetAttributesProcessor(), state));
+          auto storage = std::shared_ptr<AsyncMetricStorage<T>>(new AsyncMetricStorage<T>(
+              view_instr_desc, view.GetAggregationType(), callback, &view.GetAttributesProcessor(),
+              view.GetAggregationConfig(), state));
           storage_registry_[instrument_descriptor.name_] = storage;
           return true;
         });

diff --git a/sdk/include/opentelemetry/sdk/metrics/state/async_metric_storage.h b/sdk/include/opentelemetry/sdk/metrics/state/async_metric_storage.h
@@ -3,6 +3,7 @@
 
 #pragma once
 #ifndef ENABLE_METRICS_PREVIEW
+#  include "opentelemetry/nostd/shared_ptr.h"
 #  include "opentelemetry/sdk/common/attributemap_hash.h"
 #  include "opentelemetry/sdk/metrics/aggregation/default_aggregation.h"
 #  include "opentelemetry/sdk/metrics/instruments.h"
@@ -30,14 +31,15 @@ class AsyncMetricStorage : public MetricStorage
                      void (*measurement_callback)(opentelemetry::metrics::ObserverResult<T> &,
                                                   void *),
                      const AttributesProcessor *attributes_processor,
+                     nostd::shared_ptr<AggregationConfig> aggregation_config,
                      void *state = nullptr)
       : instrument_descriptor_(instrument_descriptor),
         aggregation_type_{aggregation_type},
         measurement_collection_callback_{measurement_callback},
         attributes_processor_{attributes_processor},
         state_{state},
         cumulative_hash_map_(new AttributesHashMap()),
-        temporal_metric_storage_(instrument_descriptor)
+        temporal_metric_storage_(instrument_descriptor, aggregation_config)
   {}
 
   bool Collect(CollectorHandle *collector,

diff --git a/sdk/include/opentelemetry/sdk/metrics/state/sync_metric_storage.h b/sdk/include/opentelemetry/sdk/metrics/state/sync_metric_storage.h
@@ -3,6 +3,7 @@
 
 #pragma once
 #ifndef ENABLE_METRICS_PREVIEW
+#  include <utility>
 #  include "opentelemetry/common/key_value_iterable_view.h"
 #  include "opentelemetry/sdk/common/attributemap_hash.h"
 #  include "opentelemetry/sdk/metrics/aggregation/default_aggregation.h"
@@ -29,13 +30,14 @@ class SyncMetricStorage : public MetricStorage, public WritableMetricStorage
   SyncMetricStorage(InstrumentDescriptor instrument_descriptor,
                     const AggregationType aggregation_type,
                     const AttributesProcessor *attributes_processor,
-                    nostd::shared_ptr<ExemplarReservoir> &&exemplar_reservoir)
+                    nostd::shared_ptr<ExemplarReservoir> &&exemplar_reservoir,
+                    nostd::shared_ptr<AggregationConfig> aggregation_config)
       : instrument_descriptor_(instrument_descriptor),
         aggregation_type_{aggregation_type},
         attributes_hashmap_(new AttributesHashMap()),
         attributes_processor_{attributes_processor},
         exemplar_reservoir_(exemplar_reservoir),
-        temporal_metric_storage_(instrument_descriptor)
+        temporal_metric_storage_(instrument_descriptor, aggregation_config)
 
   {
     create_default_aggregation_ = [&]() -> std::unique_ptr<Aggregation> {

diff --git a/sdk/include/opentelemetry/sdk/metrics/state/temporal_metric_storage.h b/sdk/include/opentelemetry/sdk/metrics/state/temporal_metric_storage.h
@@ -3,6 +3,8 @@
 
 #pragma once
 #ifndef ENABLE_METRICS_PREVIEW
+#  include "opentelemetry/nostd/shared_ptr.h"
+#  include "opentelemetry/sdk/metrics/aggregation/default_aggregation.h"
 #  include "opentelemetry/sdk/metrics/state/attributes_hashmap.h"
 #  include "opentelemetry/sdk/metrics/state/metric_collector.h"
 
@@ -23,7 +25,8 @@ struct LastReportedMetrics
 class TemporalMetricStorage
 {
 public:
-  TemporalMetricStorage(InstrumentDescriptor instrument_descriptor);
+  TemporalMetricStorage(InstrumentDescriptor instrument_descriptor,
+                        nostd::shared_ptr<AggregationConfig> aggregation_config);
 
   bool buildMetrics(CollectorHandle *collector,
                     nostd::span<std::shared_ptr<CollectorHandle>> collectors,
@@ -43,6 +46,7 @@ class TemporalMetricStorage
 
   // Lock while building metrics
   mutable opentelemetry::common::SpinLockMutex lock_;
+  const nostd::shared_ptr<AggregationConfig> aggregation_config_;
 };
 }  // namespace metrics
 }  // namespace sdk

diff --git a/sdk/include/opentelemetry/sdk/metrics/view/view.h b/sdk/include/opentelemetry/sdk/metrics/view/view.h
@@ -3,7 +3,9 @@
 
 #pragma once
 #ifndef ENABLE_METRICS_PREVIEW
+#  include "opentelemetry/nostd/shared_ptr.h"
 #  include "opentelemetry/nostd/string_view.h"
+#  include "opentelemetry/sdk/metrics/aggregation/aggregation_config.h"
 #  include "opentelemetry/sdk/metrics/aggregation/default_aggregation.h"
 #  include "opentelemetry/sdk/metrics/instruments.h"
 #  include "opentelemetry/sdk/metrics/view/attributes_processor.h"
@@ -22,14 +24,16 @@ class View
 {
 public:
   View(const std::string &name,
-       const std::string &description   = "",
-       AggregationType aggregation_type = AggregationType::kDefault,
+       const std::string &description                        = "",
+       AggregationType aggregation_type                      = AggregationType::kDefault,
+       std::shared_ptr<AggregationConfig> aggregation_config = std::shared_ptr<AggregationConfig>{},
        std::unique_ptr<opentelemetry::sdk::metrics::AttributesProcessor> attributes_processor =
            std::unique_ptr<opentelemetry::sdk::metrics::AttributesProcessor>(
                new opentelemetry::sdk::metrics::DefaultAttributesProcessor()))
       : name_(name),
         description_(description),
         aggregation_type_{aggregation_type},
+        aggregation_config_{aggregation_config},
         attributes_processor_{std::move(attributes_processor)}
   {}
 
@@ -39,6 +43,11 @@ class View
 
   virtual AggregationType GetAggregationType() const noexcept { return aggregation_type_; }
 
+  virtual nostd::shared_ptr<AggregationConfig> GetAggregationConfig() const noexcept
+  {
+    return aggregation_config_;
+  }
+
   virtual const opentelemetry::sdk::metrics::AttributesProcessor &GetAttributesProcessor()
       const noexcept
   {
@@ -49,6 +58,7 @@ class View
   std::string name_;
   std::string description_;
   AggregationType aggregation_type_;
+  nostd::shared_ptr<AggregationConfig> aggregation_config_;
   std::unique_ptr<opentelemetry::sdk::metrics::AttributesProcessor> attributes_processor_;
 };
 }  // namespace metrics

diff --git a/sdk/src/metrics/aggregation/histogram_aggregation.cc b/sdk/src/metrics/aggregation/histogram_aggregation.cc
@@ -12,9 +12,17 @@ namespace sdk
 namespace metrics
 {
 
-LongHistogramAggregation::LongHistogramAggregation()
+LongHistogramAggregation::LongHistogramAggregation(
+    const HistogramAggregationConfig<long> *aggregation_config)
 {
-  point_data_.boundaries_ = std::list<long>{0l, 5l, 10l, 25l, 50l, 75l, 100l, 250l, 500l, 1000l};
+  if (aggregation_config && aggregation_config->boundaries_.size())
+  {
+    point_data_.boundaries_ = aggregation_config->boundaries_;
+  }
+  else
+  {
+    point_data_.boundaries_ = std::list<long>{0l, 5l, 10l, 25l, 50l, 75l, 100l, 250l, 500l, 1000l};
+  }
   point_data_.counts_ =
       std::vector<uint64_t>(nostd::get<std::list<long>>(point_data_.boundaries_).size() + 1, 0);
   point_data_.sum_   = 0l;
@@ -73,10 +81,18 @@ PointType LongHistogramAggregation::ToPoint() const noexcept
   return point_data_;
 }
 
-DoubleHistogramAggregation::DoubleHistogramAggregation()
+DoubleHistogramAggregation::DoubleHistogramAggregation(
+    const HistogramAggregationConfig<double> *aggregation_config)
 {
-  point_data_.boundaries_ =
-      std::list<double>{0.0, 5.0, 10.0, 25.0, 50.0, 75.0, 100.0, 250.0, 500.0, 1000.0};
+  if (aggregation_config && aggregation_config->boundaries_.size())
+  {
+    point_data_.boundaries_ = aggregation_config->boundaries_;
+  }
+  else
+  {
+    point_data_.boundaries_ =
+        std::list<double>{0.0, 5.0, 10.0, 25.0, 50.0, 75.0, 100.0, 250.0, 500.0, 1000.0};
+  }
   point_data_.counts_ =
       std::vector<uint64_t>(nostd::get<std::list<double>>(point_data_.boundaries_).size() + 1, 0);
   point_data_.sum_   = 0.0;

diff --git a/sdk/src/metrics/meter.cc b/sdk/src/metrics/meter.cc
@@ -217,7 +217,7 @@ std::unique_ptr<WritableMetricStorage> Meter::RegisterMetricStorage(
         }
         auto storage = std::shared_ptr<SyncMetricStorage>(new SyncMetricStorage(
             view_instr_desc, view.GetAggregationType(), &view.GetAttributesProcessor(),
-            NoExemplarReservoir::GetNoExemplarReservoir()));
+            NoExemplarReservoir::GetNoExemplarReservoir(), view.GetAggregationConfig()));
         storage_registry_[instrument_descriptor.name_] = storage;
         auto multi_storage = static_cast<MultiMetricStorage *>(storages.get());
         multi_storage->AddStorage(storage);