[Metrics SDK] Add unit to Instrument selection criteria (open-telemet…

…ry#2236)
Troels51 · Jul 20, 2023 · a15a9b8 · a15a9b8
1 parent 2974eb8
commit a15a9b8
Show file tree

Hide file tree

Showing 15 changed files with 100 additions and 45 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,14 @@ Increment the:
 
 ## [Unreleased]
 
+Breaking changes:
+
+* [SDK] Add unit to Instrument selection criteria
+  [#2236](https://github.com/open-telemetry/opentelemetry-cpp/pull/2236)
+  * The `View` constructor and `ViewFactory::Create` method now takes a
+   `unit` criteria as optional third argument.
+  * Please adjust SDK configuration code accordingly.
+
 ## [1.10.0] 2023-07-11
 
 * [REMOVAL] Remove the jaeger exporter

diff --git a/examples/metrics_simple/metrics_ostream.cc b/examples/metrics_simple/metrics_ostream.cc
@@ -53,36 +53,38 @@ void InitMetrics(const std::string &name)
 
   // counter view
   std::string counter_name = name + "_counter";
+  std::string unit         = "counter-unit";
 
   auto instrument_selector = metrics_sdk::InstrumentSelectorFactory::Create(
-      metrics_sdk::InstrumentType::kCounter, counter_name);
+      metrics_sdk::InstrumentType::kCounter, counter_name, unit);
 
   auto meter_selector = metrics_sdk::MeterSelectorFactory::Create(name, version, schema);
 
-  auto sum_view =
-      metrics_sdk::ViewFactory::Create(name, "description", metrics_sdk::AggregationType::kSum);
+  auto sum_view = metrics_sdk::ViewFactory::Create(name, "description", unit,
+                                                   metrics_sdk::AggregationType::kSum);
 
   p->AddView(std::move(instrument_selector), std::move(meter_selector), std::move(sum_view));
 
   // observable counter view
   std::string observable_counter_name = name + "_observable_counter";
 
   auto observable_instrument_selector = metrics_sdk::InstrumentSelectorFactory::Create(
-      metrics_sdk::InstrumentType::kObservableCounter, observable_counter_name);
+      metrics_sdk::InstrumentType::kObservableCounter, observable_counter_name, unit);
 
   auto observable_meter_selector = metrics_sdk::MeterSelectorFactory::Create(name, version, schema);
 
-  auto observable_sum_view = metrics_sdk::ViewFactory::Create(name, "test_description",
+  auto observable_sum_view = metrics_sdk::ViewFactory::Create(name, "test_description", unit,
                                                               metrics_sdk::AggregationType::kSum);
 
   p->AddView(std::move(observable_instrument_selector), std::move(observable_meter_selector),
              std::move(observable_sum_view));
 
   // histogram view
   std::string histogram_name = name + "_histogram";
+  unit                       = "histogram-unit";
 
   auto histogram_instrument_selector = metrics_sdk::InstrumentSelectorFactory::Create(
-      metrics_sdk::InstrumentType::kHistogram, histogram_name);
+      metrics_sdk::InstrumentType::kHistogram, histogram_name, unit);
 
   auto histogram_meter_selector = metrics_sdk::MeterSelectorFactory::Create(name, version, schema);
 
@@ -96,7 +98,7 @@ void InitMetrics(const std::string &name)
       std::move(histogram_aggregation_config));
 
   auto histogram_view = metrics_sdk::ViewFactory::Create(
-      name, "description", metrics_sdk::AggregationType::kHistogram, aggregation_config);
+      name, "description", unit, metrics_sdk::AggregationType::kHistogram, aggregation_config);
 
   p->AddView(std::move(histogram_instrument_selector), std::move(histogram_meter_selector),
              std::move(histogram_view));

diff --git a/examples/prometheus/main.cc b/examples/prometheus/main.cc
@@ -52,27 +52,29 @@ void InitMetrics(const std::string &name, const std::string &addr)
 
   // counter view
   std::string counter_name = name + "_counter";
+  std::string counter_unit = "unit";
 
   auto instrument_selector = metrics_sdk::InstrumentSelectorFactory::Create(
-      metrics_sdk::InstrumentType::kCounter, counter_name);
+      metrics_sdk::InstrumentType::kCounter, counter_name, counter_unit);
 
   auto meter_selector = metrics_sdk::MeterSelectorFactory::Create(name, version, schema);
 
