ETW Metrics Exporter for Windows (#228)

lalitb · web-flow · commit dba13fef6574 · 2022-11-21T17:41:46.000-08:00
diff --git a/exporters/geneva/CMakeLists.txt b/exporters/geneva/CMakeLists.txt
@@ -4,24 +4,33 @@ cmake_minimum_required(VERSION 3.12)
 # (using add_subdirectory) or if it is the main project
 #
 set(MAIN_PROJECT OFF)
-
 set(MAIN_PROJECT OFF)
 if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
   project(opentelemetry-geneva-metrics)
   set(MAIN_PROJECT ON)
 endif()
 
+if(NOT WIN32)
+  find_package(CURL REQUIRED)
+endif()
 add_definitions(-DHAVE_CONSOLE_LOG)
 if(MAIN_PROJECT)
   find_package(opentelemetry-cpp REQUIRED)
 endif()
 
-find_package(CURL REQUIRED)
-
 include_directories(include)
+
 # create geneva metrics exporter
-add_library(opentelemetry_exporter_geneva_metrics
-            src/exporter.cc src/unix_domain_socket_data_transport.cc)
+if(WIN32)
+  add_library(
+    opentelemetry_exporter_geneva_metrics
+    src/exporter.cc src/etw_data_transport.cc
+    src/unix_domain_socket_data_transport.cc)
+else()
+  add_library(opentelemetry_exporter_geneva_metrics
+              src/exporter.cc src/unix_domain_socket_data_transport.cc)
+endif()
+
 target_include_directories(opentelemetry_exporter_geneva_metrics
                            PRIVATE ${OPENTELEMETRY_CPP_INCLUDE_DIRS})
 target_link_libraries(opentelemetry_exporter_geneva_metrics
diff --git a/exporters/geneva/build_tools/ports/opentelemetry-etw-metrics-exporter/portfile.cmake b/exporters/geneva/build_tools/ports/opentelemetry-etw-metrics-exporter/portfile.cmake
@@ -0,0 +1,24 @@
+include(vcpkg_common_functions)
+
+if(VCPKG_TARGET_IS_WINDOWS)
+    vcpkg_check_linkage(ONLY_STATIC_LIBRARY)
+endif()
+
+vcpkg_from_github(
+    OUT_SOURCE_PATH SOURCE_PATH
+    REPO lalitb/opentelemetry-cpp-contrib
+    HEAD_REF geneva-windows
+)
+
+vcpkg_cmake_configure(
+    SOURCE_PATH "${SOURCE_PATH}/exporters/geneva/"
+    OPTIONS
+        -DBUILD_TESTING=OFF
+        -DBUILD_EXAMPLE=OFF
+)
+
+vcpkg_cmake_install()
+vcpkg_cmake_config_fixup(CONFIG_PATH lib/cmake/${PORT})
+vcpkg_copy_pdbs()
+file(REMOVE_RECURSE "${CURRENT_PACKAGES_DIR}/debug/include")
+file(REMOVE_RECURSE "${CURRENT_PACKAGES_DIR}/debug/share")
diff --git a/exporters/geneva/build_tools/ports/opentelemetry-etw-metrics-exporter/vcpkg.json b/exporters/geneva/build_tools/ports/opentelemetry-etw-metrics-exporter/vcpkg.json
@@ -0,0 +1,24 @@
+{
+    "$schema": "https://raw.githubusercontent.com/microsoft/vcpkg/master/scripts/vcpkg.schema.json",
+    "name": "opentelemetry-etw-metrics-exporter",
+    "version-semver": "0.0.1",
+    "description": [
+      "OpenTelemetry ETW Exporter uses OpenTelemetry API/SDK to export the metrics data to ETW."
+    ],
+    "homepage": "https://github.com/open-telemetry/opentelemetry-cpp-contrib",
+    "license": "Apache-2.0",
+    "dependencies": [
+      {
+        "name": "opentelemetry-cpp",
+        "host": true
+      },
+      {
+        "name": "vcpkg-cmake",
+        "host": true
+      },
+      {
+        "name": "vcpkg-cmake-config",
+        "host": true
+      }
+    ]
+  }
diff --git a/exporters/geneva/example/example_metrics.cc b/exporters/geneva/example/example_metrics.cc
@@ -1,7 +1,6 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#ifndef ENABLE_METRICS_PREVIEW
 #include "opentelemetry/exporters/geneva/metrics/exporter.h"
 #include "opentelemetry/metrics/provider.h"
 #include "opentelemetry/sdk/metrics/aggregation/default_aggregation.h"
@@ -26,9 +25,13 @@ const std::string kUnixDomainPath = "/tmp/ifx_unix_socket";
 const std::string kNamespaceName = "test_ns";
 
 void initMetrics(const std::string &name, const std::string &account_name) {
-  std::string conn_string = "Endpoint=unix://" + kUnixDomainPath +
-                            ";Account=" + account_name +
-                            ";Namespace=" + kNamespaceName;
+
+#ifndef _WIN32
+  conn_string = "Endpoint=unix://" + kUnixDomainPath + ";" + conn_string;
+#else
+  std::string conn_string =
+      "Account=" + account_name + ";Namespace=" + kNamespaceName;
+#endif
   geneva_exporter::ExporterOptions options{conn_string};
   std::unique_ptr<metric_sdk::PushMetricExporter> exporter{
       new geneva_exporter::Exporter(options)};
@@ -84,8 +87,7 @@ void initMetrics(const std::string &name, const std::string &account_name) {
   std::shared_ptr<opentelemetry::sdk::metrics::AggregationConfig>
       aggregation_config{
           new opentelemetry::sdk::metrics::HistogramAggregationConfig()};
-  static_cast<
-      opentelemetry::sdk::metrics::HistogramAggregationConfig*>(
+  static_cast<opentelemetry::sdk::metrics::HistogramAggregationConfig *>(
       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};
@@ -128,6 +130,3 @@ int main(int argc, char **argv) {
     histogram_example.join();
   }
 }
-#else
-int main() {}
-#endif
diff --git a/exporters/geneva/example/foo_library.cc b/exporters/geneva/example/foo_library.cc
@@ -1,7 +1,6 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#ifndef ENABLE_METRICS_PREVIEW
 #include "foo_library.h"
 #include "opentelemetry/context/context.h"
 #include "opentelemetry/metrics/provider.h"
@@ -92,5 +91,3 @@ void FooLibrary::histogram_example(const std::string &name) {
     std::this_thread::sleep_for(std::chrono::milliseconds(250));
   }
 }
-
-#endif
diff --git a/exporters/geneva/example/foo_library.h b/exporters/geneva/example/foo_library.h
@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #pragma once
-#ifndef ENABLE_METRICS_PREVIEW
 #include <string>
 
 class FooLibrary {
@@ -11,4 +10,3 @@ class FooLibrary {
   static void histogram_example(const std::string &name);
   static void observable_counter_example(const std::string &name);
 };
-#endif
diff --git a/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/connection_string_parser.h b/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/connection_string_parser.h
@@ -73,7 +73,7 @@ class ConnectionStringParser {
         }
       }
     }
-#if defined(_MSC_VER)
+#ifdef _WIN32
     if (account_.size() && namespace_.size() && !is_endpoint_found) {
       transport_protocol_ = TransportProtocol::kETW;
     }
diff --git a/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/data_transport.h b/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/data_transport.h
@@ -11,13 +11,22 @@ OPENTELEMETRY_BEGIN_NAMESPACE
 namespace exporter {
 namespace geneva {
 namespace metrics {
-using ByteVector = std::vector<unsigned char>;
+
+// These enums are defined in 
+// file: test/decoder/ifx_metrics_bin.ksy (enum metric_event_type)
+enum class MetricsEventType : uint16_t {
+  ULongMetric = 50,
+  DoubleMetric = 55,
+  ExternallyAggregatedULongDistributionMetric = 56
+};
 
 class DataTransport {
 public:
   virtual bool Connect() noexcept = 0;
-  virtual bool Send(const char *data, uint16_t length) noexcept = 0;
+  virtual bool Send(MetricsEventType event_type, const char *data,
+                    uint16_t length) noexcept = 0;
   virtual bool Disconnect() noexcept = 0;
+  virtual ~DataTransport() = 0;
 };
 } // namespace metrics
 } // namespace geneva
diff --git a/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/etw_data_transport.h b/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/etw_data_transport.h
@@ -0,0 +1,39 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "opentelemetry/exporters/geneva/metrics/connection_string_parser.h"
+#include "opentelemetry/exporters/geneva/metrics/data_transport.h"
+#include "opentelemetry/version.h"
+
+#include <evntprov.h>
+#include <guiddef.h>
+#include <memory>
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace exporter {
+namespace geneva {
+namespace metrics {
+static const REGHANDLE INVALID_HANDLE = _UI64_MAX;
+static const GUID kMDMProviderGUID = {
+    0xedc24920, 0xe004, 0x40f6, 0xa8, 0xe1, 0x0e, 0x6e, 0x48, 0xf3, 0x9d, 0x84};
+
+class ETWDataTransport : public DataTransport {
+public:
+  ETWDataTransport(const size_t offset_to_skip_);
+  bool Connect() noexcept override;
+  bool Send(MetricsEventType event_type, const char *data,
+            uint16_t length) noexcept override;
+  bool Disconnect() noexcept override;
+  ~ETWDataTransport();
+
+private:
+  REGHANDLE provider_handle_;
+  bool connected_{false};
+  const size_t offset_to_skip_;
+};
+} // namespace metrics
+} // namespace geneva
+} // namespace exporter
+OPENTELEMETRY_END_NAMESPACE
diff --git a/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/exporter.h b/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/exporter.h
@@ -33,12 +33,6 @@ constexpr uint64_t kSecondsToUnixTime =
                   // 1601-01-01T00:00:00Z and UNIX/Linux epoch
                   // (1970-01-01T00:00:00Z)
 
-enum class MetricsEventType : uint16_t {
-  ULongMetric = 50,
-  DoubleMetric = 55,
-  ExternallyAggregatedULongDistributionMetric = 56
-};
-
 /**
  * The Geneva metrics exporter exports metrics data to Geneva
  */
diff --git a/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/unix_domain_socket_data_transport.h b/exporters/geneva/include/opentelemetry/exporters/geneva/metrics/unix_domain_socket_data_transport.h
@@ -18,7 +18,8 @@ class UnixDomainSocketDataTransport : public DataTransport {
 public:
   UnixDomainSocketDataTransport(const std::string &connection_string);
   bool Connect() noexcept override;
-  bool Send(const char *data, uint16_t length) noexcept override;
+  bool Send(MetricsEventType event_type, const char *data,
+            uint16_t length) noexcept override;
   bool Disconnect() noexcept override;
 
 private:
diff --git a/exporters/geneva/src/etw_data_transport.cc b/exporters/geneva/src/etw_data_transport.cc
@@ -0,0 +1,85 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#include "opentelemetry/exporters/geneva/metrics/etw_data_transport.h"
+#include "opentelemetry/exporters/geneva/metrics/macros.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace exporter {
+namespace geneva {
+namespace metrics {
+#define GUID_FORMAT                                                            \
+  "%08lX-%04hX-%04hX-%02hhX%02hhX-%02hhX%02hhX%02hhX%02hhX%02hhX%02hhX"
+#define GUID_ARG(guid)                                                         \
+  (guid).Data1, (guid).Data2, (guid).Data3, (guid).Data4[0], (guid).Data4[1],  \
+      (guid).Data4[2], (guid).Data4[3], (guid).Data4[4], (guid).Data4[5],      \
+      (guid).Data4[6], (guid).Data4[7]
+
+ETWDataTransport::ETWDataTransport(const size_t offset_to_skip)
+    : offset_to_skip_{offset_to_skip} {
+  auto status =
+      ::EventRegister(&kMDMProviderGUID, NULL, NULL, &provider_handle_);
+  if (status != ERROR_SUCCESS) {
+    LOG_ERROR("ETWDataTransport:: Failed to initialize the ETW provider.  "
+              "Metrics will not be published, Provider ID: {" GUID_FORMAT "}",
+              GUID_ARG(kMDMProviderGUID));
+    provider_handle_ = INVALID_HANDLE;
+  }
+}
+
+bool ETWDataTransport::Connect() noexcept {
+  // connection is already established in constructor. Check if it is still
+  // valid.
+  if (provider_handle_ == INVALID_HANDLE) {
+    LOG_ERROR("ETWDataTransport:: Failed to initialize the ETW provider.  "
+              "Metrics will not be published");
+    return false;
+  }
+  return true;
+}
+
+bool ETWDataTransport::Send(MetricsEventType event_type, const char *data,
+                            uint16_t length) noexcept {
+  if (provider_handle_ == INVALID_HANDLE) {
+    LOG_ERROR("ETWDataTransport:: ETW Provider Handle is not valid. Metrics is "
+              "dropped");
+    return false;
+  }
+  const unsigned int descriptorSize = 1;
+  EVENT_DATA_DESCRIPTOR dataDescriptor[descriptorSize];
+  ::ZeroMemory(&dataDescriptor, sizeof(dataDescriptor));
+  // skip the event_id and the payload length (as expected by the ETW listener)
+  ::EventDataDescCreate(&dataDescriptor[0], data + offset_to_skip_,
+                        length - offset_to_skip_);
+
+  EVENT_DESCRIPTOR evtDescriptor;
+  ::ZeroMemory(&evtDescriptor, sizeof(EVENT_DESCRIPTOR));
+  evtDescriptor.Version = 1;
+  evtDescriptor.Version = 0;
+  evtDescriptor.Id = static_cast<unsigned short>(event_type);
+  auto result = ::EventWrite(provider_handle_, &evtDescriptor, descriptorSize,
+                             dataDescriptor);
+  if (result != ERROR_SUCCESS) {
+    LOG_ERROR("ETWDataTransport:: Failed to publish metric to ETW. Error: %d",
+              result);
+    return false;
+  }
+  return true;
+}
+
+bool ETWDataTransport::Disconnect() noexcept {
+  // provider is deregistered in destructor.
+  return true;
+}
+
+ETWDataTransport::~ETWDataTransport() {
+  if (provider_handle_ != INVALID_HANDLE) {
+    ::EventUnregister(provider_handle_);
+    provider_handle_ = INVALID_HANDLE;
+  }
+}
+
+} // namespace metrics
+} // namespace geneva
+} // namespace exporter
+OPENTELEMETRY_END_NAMESPACE
diff --git a/exporters/geneva/src/exporter.cc b/exporters/geneva/src/exporter.cc
diff --git a/exporters/geneva/src/unix_domain_socket_data_transport.cc b/exporters/geneva/src/unix_domain_socket_data_transport.cc

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`// Copyright The OpenTelemetry Authors`
`2`	`2`	`// SPDX-License-Identifier: Apache-2.0`
`3`	`3`
`4`		`-#ifndef ENABLE_METRICS_PREVIEW`
`5`	`4`	`#include "foo_library.h"`
`6`	`5`	`#include "opentelemetry/context/context.h"`
`7`	`6`	`#include "opentelemetry/metrics/provider.h"`
`@@ -92,5 +91,3 @@ void FooLibrary::histogram_example(const std::string &name) {`
`92`	`91`	`std::this_thread::sleep_for(std::chrono::milliseconds(250));`
`93`	`92`	`}`
`94`	`93`	`}`
`95`		`-`
`96`		`-#endif`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ class ConnectionStringParser {`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`	`}`
`76`		`-#if defined(_MSC_VER)`
	`76`	`+#ifdef _WIN32`
`77`	`77`	`if (account_.size() && namespace_.size() && !is_endpoint_found) {`
`78`	`78`	`transport_protocol_ = TransportProtocol::kETW;`
`79`	`79`	`}`