Merge branch 'main' into make_release_1.13.0

CHANGELOG.md

@@ -15,7 +15,7 @@ Increment the:
 
 ## [Unreleased]
 
-## [1.13.0] 2023-12-05
+## [1.13.0] 2023-12-06
 
 * [BUILD] Remove WITH_REMOVE_METER_PREVIEW, use WITH_ABI_VERSION_2 instead
   [#2370](https://github.com/open-telemetry/opentelemetry-cpp/pull/2370)
@@ -76,9 +76,8 @@ Increment the:
   [#2424](https://github.com/open-telemetry/opentelemetry-cpp/pull/2424)
 * [API] Create root span with active span
   [#2427](https://github.com/open-telemetry/opentelemetry-cpp/pull/2427)
-
-* xxx
-  [#NNNN](https://github.com/open-telemetry/opentelemetry-cpp/pull/NNNN)
+* [REMOVAL] Remove ZPAGES
+  [#2433](https://github.com/open-telemetry/opentelemetry-cpp/pull/2433)
 
 Important changes:
 
@@ -151,6 +150,11 @@ Breaking changes:
   * Please check configuration variables,
     to make sure `_LOGS_` variables are set as expected.
 
+* [REMOVAL] Remove ZPAGES
+  [#2433](https://github.com/open-telemetry/opentelemetry-cpp/pull/2433)
+  * As announced in release 1.12.0,
+    the deprecated ZPAGES exporter is now removed.
+
 ## [1.12.0] 2023-10-16
 
 * [BUILD] Support `pkg-config`

CMakeLists.txt

@@ -212,9 +212,6 @@ option(WITH_PROMETHEUS "Whether to include the Prometheus Client in the SDK"
 option(WITH_ELASTICSEARCH
        "Whether to include the Elasticsearch Client in the SDK" OFF)
 
-option(WITH_ZPAGES
-       "DEPRECATED - Whether to include the Zpages Server in the SDK" OFF)
-
 option(WITH_NO_GETENV "Whether the platform supports environment variables" OFF)
 
 option(BUILD_TESTING "Whether to enable tests" ON)
@@ -290,14 +287,6 @@ option(WITH_OTLP_HTTP_SSL_TLS_PREVIEW
 option(WITH_METRICS_EXEMPLAR_PREVIEW
        "Whether to enable exemplar within metrics" OFF)
 
-if(WITH_ZPAGES)
-  if(WITH_NO_DEPRECATED_CODE)
-    message(FATAL_ERROR "WITH_ZPAGES is DEPRECATED.")
-  else()
-    message(WARNING "WITH_ZPAGES is DEPRECATED.")
-  endif()
-endif()
-
 #
 # Verify options dependencies
 #
@@ -480,7 +469,6 @@ endif()
 if(WITH_ELASTICSEARCH
    OR WITH_ZIPKIN
    OR WITH_OTLP_HTTP
-   OR WITH_ZPAGES
    OR BUILD_W3CTRACECONTEXT_TEST
    OR WITH_ETW)
   set(USE_NLOHMANN_JSON ON)

DEPRECATED.md

@@ -92,89 +92,7 @@ N/A
 
 ## [opentelemetry-cpp Exporter]
 
-### ZPages exporter
-
-#### Announcement (ZPages)
-
-* Version: 1.11.0
-* Date: 2023-09-01
-* PR: [DEPRECATION] Deprecate ZPAGES
-  [#2291](https://github.com/open-telemetry/opentelemetry-cpp/pull/2291)
-
-#### Motivation (ZPages)
-
-The ZPages specification itself was introduced in 2020,
-and has been experimental ever since,
-not getting a lot of attention, and never reaching a stable status.
-
-Several other opentelemetry projects have implemented support for zpages,
-only to later deprecate and then remove the zpages implementation (Java,
-C#), abandoning the zpages feature.
-
-In this context, it does not make sense to continue to maintain the zpages
-code in opentelemetry-cpp.
-
-#### Scope (ZPages)
-
-The following are deprecated and planned for removal:
-
-* all the API headers located under
-  `ext/include/opentelemetry/ext/zpages/`, including:
-  * the C++ class `ThreadsafeSpanData`
-  * the C++ class `TracezDataAggregator`
-  * the C++ class `TracezHttpServer`
-  * the C++ class `TracezSpanProcessor`
-  * the C++ class `TracezSharedData`
-  * the C++ class `ZPages`
-  * the C++ class `zPagesHttpServer`
-* all the code and doc located under `ext/src/zpages/`
-* all the tests located under `ext/test/zpages/`
-* the zpages exporter library(`opentelemetry_zpages`)
-* the zpages build options in CMake (`WITH_ZPAGES`)
-
-The following code is no longer considered public, will no longer be
-installed, and will no longer be useable outside of
-the opentelemetry-cpp implementation:
-
-* all the API headers located under
-  `ext/include/opentelemetry/ext/http/server`, including:
-  * the C++ class `FileHttpServer`
-  * the C++ class `HttpRequestCallback`
-  * the C++ class `HttpServer`
-  * the C++ class `HttpRequestHandler`
-  * the C++ class `SocketCallback`
-
-This implementation of an HTTP server is meant to be used for testing only,
-it is not production ready.
-
-#### Mitigation (ZPages)
-
-Consider using a different exporter,
-for example the OTLP exporter (both OTLP HTTP and OTLP GRPC are supported),
-to expose trace data to a separate trace backend.
-
-Note that this changes the access pattern:
-
-* with zpages, data is only available locally (in process)
-* with other exporters, data is available externally (not in process)
-
-Our assessment is that the zpages implementation is no longer in use,
-and can be removed.
-
-If that assessment is incorrect (i.e., if you own a project that depends
-on the zpage exporter from opentelemetry-cpp), please comment on the
-removal issue
-[#2292](https://github.com/open-telemetry/opentelemetry-cpp/issues/2292).
-
-An alternative to zpage removal is to move the code to the
-opentelemetry-cpp-contrib github
-[repository](https://github.com/open-telemetry/opentelemetry-cpp-contrib).
-
-Contributions to migrate the code, and maintain zpages, are welcome.
-
-#### Planned removal (ZPages)
-
-* Date: December, 2023
+N/A
 
 ## [Documentation]
 

INSTALL.md

@@ -124,10 +124,6 @@ You can link OpenTelemetry C++ SDK with libraries provided in
    -- Installing: /<install-root>/lib/cmake/opentelemetry-cpp/opentelemetry-cpp-config.cmake
    -- Installing: /<install-root>/lib/cmake/opentelemetry-cpp/opentelemetry-cpp-config-version.cmake
    ...
-   -- Installing: /<install-root>/include/opentelemetry//ext/zpages/static/tracez_index.h
-   -- Installing: /<install-root>/include/opentelemetry//ext/zpages/static/tracez_style.h
-   -- Installing: /<install-root>/include/opentelemetry//ext/zpages/threadsafe_span_data.h
-   -- Installing: /<install-root>/lib/libopentelemetry_zpages.a
    $
    ```
 

ci/do_ci.sh

@@ -459,8 +459,7 @@ elif [[ "$1" == "bazel.asan" ]]; then
 elif [[ "$1" == "bazel.tsan" ]]; then
 # TODO - potential race condition in Civetweb server used by prometheus-cpp during shutdown
 # https://github.com/civetweb/civetweb/issues/861, so removing prometheus from the test
-# zpages test failing with tsan. Ignoring the tests for now, as zpages will be removed soon.
-  bazel $BAZEL_STARTUP_OPTIONS test --config=tsan $BAZEL_TEST_OPTIONS_ASYNC  -- //... -//exporters/prometheus/...  -//ext/test/zpages/...
+  bazel $BAZEL_STARTUP_OPTIONS test --config=tsan $BAZEL_TEST_OPTIONS_ASYNC  -- //... -//exporters/prometheus/...
   exit 0
 elif [[ "$1" == "bazel.valgrind" ]]; then
   bazel $BAZEL_STARTUP_OPTIONS build $BAZEL_OPTIONS_ASYNC //...

cmake/opentelemetry-cpp-config.cmake.in

@@ -46,7 +46,6 @@
 #   opentelemetry-cpp::ostream_span_exporter             - Imported target of opentelemetry-cpp::ostream_span_exporter
 #   opentelemetry-cpp::elasticsearch_log_record_exporter - Imported target of opentelemetry-cpp::elasticsearch_log_record_exporter
 #   opentelemetry-cpp::etw_exporter                      - Imported target of opentelemetry-cpp::etw_exporter
-#   opentelemetry-cpp::zpages                            - Imported target of opentelemetry-cpp::zpages
 #   opentelemetry-cpp::http_client_curl                  - Imported target of opentelemetry-cpp::http_client_curl
 #   opentelemetry-cpp::opentracing_shim                  - Imported target of opentelemetry-cpp::opentracing_shim
 #
@@ -100,7 +99,6 @@ set(_OPENTELEMETRY_CPP_LIBRARIES_TEST_TARGETS
     prometheus_exporter
     elasticsearch_log_record_exporter
     etw_exporter
-    zpages
     http_client_curl
     opentracing_shim)
 foreach(_TEST_TARGET IN LISTS _OPENTELEMETRY_CPP_LIBRARIES_TEST_TARGETS)

docs/dependencies.md

@@ -92,9 +92,6 @@ Both these dependencies are listed here:
   - `libcurl` for connecting with Elasticsearch server over HTTP protocol.
   - `nlohmann/json` for encoding Elastic Search messages.
 
-- [Zpages](/ext/src/zpages):
-  - None
-
 - [Opentracing](/opentracing-shim)
   shim:
   - [`opentracing-cpp`](https://github.com/opentracing/opentracing-cpp)