-  auto sum_view = metrics_sdk::ViewFactory::Create(counter_name, "description",
+  auto sum_view = metrics_sdk::ViewFactory::Create(counter_name, "description", counter_unit,
                                                    metrics_sdk::AggregationType::kSum);
 
   p->AddView(std::move(instrument_selector), std::move(meter_selector), std::move(sum_view));
 
   // histogram view
   std::string histogram_name = name + "_histogram";
+  std::string histogram_unit = "unit";
 
   auto histogram_instrument_selector = metrics_sdk::InstrumentSelectorFactory::Create(
-      metrics_sdk::InstrumentType::kHistogram, histogram_name);
+      metrics_sdk::InstrumentType::kHistogram, histogram_name, histogram_unit);
 
   auto histogram_meter_selector = metrics_sdk::MeterSelectorFactory::Create(name, version, schema);
 
-  auto histogram_view = metrics_sdk::ViewFactory::Create(histogram_name, "description",
-                                                         metrics_sdk::AggregationType::kHistogram);
+  auto histogram_view = metrics_sdk::ViewFactory::Create(
+      histogram_name, "description", histogram_unit, metrics_sdk::AggregationType::kHistogram);
 
   p->AddView(std::move(histogram_instrument_selector), std::move(histogram_meter_selector),
              std::move(histogram_view));

diff --git a/sdk/include/opentelemetry/sdk/metrics/view/instrument_selector.h b/sdk/include/opentelemetry/sdk/metrics/view/instrument_selector.h
@@ -19,19 +19,23 @@ class InstrumentSelector
 {
 public:
   InstrumentSelector(opentelemetry::sdk::metrics::InstrumentType instrument_type,
-                     opentelemetry::nostd::string_view name)
+                     opentelemetry::nostd::string_view name,
+                     opentelemetry::nostd::string_view units)
       : name_filter_{PredicateFactory::GetPredicate(name, PredicateType::kPattern)},
+        unit_filter_{PredicateFactory::GetPredicate(units, PredicateType::kExact)},
         instrument_type_{instrument_type}
   {}
 
   // Returns name filter predicate. This shouldn't be deleted
   const opentelemetry::sdk::metrics::Predicate *GetNameFilter() const { return name_filter_.get(); }
-
+  // Returns unit filter predicate. This shouldn't be deleted
+  const opentelemetry::sdk::metrics::Predicate *GetUnitFilter() const { return unit_filter_.get(); }
   // Returns instrument filter.
   InstrumentType GetInstrumentType() { return instrument_type_; }
 
 private:
   std::unique_ptr<opentelemetry::sdk::metrics::Predicate> name_filter_;
+  std::unique_ptr<opentelemetry::sdk::metrics::Predicate> unit_filter_;
   opentelemetry::sdk::metrics::InstrumentType instrument_type_;
 };
 }  // namespace metrics

diff --git a/sdk/include/opentelemetry/sdk/metrics/view/instrument_selector_factory.h b/sdk/include/opentelemetry/sdk/metrics/view/instrument_selector_factory.h
@@ -19,7 +19,8 @@ class InstrumentSelectorFactory
 public:
   static std::unique_ptr<InstrumentSelector> Create(
       opentelemetry::sdk::metrics::InstrumentType instrument_type,
-      opentelemetry::nostd::string_view name);
+      opentelemetry::nostd::string_view name,
+      opentelemetry::nostd::string_view unit);
 };
 
 }  // namespace metrics

diff --git a/sdk/include/opentelemetry/sdk/metrics/view/view.h b/sdk/include/opentelemetry/sdk/metrics/view/view.h
@@ -26,13 +26,15 @@ class View
 public:
   View(const std::string &name,
        const std::string &description                        = "",
+       const std::string &unit                               = "",
        AggregationType aggregation_type                      = AggregationType::kDefault,
        std::shared_ptr<AggregationConfig> aggregation_config = nullptr,
        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),
+        unit_(unit),
         aggregation_type_{aggregation_type},
         aggregation_config_{aggregation_config},
         attributes_processor_{std::move(attributes_processor)}
@@ -60,6 +62,7 @@ class View
 private:
   std::string name_;
   std::string description_;
+  std::string unit_;
   AggregationType aggregation_type_;
   std::shared_ptr<AggregationConfig> aggregation_config_;
   std::unique_ptr<opentelemetry::sdk::metrics::AttributesProcessor> attributes_processor_;

diff --git a/sdk/include/opentelemetry/sdk/metrics/view/view_factory.h b/sdk/include/opentelemetry/sdk/metrics/view/view_factory.h
@@ -30,15 +30,22 @@ class OPENTELEMETRY_EXPORT ViewFactory
 
   static std::unique_ptr<View> Create(const std::string &name,
                                       const std::string &description,
+                                      const std::string &unit);
+
+  static std::unique_ptr<View> Create(const std::string &name,
+                                      const std::string &description,
+                                      const std::string &unit,
                                       AggregationType aggregation_type);
 
   static std::unique_ptr<View> Create(const std::string &name,
                                       const std::string &description,
+                                      const std::string &unit,
                                       AggregationType aggregation_type,
                                       std::shared_ptr<AggregationConfig> aggregation_config);
 
   static std::unique_ptr<View> Create(const std::string &name,
                                       const std::string &description,
+                                      const std::string &unit,
                                       AggregationType aggregation_type,
                                       std::shared_ptr<AggregationConfig> aggregation_config,
                                       std::unique_ptr<AttributesProcessor> attributes_processor);

