Metrics API : Provider , MeterProvider, Meter, SynchronousInstrument

CMakeLists.txt

@@ -165,6 +165,8 @@ option(WITH_NO_GETENV "Whether the platform supports environment variables" OFF)
 
 option(BUILD_TESTING "Whether to enable tests" ON)
 
+option(BUILD_PACKAGE "Whether to build rpm/deb package" OFF)
+
 if(WITH_NO_GENENV)
   add_definitions(-DNO_GETENV)
 endif()
@@ -412,3 +414,22 @@ install(
   EXPORT "${PROJECT_NAME}-target"
   NAMESPACE "${PROJECT_NAME}::"
   DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}")
+
+if(BUILD_PACKAGE AND UNIX)
+  execute_process(
+    COMMAND lsb_release -si
+    OUTPUT_VARIABLE distribution
+    OUTPUT_STRIP_TRAILING_WHITESPACE)
+  if(distribution STREQUAL "Debian" OR distribution STREQUAL "Ubuntu")
+    set(INSTALL_LIB_DIR
+        ${CMAKE_INSTALL_PREFIX}/lib/${CPACK_DEBIAN_ARCHITECTURE}-linux-gnu)
+    include(cmake/MakeDeb.cmake)
+  elseif(
+    distribution MATCHES "RedHat.*"
+    OR distribution MATCHES "openSUSE.*"
+    OR distribution STREQUAL "Fedora")
+    set(INSTALL_LIB_DIR
+        ${CMAKE_INSTALL_PREFIX}/lib/${CMAKE_SYSTEM_PROCESSOR}-linux-gnu)
+    include(cmake/MakeRpm.cmake)
+  endif()
+endif()

api/include/opentelemetry/metrics_new/async_instruments.h

@@ -0,0 +1,30 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+#ifdef ENABLE_METRICS_PREVIEW
+
+#  include "instrument.h"
+#  include "observer_result.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace metrics_new
+{
+class AsynchronousInstrument
+{};
+
+template <class T>
+class ObservableCounter : public AsynchronousInstrument
+{};
+
+template <class T>
+class ObservableGauge : public AsynchronousInstrument
+{};
+
+template <class T>
+class ObservableUpDownCounter : public AsynchronousInstrument
+{};
+
+}  // namespace metrics_new
+OPENTELEMETRY_END_NAMESPACE
+#endif

api/include/opentelemetry/metrics_new/meter.h

