[Code health] include-what-you-use cleanup, part 2 (#2704)

open-telemetry · Jul 6, 2024 · 6dbfdb5 · 6dbfdb5 · github-actions · Jul 6, 2024
1 parent 0ff58e8
commit 6dbfdb5
Show file tree

Hide file tree

Showing 86 changed files with 761 additions and 338 deletions.
diff --git a/.github/workflows/iwyu.yml b/.github/workflows/iwyu.yml
@@ -36,10 +36,18 @@ jobs:
           TOPDIR=`pwd`
           mkdir build && cd build
           CC="clang" CXX="clang++" cmake \
+            -DCMAKE_CXX_STANDARD=14 \
+            -DWITH_STL=CXX14 \
             -DCMAKE_CXX_INCLUDE_WHAT_YOU_USE="include-what-you-use;-w;-Xiwyu;--mapping_file=${TOPDIR}/.iwyu.imp;" \
             -DBUILD_TESTING=OFF \
             -DWITH_DEPRECATED_SDK_FACTORY=OFF \
             -DBUILD_W3CTRACECONTEXT_TEST=OFF \
+            -DWITH_OTLP_GRPC=OFF \
+            -DWITH_OTLP_HTTP=ON \
+            -DWITH_OTLP_FILE=ON \
+            -DWITH_OTLP_HTTP_COMPRESSION=ON \
+            -DWITH_ZIPKIN=ON \
+            -DWITH_PROMETHEUS=OFF \
             ..
 
       - name: iwyu_tool

diff --git a/api/include/opentelemetry/std/shared_ptr.h b/api/include/opentelemetry/std/shared_ptr.h
@@ -3,7 +3,9 @@
 
 #pragma once
 
-#include <memory>
+// IWYU pragma: private, include "opentelemetry/nostd/shared_ptr.h"
+
+#include <memory>  // IWYU pragma: export
 
 #include "opentelemetry/version.h"
 

diff --git a/api/include/opentelemetry/std/span.h b/api/include/opentelemetry/std/span.h
@@ -3,6 +3,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "opentelemetry/nostd/span.h"
+
 #include "opentelemetry/version.h"
 
 // Standard library implementation requires at least C++17 compiler.

diff --git a/api/include/opentelemetry/std/string_view.h b/api/include/opentelemetry/std/string_view.h
@@ -3,6 +3,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "opentelemetry/nostd/string_view.h"
+
 #include <string_view>
 
 #include "opentelemetry/version.h"

diff --git a/api/include/opentelemetry/std/type_traits.h b/api/include/opentelemetry/std/type_traits.h
@@ -3,6 +3,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "opentelemetry/nostd/type_traits.h"
+
 #include <type_traits>
 
 #include "opentelemetry/version.h"

diff --git a/api/include/opentelemetry/std/unique_ptr.h b/api/include/opentelemetry/std/unique_ptr.h
@@ -3,7 +3,9 @@
 
 #pragma once
 
-#include <memory>
+// IWYU pragma: private, include "opentelemetry/nostd/unique_ptr.h"
+
+#include <memory>  // IWYU pragma: export
 
 #include "opentelemetry/version.h"
 

diff --git a/api/include/opentelemetry/std/utility.h b/api/include/opentelemetry/std/utility.h
@@ -3,6 +3,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "opentelemetry/nostd/utility.h"
+
 #include <cstddef>
 #include <utility>
 

diff --git a/api/include/opentelemetry/std/variant.h b/api/include/opentelemetry/std/variant.h
@@ -3,6 +3,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "opentelemetry/nostd/variant.h"
+
 #include "opentelemetry/version.h"
 
 #include <cstddef>

diff --git a/cmake/opentelemetry-proto.cmake b/cmake/opentelemetry-proto.cmake
@@ -326,6 +326,12 @@ add_library(
   ${LOGS_SERVICE_PB_CPP_FILE}
   ${METRICS_SERVICE_PB_CPP_FILE})
 
+# Disable include-what-you-use on generated code.
+set_target_properties(
+  opentelemetry_proto
+  PROPERTIES CXX_INCLUDE_WHAT_YOU_USE ""
+)
+
 if(WITH_ABSEIL)
   target_link_libraries(opentelemetry_proto PUBLIC absl::bad_variant_access)
 endif()

diff --git a/examples/batch/main.cc b/examples/batch/main.cc
@@ -5,13 +5,11 @@
 #include <stdio.h>
 #include <chrono>
 #include <iostream>
-#include <memory>
 #include <string>
 #include <thread>
 #include <utility>
 
 #include "opentelemetry/exporters/ostream/span_exporter_factory.h"
-#include "opentelemetry/nostd/detail/decay.h"
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/sdk/resource/resource.h"
 #include "opentelemetry/sdk/trace/batch_span_processor_factory.h"
@@ -30,7 +28,6 @@ namespace trace_api      = opentelemetry::trace;
 namespace resource       = opentelemetry::sdk::resource;
 namespace trace_sdk      = opentelemetry::sdk::trace;
 namespace trace_exporter = opentelemetry::exporter::trace;
-namespace nostd          = opentelemetry::nostd;
 
 namespace
 {
@@ -69,7 +66,7 @@ void CleanupTracer()
   trace_api::Provider::SetTracerProvider(none);
 }
 
-nostd::shared_ptr<trace_api::Tracer> get_tracer()
+opentelemetry::nostd::shared_ptr<trace_api::Tracer> get_tracer()
 {
   auto provider = trace_api::Provider::GetTracerProvider();
   return provider->GetTracer("foo_library");

diff --git a/examples/common/foo_library/foo_library.cc b/examples/common/foo_library/foo_library.cc
@@ -3,7 +3,6 @@
 
 #include "opentelemetry/context/context_value.h"
 #include "opentelemetry/nostd/shared_ptr.h"
-#include "opentelemetry/nostd/unique_ptr.h"
 #include "opentelemetry/sdk/version/version.h"
 #include "opentelemetry/trace/provider.h"
 #include "opentelemetry/trace/scope.h"

diff --git a/examples/common/logs_foo_library/foo_library.cc b/examples/common/logs_foo_library/foo_library.cc
@@ -16,17 +16,16 @@
 
 namespace logs  = opentelemetry::logs;
 namespace trace = opentelemetry::trace;
-namespace nostd = opentelemetry::nostd;
 
 namespace
 {
-nostd::shared_ptr<trace::Tracer> get_tracer()
+opentelemetry::nostd::shared_ptr<trace::Tracer> get_tracer()
 {
   auto provider = trace::Provider::GetTracerProvider();
   return provider->GetTracer("foo_library", OPENTELEMETRY_SDK_VERSION);
 }
 
-nostd::shared_ptr<logs::Logger> get_logger()
+opentelemetry::nostd::shared_ptr<logs::Logger> get_logger()
 {
   auto provider = logs::Provider::GetLoggerProvider();
   return provider->GetLogger("foo_library_logger", "foo_library");

diff --git a/examples/common/metrics_foo_library/foo_library.cc b/examples/common/metrics_foo_library/foo_library.cc
@@ -17,17 +17,17 @@
 #include "opentelemetry/metrics/meter_provider.h"
 #include "opentelemetry/metrics/observer_result.h"
 #include "opentelemetry/metrics/provider.h"
+#include "opentelemetry/metrics/sync_instruments.h"
 #include "opentelemetry/nostd/shared_ptr.h"
-#include "opentelemetry/nostd/unique_ptr.h"
 #include "opentelemetry/nostd/variant.h"
 
-namespace nostd       = opentelemetry::nostd;
 namespace metrics_api = opentelemetry::metrics;
 
 namespace
 {
 
-static nostd::shared_ptr<metrics_api::ObservableInstrument> double_observable_counter;
+static opentelemetry::nostd::shared_ptr<metrics_api::ObservableInstrument>
+    double_observable_counter;
 
 std::map<std::string, std::string> get_random_attr()
 {
@@ -45,13 +45,15 @@ class MeasurementFetcher
 public:
   static void Fetcher(opentelemetry::metrics::ObserverResult observer_result, void * /* state */)
   {
-    if (nostd::holds_alternative<
-            nostd::shared_ptr<opentelemetry::metrics::ObserverResultT<double>>>(observer_result))
+    if (opentelemetry::nostd::holds_alternative<
+            opentelemetry::nostd::shared_ptr<opentelemetry::metrics::ObserverResultT<double>>>(
+            observer_result))
     {
       double random_incr = (rand() % 5) + 1.1;
       value_ += random_incr;
       std::map<std::string, std::string> labels = get_random_attr();
-      nostd::get<nostd::shared_ptr<opentelemetry::metrics::ObserverResultT<double>>>(
+      opentelemetry::nostd::get<
+          opentelemetry::nostd::shared_ptr<opentelemetry::metrics::ObserverResultT<double>>>(
           observer_result)
           ->Observe(value_, labels);
     }
@@ -63,10 +65,10 @@ double MeasurementFetcher::value_ = 0.0;
 
 void foo_library::counter_example(const std::string &name)
 {
-  std::string counter_name                    = name + "_counter";
-  auto provider                               = metrics_api::Provider::GetMeterProvider();
-  nostd::shared_ptr<metrics_api::Meter> meter = provider->GetMeter(name, "1.2.0");
-  auto double_counter                         = meter->CreateDoubleCounter(counter_name);
+  std::string counter_name = name + "_counter";
+  auto provider            = metrics_api::Provider::GetMeterProvider();
+  opentelemetry::nostd::shared_ptr<metrics_api::Meter> meter = provider->GetMeter(name, "1.2.0");
+  auto double_counter = meter->CreateDoubleCounter(counter_name);
 
   for (uint32_t i = 0; i < 20; ++i)
   {
@@ -78,10 +80,10 @@ void foo_library::counter_example(const std::string &name)
 
 void foo_library::observable_counter_example(const std::string &name)
 {
-  std::string counter_name                    = name + "_observable_counter";
-  auto provider                               = metrics_api::Provider::GetMeterProvider();
-  nostd::shared_ptr<metrics_api::Meter> meter = provider->GetMeter(name, "1.2.0");
-  double_observable_counter                   = meter->CreateDoubleObservableCounter(counter_name);
+  std::string counter_name = name + "_observable_counter";
+  auto provider            = metrics_api::Provider::GetMeterProvider();
+  opentelemetry::nostd::shared_ptr<metrics_api::Meter> meter = provider->GetMeter(name, "1.2.0");
+  double_observable_counter = meter->CreateDoubleObservableCounter(counter_name);
   double_observable_counter->AddCallback(MeasurementFetcher::Fetcher, nullptr);
   for (uint32_t i = 0; i < 20; ++i)
   {
@@ -91,9 +93,9 @@ void foo_library::observable_counter_example(const std::string &name)
 
 void foo_library::histogram_example(const std::string &name)
 {
-  std::string histogram_name                  = name + "_histogram";
-  auto provider                               = metrics_api::Provider::GetMeterProvider();
-  nostd::shared_ptr<metrics_api::Meter> meter = provider->GetMeter(name, "1.2.0");
+  std::string histogram_name = name + "_histogram";
+  auto provider              = metrics_api::Provider::GetMeterProvider();
+  opentelemetry::nostd::shared_ptr<metrics_api::Meter> meter = provider->GetMeter(name, "1.2.0");
   auto histogram_counter = meter->CreateDoubleHistogram(histogram_name, "des", "unit");
   auto context           = opentelemetry::context::Context{};
   for (uint32_t i = 0; i < 20; ++i)

diff --git a/examples/multithreaded/main.cc b/examples/multithreaded/main.cc
@@ -2,14 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include <algorithm>
-#include <memory>
 #include <string>
 #include <thread>
 #include <utility>
 #include <vector>
 
 #include "opentelemetry/exporters/ostream/span_exporter_factory.h"
-#include "opentelemetry/nostd/detail/decay.h"
 #include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/sdk/resource/resource.h"
 #include "opentelemetry/sdk/trace/processor.h"
@@ -25,7 +23,6 @@
 
 namespace trace_api = opentelemetry::trace;
 namespace trace_sdk = opentelemetry::sdk::trace;
-namespace nostd     = opentelemetry::nostd;
 
 namespace
 {
@@ -46,7 +43,7 @@ void CleanupTracer()
   trace_api::Provider::SetTracerProvider(none);
 }
 
-nostd::shared_ptr<trace_api::Tracer> get_tracer()
+opentelemetry::nostd::shared_ptr<trace_api::Tracer> get_tracer()
 {
   auto provider = trace_api::Provider::GetTracerProvider();
   return provider->GetTracer("foo_library");

diff --git a/examples/otlp/file_log_main.cc b/examples/otlp/file_log_main.cc
@@ -1,27 +1,32 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <functional>
+#include <iostream>
+#include <string>
+#include <utility>
+
 #include "opentelemetry/exporters/otlp/otlp_file_client_options.h"
 #include "opentelemetry/exporters/otlp/otlp_file_exporter_factory.h"
 #include "opentelemetry/exporters/otlp/otlp_file_exporter_options.h"
 #include "opentelemetry/exporters/otlp/otlp_file_log_record_exporter_factory.h"
 #include "opentelemetry/exporters/otlp/otlp_file_log_record_exporter_options.h"
+#include "opentelemetry/logs/log_record.h"
+#include "opentelemetry/logs/logger_provider.h"
 #include "opentelemetry/logs/provider.h"
-#include "opentelemetry/sdk/logs/exporter.h"
+#include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/sdk/logs/logger_provider.h"
 #include "opentelemetry/sdk/logs/logger_provider_factory.h"
-#include "opentelemetry/sdk/logs/processor.h"
+#include "opentelemetry/sdk/logs/recordable.h"
 #include "opentelemetry/sdk/logs/simple_log_record_processor_factory.h"
-#include "opentelemetry/sdk/trace/exporter.h"
 #include "opentelemetry/sdk/trace/processor.h"
+#include "opentelemetry/sdk/trace/recordable.h"
 #include "opentelemetry/sdk/trace/simple_processor_factory.h"
 #include "opentelemetry/sdk/trace/tracer_provider.h"
 #include "opentelemetry/sdk/trace/tracer_provider_factory.h"
 #include "opentelemetry/trace/provider.h"
-
-#include <iostream>
-#include <string>
-#include <utility>
+#include "opentelemetry/trace/span_id.h"
+#include "opentelemetry/trace/tracer_provider.h"
 
 #ifdef BAZEL_BUILD
 #  include "examples/common/logs_foo_library/foo_library.h"

diff --git a/examples/otlp/file_main.cc b/examples/otlp/file_main.cc
@@ -1,16 +1,21 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <memory>
+#include <string>
+#include <utility>
+
+#include "opentelemetry/exporters/otlp/otlp_file_client_options.h"
 #include "opentelemetry/exporters/otlp/otlp_file_exporter_factory.h"
+#include "opentelemetry/exporters/otlp/otlp_file_exporter_options.h"
 #include "opentelemetry/sdk/trace/processor.h"
+#include "opentelemetry/sdk/trace/recordable.h"
 #include "opentelemetry/sdk/trace/simple_processor_factory.h"
 #include "opentelemetry/sdk/trace/tracer_provider.h"
 #include "opentelemetry/sdk/trace/tracer_provider_factory.h"
 #include "opentelemetry/trace/provider.h"
-
-#include <iostream>
-#include <string>
-#include <utility>
+#include "opentelemetry/trace/span_id.h"
+#include "opentelemetry/trace/tracer_provider.h"
 
 #ifdef BAZEL_BUILD
 #  include "examples/common/foo_library/foo_library.h"

diff --git a/examples/otlp/file_metric_main.cc b/examples/otlp/file_metric_main.cc
@@ -1,21 +1,26 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <chrono>
+#include <memory>
+#include <string>
+#include <thread>
+#include <utility>
+
+#include "opentelemetry/common/attribute_value.h"
+#include "opentelemetry/exporters/otlp/otlp_file_client_options.h"
 #include "opentelemetry/exporters/otlp/otlp_file_metric_exporter_factory.h"
+#include "opentelemetry/exporters/otlp/otlp_file_metric_exporter_options.h"
+#include "opentelemetry/metrics/meter_provider.h"
 #include "opentelemetry/metrics/provider.h"
-#include "opentelemetry/sdk/metrics/aggregation/default_aggregation.h"
-#include "opentelemetry/sdk/metrics/export/periodic_exporting_metric_reader.h"
 #include "opentelemetry/sdk/metrics/export/periodic_exporting_metric_reader_factory.h"
-#include "opentelemetry/sdk/metrics/meter.h"
+#include "opentelemetry/sdk/metrics/export/periodic_exporting_metric_reader_options.h"
+#include "opentelemetry/sdk/metrics/meter_context.h"
 #include "opentelemetry/sdk/metrics/meter_context_factory.h"
-#include "opentelemetry/sdk/metrics/meter_provider.h"
 #include "opentelemetry/sdk/metrics/meter_provider_factory.h"
-
-#include <iostream>
-#include <memory>
-#include <string>
-#include <thread>
-#include <utility>
+#include "opentelemetry/sdk/metrics/metric_reader.h"
+#include "opentelemetry/sdk/metrics/push_metric_exporter.h"
+#include "opentelemetry/sdk/metrics/state/filtered_ordered_attribute_map.h"
 
 #ifdef BAZEL_BUILD
 #  include "examples/common/metrics_foo_library/foo_library.h"