diff --git a/sdk/include/opentelemetry/sdk/metrics/view/view_registry.h b/sdk/include/opentelemetry/sdk/metrics/view/view_registry.h
@@ -99,6 +99,7 @@ class ViewRegistry
       const opentelemetry::sdk::metrics::InstrumentDescriptor &instrument_descriptor)
   {
     return selector->GetNameFilter()->Match(instrument_descriptor.name_) &&
+           selector->GetUnitFilter()->Match(instrument_descriptor.unit_) &&
            (selector->GetInstrumentType() == instrument_descriptor.type_);
   }
 };

diff --git a/sdk/src/metrics/view/instrument_selector_factory.cc b/sdk/src/metrics/view/instrument_selector_factory.cc
@@ -13,10 +13,11 @@ namespace metrics
 
 std::unique_ptr<InstrumentSelector> InstrumentSelectorFactory::Create(
     opentelemetry::sdk::metrics::InstrumentType instrument_type,
-    opentelemetry::nostd::string_view name)
+    opentelemetry::nostd::string_view name,
+    opentelemetry::nostd::string_view unit)
 {
   std::unique_ptr<InstrumentSelector> instrument_selector(
-      new InstrumentSelector(instrument_type, name));
+      new InstrumentSelector(instrument_type, name, unit));
   return instrument_selector;
 }
 