@@ -0,0 +1,252 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+#ifdef ENABLE_METRICS_PREVIEW
+
+#  include "opentelemetry/metrics_new/async_instruments.h"
+#  include "opentelemetry/metrics_new/instrument.h"
+#  include "opentelemetry/metrics_new/sync_instruments.h"
+#  include "opentelemetry/nostd/shared_ptr.h"
+#  include "opentelemetry/nostd/span.h"
+#  include "opentelemetry/nostd/string_view.h"
+#  include "opentelemetry/version.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace metrics_new
+{
+/**
+ * Handles instrument creation and provides a facility for batch recording.
+ *
+ * This class provides methods to create new metric instruments, record a
+ * batch of values to a specified set of instruments, and collect
+ * measurements from all instruments.
+ *
+ */
+class Meter
+{
+public:
+  virtual ~Meter() = default;
+
+  /**
+   * Creates a Counter with the passed characteristics and returns a shared_ptr to that Counter.
+   *
+   * @param name the name of the new Counter.
+   * @param description a brief description of what the Counter is used for.
+   * @param unit the unit of metric values following https://unitsofmeasure.org/ucum.html.
+   * @param enabled a boolean value that turns on or off the metric instrument.
+   * @return a shared pointer to the created Counter.
+   * @throws NullPointerException if {@code name} is null
+   * @throws IllegalArgumentException if a different metric by the same name exists in this meter.
+   * @throws IllegalArgumentException if the {@code name} does not match spec requirements.
+   */
+  virtual nostd::shared_ptr<Counter<short>> CreateShortCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<Counter<int>> CreateIntCounter(nostd::string_view name,
+                                                           nostd::string_view description = "",
+                                                           nostd::string_view unit        = "",
+                                                           const bool enabled = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<Counter<float>> CreateFloatCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<Counter<double>> CreateDoubleCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  /**
+   * Creates a Asynchronouse (Observable) counter with the passed characteristics and returns a
+   * shared_ptr to that Observable Counter
+   *
+   * @param name the name of the new Observable Counter.
+   * @param description a brief description of what the Observable Counter is used for.
+   * @param unit the unit of metric values following https://unitsofmeasure.org/ucum.html.
+   * @param enabled a boolean value that turns on or off the metric instrument.
+   * @param callback the function to be observed by the instrument.
+   * @return a shared pointer to the created Observable Counter.
+   */
+  virtual nostd::shared_ptr<ObservableCounter<short>> CreateShortObservableCounter(
+      nostd::string_view name,
+      void (*callback)(ObserverResult<short>),
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableCounter<int>> CreateIntObservableCounter(
+      nostd::string_view name,
+      void (*callback)(ObserverResult<int>),
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true, ) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableCounter<float>> CreateFloatObservableCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true,
+      void (*callback)(ObserverResult<float>)) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableCounter<double>> CreateDoubleObservableCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true,
+      void (*callback)(ObserverResult<double>)) noexcept = 0;
+
+  /**
+   * Creates a Histogram with the passed characteristics and returns a shared_ptr to that Histogram.
+   *
+   * @param name the name of the new Histogram.
+   * @param description a brief description of what the Histogram is used for.
+   * @param unit the unit of metric values following https://unitsofmeasure.org/ucum.html.
+   * @param enabled a boolean value that turns on or off the metric instrument.
+   * @return a shared pointer to the created Histogram.
+   */
+  virtual nostd::shared_ptr<Histogram<short>> CreateShortHistogram(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<Histogram<int>> CreateIntHistogram(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<Histogram<float>> CreateFloatHistogram(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<Histogram<double>> CreateDoubleHistogram(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  /**
+   * Creates a Asynchronouse (Observable) Gauge with the passed characteristics and returns a
+   * shared_ptr to that Observable Counter
+   *
+   * @param name the name of the new Observable Gauge.
+   * @param description a brief description of what the Observable Gauge is used for.
+   * @param unit the unit of metric values following https://unitsofmeasure.org/ucum.html.
+   * @param enabled a boolean value that turns on or off the metric instrument.
+   * @param callback the function to be observed by the instrument.
+   * @return a shared pointer to the created Observable Gauge.
+   */
+  virtual nostd::shared_ptr<ObservableGauge<short>> CreateShortObservableGauge(
+      nostd::string_view name,
+      void (*callback)(ObserverResult<short>),
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableGauge<int>> CreateIntObservableGauge(
+      nostd::string_view name,
+      void (*callback)(ObserverResult<int>),
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true, ) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableGauge<float>> CreateFloatObservableGauge(
+      nostd::string_view name,
+      nostd::string_view description,
+      nostd::string_view unit,
+      const bool enabled,
+      void (*callback)(ObserverResult<float>)) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableGauge<double>> CreateDoubleObservableGauge(
+      nostd::string_view name,
+      nostd::string_view description,
+      nostd::string_view unit,
+      const bool enabled,
+      void (*callback)(ObserverResult<double>)) noexcept = 0;
+
+  /**
+   * Creates an UpDownCounter with the passed characteristics and returns a shared_ptr to that
+   * UpDownCounter.
+   *
+   * @param name the name of the new UpDownCounter.
+   * @param description a brief description of what the UpDownCounter is used for.
+   * @param unit the unit of metric values following https://unitsofmeasure.org/ucum.html.
+   * @param enabled a boolean value that turns on or off the metric instrument.
+   * @return a shared pointer to the created UpDownCounter.
+   */
+  virtual nostd::shared_ptr<UpDownCounter<short>> CreateShortUpDownCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<UpDownCounter<int>> CreateIntUpDownCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) = 0;
+
+  virtual nostd::shared_ptr<UpDownCounter<float>> CreateFloatUpDownCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<UpDownCounter<double>> CreateDoubleUpDownCounter(
+      nostd::string_view name,
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  /**
+   * Creates a Asynchronouse (Observable) UpDownCounter with the passed characteristics and returns
+   * a shared_ptr to that Observable UpDownCounter
+   *
+   * @param name the name of the new Observable UpDownCounter.
+   * @param description a brief description of what the Observable UpDownCounter is used for.
+   * @param unit the unit of metric values following https://unitsofmeasure.org/ucum.html.
+   * @param enabled a boolean value that turns on or off the metric instrument.
+   * @param callback the function to be observed by the instrument.
+   * @return a shared pointer to the created Observable UpDownCounter.
+   */
+  virtual nostd::shared_ptr<ObservableUpDownCounter<short>> CreateShortObservableUpDownCounter(
+      nostd::string_view name,
+      void (*callback)(ObserverResult<short>),
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableUpDownCounter<int>> CreateIntObservableUpDownCounter(
+      nostd::string_view name,
+      void (*callback)(ObserverResult<int>),
+      nostd::string_view description = "",
+      nostd::string_view unit        = "",
+      const bool enabled             = true, ) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableUpDownCounter<float>> CreateFloatObservableUpDownCounter(
+      nostd::string_view name,
+      nostd::string_view description,
+      nostd::string_view unit,
+      const bool enabled,
+      void (*callback)(ObserverResult<float>)) noexcept = 0;
+
+  virtual nostd::shared_ptr<ObservableUpDownCounter<double>> CreateDoubleObservableUpDownCounter(
+      nostd::string_view name,
+      nostd::string_view description,
+      nostd::string_view unit,
+      const bool enabled,
+      void (*callback)(ObserverResult<double>)) noexcept = 0;
+};
+}  // namespace metrics_new
+OPENTELEMETRY_END_NAMESPACE
+#endif

api/include/opentelemetry/metrics_new/meter_provider.h

@@ -0,0 +1,32 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+#ifdef ENABLE_METRICS_PREVIEW
+
+#  include "opentelemetry/metrics/meter.h"
+#  include "opentelemetry/nostd/shared_ptr.h"
+#  include "opentelemetry/nostd/string_view.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace metrics_new
+{
+/**
+ * Creates new Meter instances.
+ */
+class MeterProvider
+{
+public:
+  virtual ~MeterProvider() = default;
+  /**
+   * Gets or creates a named Meter instance.
+   *
+   * Optionally a version can be passed to create a named and versioned Meter
+   * instance.
+   */
+  virtual nostd::shared_ptr<Meter> GetMeter(nostd::string_view library_name,
+                                            nostd::string_view library_version = "",
+                                            nostd::string_view schema_url      = "") noexcept = 0;
+}  // namespace metrics
+OPENTELEMETRY_END_NAMESPACE
+#endif

api/include/opentelemetry/metrics_new/observer_result.h

@@ -0,0 +1,29 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+#ifdef ENABLE_METRICS_PREVIEW
+#  include "c
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace metrics_new
+{
+
+/**
+ * ObserverResult class is necessary for the callback recording asynchronous
+ * instrument use.
+ */
+
+template <class T>
+class ObserverResult
+{
+
+public:
+  virtual void observe(T value) noexcept = 0;
+
+  virtual void observer(T value, const common::KeyValueIterable &attributes) noexcept = 0;
+};
+
+}  // namespace metrics_new
+OPENTELEMETRY_END_NAMESPACE
+#endif