Add zPages Tracez Backend Benchmarks

examples/zpages/BUILD

@@ -24,8 +24,7 @@ cc_binary(
         "//conditions:default": ["-pthread"],
     }),
     deps = [
-        "//ext:headers",
-        "//ext/src/zpages",
+        "//ext/zpages",
         "//sdk/src/trace",
     ],
 )

ext/CMakeLists.txt

@@ -1,5 +1,2 @@
-add_subdirectory(src)
-
-if(BUILD_TESTING)
-  add_subdirectory(test)
-endif()
+add_subdirectory(http)
+add_subdirectory(zpages)

ext/http/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(server)

ext/http/server/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_library(http_server INTERFACE)
+
+target_include_directories(http_server INTERFACE include)

ext/zpages/BUILD

@@ -0,0 +1,14 @@
+package(default_visibility = ["//visibility:public"])
+
+cc_library(
+    name = "zpages",
+    srcs = glob(["src/**/*.cc"]),
+    hdrs = glob(["include/**/*.h"]),
+    strip_include_prefix = "include",
+    deps = [
+        "//api",
+        "//ext/http/server:headers",
+        "//sdk:headers",
+        "@github_nlohmann_json//:json",
+    ],
+)

ext/zpages/CMakeLists.txt

@@ -0,0 +1,14 @@
+add_library(
+  opentelemetry_zpages src/tracez_processor.cc src/tracez_data_aggregator.cc
+  # TODO: add Cmake build for nlohmann JSON
+  # src/tracez_http_server.cc
+)
+
+target_include_directories(opentelemetry_zpages PUBLIC include)
+
+target_link_libraries(opentelemetry_zpages opentelemetry_api
+                      opentelemetry_trace http_server)
+
+if(BUILD_TESTING)
+  add_subdirectory(test)
+endif()

ext/src/zpages/README.md → ext/zpages/README.md

@@ -1,6 +1,6 @@
 # zPages
 ## Overview
-zPages are a quick and light way to view tracing and metrics information on standard OpenTelemetry C++ instrumented applications. It requires no external dependencies or backend setup. See more information in the OTel zPages experimental [spec](https://github.com/open-telemetry/opentelemetry-specification/blob/5b86d4b6c42e6d1e47d9155ac1e2e27f0f0b7769/experimental/trace/zpages.md). OTel C++ currently only offers Tracez; future zPages to potentially add include TraceConfigz, RPCz, and Statsz. Events and links need to be added to Tracez.
+zPages are a quick and light way to view tracing and metrics information on standard OpenTelemetry C++ instrumented applications. It requires no external dependencies or backend setup. See more information in the OTel zPages experimental [spec](https://github.com/open-telemetry/opentelemetry-specification/blob/5b86d4b6c42e6d1e47d9155ac1e2e27f0f0b7769/experimental/trace/zpages.md). OTel C++ currently only offers Tracez, which are currently not showing events and links; future zPages to potentially add include TraceConfigz, RPCz, and Statsz. There's also a Medium article on zPages [here](https://medium.com/opentelemetry/zpages-in-opentelemetry-2b080a81eb47).
 
 # Usage
 > TODO: Add CMake instructions
@@ -25,3 +25,4 @@ zPages are a quick and light way to view tracing and metrics information on stan
   - [Tracez Span Processor](https://docs.google.com/document/d/1kO4iZARYyr-EGBlY2VNM3ELU3iw6ZrC58Omup_YT-fU/edit#)
   - [Tracez Data Aggregator](https://docs.google.com/document/d/1ziKFgvhXFfRXZjOlAHQRR-TzcNcTXzg1p2I9oPCEIoU/edit?ts=5ef0d177#heading=h.5irk4csrpu0y)
   - [Tracez Http Server](https://docs.google.com/document/d/1U1V8QZ5LtGl4Mich-aJ6KZGLHrMIE8pWyspmzvnIefI/edit#) - includes reference pictures of the zPages/Tracez UI
+

ext/include/opentelemetry/ext/zpages/tracez_data_aggregator.h → ext/zpages/include/opentelemetry/ext/zpages/tracez_data_aggregator.h

@@ -161,6 +161,9 @@ class TracezDataAggregator
   /** Condition variable that notifies the thread when object is about to be
   destroyed **/
   std::condition_variable cv_;
+
+  /** Friend class used for benchmarking **/
+  friend class TracezDataAggregatorPeer;
 };
 
 }  // namespace zpages

ext/include/opentelemetry/ext/zpages/tracez_processor.h → ext/zpages/include/opentelemetry/ext/zpages/tracez_processor.h

@@ -91,6 +91,9 @@ class TracezSpanProcessor : public opentelemetry::sdk::trace::SpanProcessor
 private:
   mutable std::mutex mtx_;
   CollectedSpans spans_;
+
+  /** Friend class used for benchmarking **/
+  friend class TracezProcessorPeer;
 };
 }  // namespace zpages
 }  // namespace ext

ext/zpages/test/BUILD

@@ -0,0 +1,61 @@
+load("//bazel:otel_cc_benchmark.bzl", "otel_cc_benchmark")
+
+cc_test(
+    name = "threadsafe_span_data_test",
+    srcs = [
+        "threadsafe_span_data_test.cc",
+    ],
+    deps = [
+        "//ext/zpages",
+        "//sdk/src/trace",
+        "@com_google_googletest//:gtest_main",
+    ],
+)
+
+cc_test(
+    name = "tracez_data_aggregator_test",
+    srcs = [
+        "tracez_data_aggregator_test.cc",
+    ],
+    deps = [
+        "//ext/zpages",
+        "//sdk/src/trace",
+        "@com_google_googletest//:gtest_main",
+    ],
+)
+
+cc_test(
+    name = "tracez_processor_test",
+    srcs = [
+        "tracez_processor_test.cc",
+    ],
+    deps = [
+        "//ext/zpages",
+        "//sdk/src/trace",
+        "@com_google_googletest//:gtest_main",
+    ],
+)
+
+otel_cc_benchmark(
+    name = "tracez_aggregator_benchmark",
+    srcs = [
+        "tracez_data_aggregator_benchmark.cc",
+    ],
+    deps = [
+        "//api",
+        "//ext/zpages",
+        "//sdk/src/trace",
+    ],
+)
+
+otel_cc_benchmark(
+    name = "tracez_processor_benchmark",
+    srcs = [
+        "tracez_processor_benchmark.cc",
+    ],
+    deps = [
+        "//api",
+        "//ext/zpages",
+        "//sdk/src/trace",
+    ],
+)