diff --git a/sdk/src/metrics/view/view_factory.cc b/sdk/src/metrics/view/view_factory.cc
@@ -18,36 +18,46 @@ std::unique_ptr<View> ViewFactory::Create(const std::string &name)
 
 std::unique_ptr<View> ViewFactory::Create(const std::string &name, const std::string &description)
 {
-  return Create(name, description, AggregationType::kDefault);
+  return Create(name, description, "", AggregationType::kDefault);
 }
 
 std::unique_ptr<View> ViewFactory::Create(const std::string &name,
                                           const std::string &description,
+                                          const std::string &unit)
+{
+  return Create(name, description, unit, AggregationType::kDefault);
+}
+
+std::unique_ptr<View> ViewFactory::Create(const std::string &name,
+                                          const std::string &description,
+                                          const std::string &unit,
                                           AggregationType aggregation_type)
 {
   std::shared_ptr<AggregationConfig> aggregation_config(nullptr);
-  return Create(name, description, aggregation_type, aggregation_config);
+  return Create(name, description, unit, aggregation_type, aggregation_config);
 }
 
 std::unique_ptr<View> ViewFactory::Create(const std::string &name,
                                           const std::string &description,
+                                          const std::string &unit,
                                           AggregationType aggregation_type,
                                           std::shared_ptr<AggregationConfig> aggregation_config)
 {
   auto attributes_processor =
       std::unique_ptr<AttributesProcessor>(new DefaultAttributesProcessor());
 
-  return Create(name, description, aggregation_type, aggregation_config,
+  return Create(name, description, unit, aggregation_type, aggregation_config,
                 std::move(attributes_processor));
 }
 
 std::unique_ptr<View> ViewFactory::Create(const std::string &name,
                                           const std::string &description,
+                                          const std::string &unit,
                                           AggregationType aggregation_type,
                                           std::shared_ptr<AggregationConfig> aggregation_config,
                                           std::unique_ptr<AttributesProcessor> attributes_processor)
 {
-  std::unique_ptr<View> view(new View(name, description, aggregation_type, aggregation_config,
+  std::unique_ptr<View> view(new View(name, description, unit, aggregation_type, aggregation_config,
                                       std::move(attributes_processor)));
   return view;
 }

diff --git a/sdk/test/metrics/histogram_aggregation_test.cc b/sdk/test/metrics/histogram_aggregation_test.cc
@@ -72,13 +72,14 @@ TEST(CounterToHistogram, Double)
   std::shared_ptr<MetricReader> reader{new MockMetricReader(std::move(exporter))};
   mp.AddMetricReader(reader);
 
-  std::unique_ptr<View> view{new View("view1", "view1_description", AggregationType::kHistogram)};
+  std::unique_ptr<View> view{
+      new View("view1", "view1_description", "unit", AggregationType::kHistogram)};
   std::unique_ptr<InstrumentSelector> instrument_selector{
-      new InstrumentSelector(InstrumentType::kCounter, "counter1")};
+      new InstrumentSelector(InstrumentType::kCounter, "counter1", "unit")};
   std::unique_ptr<MeterSelector> meter_selector{new MeterSelector("meter1", "version1", "schema1")};
   mp.AddView(std::move(instrument_selector), std::move(meter_selector), std::move(view));
 
-  auto h = m->CreateDoubleCounter("counter1", "counter1_description", "counter1_unit");
+  auto h = m->CreateDoubleCounter("counter1", "counter1_description", "unit");
 
   h->Add(5, {});
   h->Add(10, {});

diff --git a/sdk/test/metrics/histogram_test.cc b/sdk/test/metrics/histogram_test.cc
@@ -78,7 +78,10 @@ TEST(Histogram, Double)
 TEST(Histogram, DoubleCustomBuckets)
 {
   MeterProvider mp;
-  auto m = mp.GetMeter("meter1", "version1", "schema1");
+  auto m                      = mp.GetMeter("meter1", "version1", "schema1");
+  std::string instrument_unit = "ms";
+  std::string instrument_name = "historgram1";
+  std::string instrument_desc = "histogram metrics";
 
   std::unique_ptr<MockMetricExporter> exporter(new MockMetricExporter());
   std::shared_ptr<MetricReader> reader{new MockMetricReader(std::move(exporter))};
@@ -87,13 +90,13 @@ TEST(Histogram, DoubleCustomBuckets)
   std::shared_ptr<HistogramAggregationConfig> config(new HistogramAggregationConfig());
   config->boundaries_ = {10, 20, 30, 40};
   std::unique_ptr<View> view{
-      new View("view1", "view1_description", AggregationType::kHistogram, config)};
+      new View("view1", "view1_description", instrument_unit, AggregationType::kHistogram, config)};
   std::unique_ptr<InstrumentSelector> instrument_selector{
-      new InstrumentSelector(InstrumentType::kHistogram, "histogram1")};
+      new InstrumentSelector(InstrumentType::kHistogram, instrument_name, instrument_unit)};
   std::unique_ptr<MeterSelector> meter_selector{new MeterSelector("meter1", "version1", "schema1")};
   mp.AddView(std::move(instrument_selector), std::move(meter_selector), std::move(view));
 
-  auto h = m->CreateDoubleHistogram("histogram1", "histogram1_description", "histogram1_unit");
+  auto h = m->CreateDoubleHistogram(instrument_name, instrument_desc, instrument_unit);
 
   h->Record(5, {});
   h->Record(10, {});
@@ -190,7 +193,10 @@ TEST(Histogram, UInt64)
 TEST(Histogram, UInt64CustomBuckets)
 {
   MeterProvider mp;
-  auto m = mp.GetMeter("meter1", "version1", "schema1");
+  auto m                      = mp.GetMeter("meter1", "version1", "schema1");
+  std::string instrument_name = "historgram1";
+  std::string instrument_desc = "histogram metrics";
+  std::string instrument_unit = "ms";
 
   std::unique_ptr<MockMetricExporter> exporter(new MockMetricExporter());
   std::shared_ptr<MetricReader> reader{new MockMetricReader(std::move(exporter))};
@@ -199,13 +205,13 @@ TEST(Histogram, UInt64CustomBuckets)
   std::shared_ptr<HistogramAggregationConfig> config(new HistogramAggregationConfig());
   config->boundaries_ = {10, 20, 30, 40};
   std::unique_ptr<View> view{
-      new View("view1", "view1_description", AggregationType::kHistogram, config)};
+      new View("view1", "view1_description", "ms", AggregationType::kHistogram, config)};
   std::unique_ptr<InstrumentSelector> instrument_selector{
-      new InstrumentSelector(InstrumentType::kHistogram, "histogram1")};
+      new InstrumentSelector(InstrumentType::kHistogram, instrument_name, instrument_unit)};
   std::unique_ptr<MeterSelector> meter_selector{new MeterSelector("meter1", "version1", "schema1")};
   mp.AddView(std::move(instrument_selector), std::move(meter_selector), std::move(view));
 
-  auto h = m->CreateUInt64Histogram("histogram1", "histogram1_description", "histogram1_unit");
+  auto h = m->CreateUInt64Histogram(instrument_name, instrument_desc, instrument_unit);
 
   h->Record(5, {});
   h->Record(10, {});

diff --git a/sdk/test/metrics/meter_provider_sdk_test.cc b/sdk/test/metrics/meter_provider_sdk_test.cc
@@ -49,7 +49,7 @@ TEST(MeterProvider, GetMeter)
 
   std::unique_ptr<View> view{std::unique_ptr<View>()};
   std::unique_ptr<InstrumentSelector> instrument_selector{
-      new InstrumentSelector(InstrumentType::kCounter, "instru1")};
+      new InstrumentSelector(InstrumentType::kCounter, "instru1", "unit1")};
   std::unique_ptr<MeterSelector> meter_selector{new MeterSelector("name1", "version1", "schema1")};
 
   mp1.AddView(std::move(instrument_selector), std::move(meter_selector), std::move(view));