Update prometheus to support otel-cpp 1.11.0 and bazel 6 (#295)

* Update prometheus to support otel-cpp 1.9.1 and bazel 6

Signed-off-by: WenTao Ou <[email protected]>

* Fix dependency

Signed-off-by: WenTao Ou <[email protected]>

* Use cmake to check MSVC building.

Signed-off-by: WenTao Ou <[email protected]>

* Fix windows CI script

Signed-off-by: WenTao Ou <[email protected]>

* Fix build directory conflict

Signed-off-by: WenTao Ou <[email protected]>

* Fix OOM in ci jobs.

Signed-off-by: WenTao Ou <[email protected]>

* Update otel to 1.11.0 for PrometheusPushExporter, add factory for PrometheusPushExporter

---------

Signed-off-by: WenTao Ou <[email protected]>

Author: owent

.github/workflows/prometheus.yml

@@ -53,25 +53,44 @@ jobs:
           cd otel_cpp_contrib/exporters/prometheus
           bazel --output_user_root=$HOME/.cache/bazel build --copt=-DENABLE_TEST --@io_opentelemetry_cpp//api:with_abseil //...
           bazel --output_user_root=$HOME/.cache/bazel test --copt=-DENABLE_TEST --@io_opentelemetry_cpp//api:with_abseil //...
-  prometheus_bazel_window:
-    name: Bazel on Windows
+  prometheus_cmake_window:
+    name: CMake on Windows
     runs-on: windows-latest
     steps:
       - name: checkout otel contrib prometheus
         uses: actions/checkout@v3
         with:
           path: "otel_cpp_contrib"
+      - name: checkout otel cpp
+        uses: actions/checkout@v3
+        with:
+          repository: "open-telemetry/opentelemetry-cpp"
+          ref: "v1.11.0"
+          path: "otel_cpp"
+          submodules: "recursive"
       - name: run tests
         shell: pwsh
         run: |
           New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" `
             -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
-          $RUNNER_ROOT_PATH = Split-Path (Split-Path (Get-Location))
-          Set-Location otel_cpp_contrib/exporters/prometheus
-          & bazel --windows_enable_symlinks "--output_user_root=$RUNNER_ROOT_PATH/bazel_build" `
-            build --copt=-DENABLE_TEST --copt=/utf-8 --sandbox_debug --@io_opentelemetry_cpp//api:with_abseil //...
-          & bazel --windows_enable_symlinks "--output_user_root=$RUNNER_ROOT_PATH/bazel_build" `
-            test --copt=-DENABLE_TEST --copt=/utf-8 --sandbox_debug --@io_opentelemetry_cpp//api:with_abseil //...
+          vcpkg install "prometheus-cpp[pull,push]" nlohmann-json gtest benchmark --triplet=x64-windows-static-md
+          New-Item -Path "$ENV:GITHUB_WORKSPACE/otel_cpp/build_jobs_ci" -ItemType "directory" -Force 
+          Set-Location "$ENV:GITHUB_WORKSPACE/otel_cpp/build_jobs_ci"
+          cmake .. -DWITH_PROMETHEUS=ON -DWITH_METRICS_PREVIEW=OFF -DCMAKE_BUILD_TYPE=Debug `
+            -DVCPKG_TARGET_TRIPLET=x64-windows-static-md `
+            "-DCMAKE_TOOLCHAIN_FILE=$ENV:VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" `
+            "-DCMAKE_INSTALL_PREFIX=$HOME/prebuilt-otel" `
+            "-DBUILD_SHARED_LIBS=OFF" "-DBUILD_TESTING=OFF" "-DWITH_EXAMPLES=OFF" "-DWITH_FUNC_TESTS=OFF"
+          cmake --build . -j --config Debug || cmake --build . -j2 --config Debug || cmake --build . --config Debug
+          cmake --install . --prefix "$HOME/prebuilt-otel" --config Debug
+          New-Item -Path "$ENV:GITHUB_WORKSPACE/otel_cpp_contrib/exporters/prometheus/build_jobs_ci" -ItemType "directory" -Force
+          Set-Location "$ENV:GITHUB_WORKSPACE/otel_cpp_contrib/exporters/prometheus/build_jobs_ci"
+          cmake .. "-DCMAKE_PREFIX_PATH=$HOME/prebuilt-otel" -DCMAKE_BUILD_TYPE=Debug `
+            -DVCPKG_TARGET_TRIPLET=x64-windows-static-md `
+            "-DCMAKE_TOOLCHAIN_FILE=$ENV:VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" `
+            "-DBUILD_SHARED_LIBS=OFF"
+          cmake --build . -j --config Debug || cmake --build . -j2 --config Debug || cmake --build . --config Debug
+          ctest -VV -C Debug -R "opentelemetry_cpp_ecosystem_test.*" .
   prometheus_cmake_linux:
     name: CMake on Linux
     runs-on: ubuntu-latest
@@ -84,7 +103,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           repository: "open-telemetry/opentelemetry-cpp"
-          ref: "v1.6.1"
+          ref: "v1.11.0"
           path: "otel_cpp"
           submodules: "recursive"
       - name: setup
@@ -94,18 +113,20 @@ jobs:
             ca-certificates wget git valgrind lcov
       - name: run tests
         run: |
-          vcpkg install prometheus-cpp[pull,push] nlohmann-json GTest Benchmark --triplet=x64-linux
-          mkdir -p "$GITHUB_WORKSPACE/otel_cpp/build"
-          cd "$GITHUB_WORKSPACE/otel_cpp/build"
+          vcpkg install 'prometheus-cpp[pull,push]' nlohmann-json gtest benchmark --triplet=x64-linux
+          mkdir -p "$GITHUB_WORKSPACE/otel_cpp/build_jobs_ci"
+          cd "$GITHUB_WORKSPACE/otel_cpp/build_jobs_ci"
           cmake .. -DWITH_PROMETHEUS=ON -DWITH_METRICS_PREVIEW=OFF -DCMAKE_BUILD_TYPE=Debug \
             -DVCPKG_TARGET_TRIPLET=x64-linux \
-            "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake"
-          cmake --build . -j --config Debug
+            "-DCMAKE_INSTALL_PREFIX=$HOME/prebuilt-otel" \
+            "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" \
+            "-DBUILD_TESTING=OFF" "-DWITH_EXAMPLES=OFF" "-DWITH_FUNC_TESTS=OFF"
+          cmake --build . -j --config Debug || cmake --build . -j2 --config Debug || cmake --build . --config Debug
           cmake --install . --prefix "$HOME/prebuilt-otel" --config Debug
-          mkdir -p "$GITHUB_WORKSPACE/otel_cpp_contrib/exporters/prometheus/build"
-          cd "$GITHUB_WORKSPACE/otel_cpp_contrib/exporters/prometheus/build"
+          mkdir -p "$GITHUB_WORKSPACE/otel_cpp_contrib/exporters/prometheus/build_jobs_ci"
+          cd "$GITHUB_WORKSPACE/otel_cpp_contrib/exporters/prometheus/build_jobs_ci"
           cmake .. "-DCMAKE_PREFIX_PATH=$HOME/prebuilt-otel" -DCMAKE_BUILD_TYPE=Debug \
             -DVCPKG_TARGET_TRIPLET=x64-linux \
-            "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake"
-          cmake --build . -j --config Debug
+            "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake"
+          cmake --build . -j --config Debug || cmake --build . -j2 --config Debug || cmake --build . --config Debug
           ctest -VV -R "opentelemetry_cpp_ecosystem_test.*" .

exporters/prometheus/.clang-format

@@ -0,0 +1,61 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+# See Clang docs: http://clang.llvm.org/docs/ClangFormatStyleOptions.html
+BasedOnStyle: Chromium
+
+# Allow double brackets such as std::vector<std::vector<int>>.
+Standard: Cpp11
+
+# Indent 2 spaces at a time.
+IndentWidth: 2
+
+# Keep lines under 100 columns long.
+ColumnLimit: 100
+
+# Always break before braces
+BreakBeforeBraces: Custom
+BraceWrapping:
+#  TODO(lujc) wait for clang-format-9 support in Chromium tools
+#  AfterCaseLabel: true
+  AfterClass: true
+  AfterControlStatement: true
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  BeforeCatch: true
+  BeforeElse: true
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+
+  # Keeps extern "C" blocks unindented.
+  AfterExternBlock: false
+
+# Indent case labels.
+IndentCaseLabels: true
+
+# Right-align pointers and references
+PointerAlignment: Right
+
+# ANGLE likes to align things as much as possible.
+AlignOperands: true
+AlignConsecutiveAssignments: true
+
+# Use 2 space negative offset for access modifiers
+AccessModifierOffset: -2
+
+# TODO(jmadill): Decide if we want this on. Doesn't have an "all or none" mode.
+AllowShortCaseLabelsOnASingleLine: false
+
+# Useful for spacing out functions in classes
+KeepEmptyLinesAtTheStartOfBlocks: true
+
+# Indent nested PP directives.
+IndentPPDirectives: AfterHash
+
+# Include blocks style
+IncludeBlocks: Preserve

exporters/prometheus/.cmake-format.py

@@ -0,0 +1,7 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+# If comment markup is enabled, don't reflow the first comment block in
+# eachlistfile. Use this to preserve formatting of your
+# copyright/licensestatements.
+first_comment_is_literal = True

exporters/prometheus/BUILD

@@ -4,9 +4,12 @@ cc_library(
     name = "prometheus_push_exporter",
     srcs = [
         "src/push_exporter.cc",
+        "src/push_exporter_factory.cc",
     ],
     hdrs = [
         "include/opentelemetry/exporters/prometheus/push_exporter.h",
+        "include/opentelemetry/exporters/prometheus/push_exporter_factory.h",
+        "include/opentelemetry/exporters/prometheus/push_exporter_options.h",
     ],
     strip_include_prefix = "include",
     tags = ["prometheus"],
@@ -17,6 +20,7 @@ cc_library(
         "@io_opentelemetry_cpp//exporters/prometheus:prometheus_collector",
         "@io_opentelemetry_cpp//exporters/prometheus:prometheus_exporter_utils",
         "@io_opentelemetry_cpp//sdk:headers",
+        "@io_opentelemetry_cpp//sdk/src/metrics",
     ],
 )
 

exporters/prometheus/CMakeLists.txt

@@ -16,7 +16,7 @@ cmake_minimum_required(VERSION 3.12)
 
 project(
   opentelemetry-cpp-contrib
-  VERSION "1.6.1" # opentelemetry-cpp-contrib 1.6.1
+  VERSION "1.11.0" # opentelemetry-cpp-contrib 1.11.0
   HOMEPAGE_URL "https://github.com/open-telemetry/opentelemetry-cpp-contrib"
   LANGUAGES CXX)
 
@@ -79,7 +79,7 @@ if(BUILD_TESTING)
   endif()
 endif()
 
-add_library(opentelemetry_prometheus_push_exporter src/push_exporter.cc)
+add_library(opentelemetry_prometheus_push_exporter src/push_exporter.cc src/push_exporter_factory.cc)
 set_target_properties(opentelemetry_prometheus_push_exporter
                       PROPERTIES EXPORT_NAME prometheus_push_exporter)
 
@@ -93,6 +93,12 @@ target_link_libraries(
   PUBLIC opentelemetry-cpp::prometheus_exporter opentelemetry-cpp::metrics
          opentelemetry-cpp::resources prometheus-cpp::push prometheus-cpp::core)
 
+target_compile_definitions(
+  opentelemetry_prometheus_push_exporter
+  PUBLIC "OPENTELEMTRY_CPP_MAJOR_VERSION=${opentelemetry-cpp_VERSION_MAJOR}"
+         "OPENTELEMTRY_CPP_MINOR_VERSION=${opentelemetry-cpp_VERSION_MINOR}"
+         "OPENTELEMTRY_CPP_PATCH_VERSION=${opentelemetry-cpp_VERSION_PATCH}")
+
 if(DEFINED VCPKG_CMAKE_SYSTEM_NAME AND VCPKG_CMAKE_SYSTEM_NAME STREQUAL
                                        "WindowsStore")
   set(OPENTELEMETRY_CPP_CONTRIB_TARGET_IS_WINDOWS ON)

exporters/prometheus/WORKSPACE

@@ -24,6 +24,10 @@ load("@io_opentelemetry_cpp//bazel:repository.bzl", "opentelemetry_cpp_deps")
 # Load dependencies of opentelemetry-cpp
 opentelemetry_cpp_deps()
 
+load("@io_opentelemetry_cpp//bazel:extra_deps.bzl", "opentelemetry_extra_deps")
+
+opentelemetry_extra_deps()
+
 # Load prometheus C++ dependencies.
 load("@com_github_jupp0r_prometheus_cpp//bazel:repositories.bzl", "prometheus_cpp_repositories")
 

exporters/prometheus/include/opentelemetry/exporters/prometheus/push_exporter.h

@@ -1,48 +1,49 @@
-// Copyright 2022, OpenTelemetry Authors
+// Copyright 2023, OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
 #pragma once
 
-#  ifdef _WIN32
-#    include <io.h>        // NOLINT
-#    include <winsock2.h>  // NOLINT
-#  else
-#    include <unistd.h>  // NOLINT
-#  endif
+#ifndef WIN32_LEAN_AND_MEAN
+#  define WIN32_LEAN_AND_MEAN
+#endif
 
-#  include <chrono>
-#  include <memory>
-#  include <string>
-#  include <vector>
+#ifndef NOMINMAX
+#  define NOMINMAX
+#endif
 
-#  include "prometheus/gateway.h"
+#ifdef _WIN32
+#  include <io.h>        // NOLINT
+#  include <winsock2.h>  // NOLINT
+#else
+#  include <unistd.h>  // NOLINT
+#endif
+
+#include <chrono>
+#include <memory>
+#include <string>
+#include <vector>
+
+#include "prometheus/gateway.h"
+
+#include "opentelemetry/exporters/prometheus/exporter_utils.h"
+#include "opentelemetry/exporters/prometheus/push_exporter_options.h"
+#include "opentelemetry/nostd/span.h"
+#include "opentelemetry/sdk/common/env_variables.h"
+#include "opentelemetry/sdk/metrics/push_metric_exporter.h"
+#include "opentelemetry/version.h"
 
-#  include "opentelemetry/exporters/prometheus/collector.h"
-#  include "opentelemetry/nostd/span.h"
-#  include "opentelemetry/sdk/common/env_variables.h"
-#  include "opentelemetry/sdk/metrics/metric_exporter.h"
-#  include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE
-namespace exporter {
-namespace metrics {
-/**
- * Struct to hold Prometheus exporter options.
- */
-struct PrometheusPushExporterOptions {
-  std::string host;
-  std::string port;
-  std::string jobname;
-  ::prometheus::Labels labels;
-  std::string username;
-  std::string password;
-
-  ::opentelemetry::sdk::metrics::AggregationTemporality aggregation_temporality =
-      ::opentelemetry::sdk::metrics::AggregationTemporality::kDelta;
-};
+namespace exporter
+{
+namespace metrics
+{
+
+class PrometheusPushCollector;
 
-class PrometheusPushExporter : public ::opentelemetry::sdk::metrics::MetricExporter {
- public:
+class PrometheusPushExporter : public ::opentelemetry::sdk::metrics::PushMetricExporter
+{
+public:
   /**
    * Constructor - binds an exposer and collector to the exporter
    * @param options: options for an exposer that exposes
@@ -69,7 +70,8 @@ class PrometheusPushExporter : public ::opentelemetry::sdk::metrics::MetricExpor
   /**
    * Force flush the exporter.
    */
-  bool ForceFlush(std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override;
+  bool ForceFlush(
+      std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override;
 
   /**
    * Shuts down the exporter and does cleanup.
@@ -81,17 +83,18 @@ class PrometheusPushExporter : public ::opentelemetry::sdk::metrics::MetricExpor
   bool Shutdown(std::chrono::microseconds timeout = std::chrono::microseconds(0)) noexcept override;
 
   /**
-   * @return: returns a shared_ptr to
-   * the PrometheusCollector instance
+   * Gets the maximum size of the collection.
+   *
+   * @return max collection size
    */
-  std::shared_ptr<::opentelemetry::exporter::metrics::PrometheusCollector> &GetCollector();
+  std::size_t GetMaxCollectionSize() const noexcept;
 
   /**
    * @return: Gets the shutdown status of the exporter
    */
   bool IsShutdown() const;
 
- private:
+private:
   // The configuration options associated with this exporter.
   const PrometheusPushExporterOptions options_;
   /**
@@ -103,7 +106,7 @@ class PrometheusPushExporter : public ::opentelemetry::sdk::metrics::MetricExpor
    * Pointer to a
    * PrometheusCollector instance
    */
-  std::shared_ptr<::opentelemetry::exporter::metrics::PrometheusCollector> collector_;
+  std::shared_ptr<PrometheusPushCollector> collector_;
 
   /**
    * Pointer to an

exporters/prometheus/include/opentelemetry/exporters/prometheus/push_exporter_factory.h

@@ -0,0 +1,34 @@
+// Copyright 2023, OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <memory>
+
+#include "opentelemetry/sdk/metrics/push_metric_exporter.h"
+#include "opentelemetry/version.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace exporter
+{
+namespace metrics
+{
+
+struct PrometheusPushExporterOptions;
+
+/**
+ * Factory class for PrometheusExporter.
+ */
+class PrometheusPushExporterFactory
+{
+public:
+  /**
+   * Create a PrometheusExporter using the given options.
+   */
+  static std::unique_ptr<opentelemetry::sdk::metrics::PushMetricExporter> Create(
+      const PrometheusPushExporterOptions &options);
+};
+
+}  // namespace metrics
+}  // namespace exporter
+OPENTELEMETRY_END_NAMESPACE