[Code health] include-what-you-use cleanup (#2692)

open-telemetry · Jun 15, 2024 · f97dc06 · f97dc06 · github-actions · Jun 15, 2024
1 parent fad93f0
commit f97dc06
Show file tree

Hide file tree

Showing 103 changed files with 879 additions and 394 deletions.
diff --git a/.github/workflows/iwyu.yml b/.github/workflows/iwyu.yml
@@ -38,6 +38,7 @@ jobs:
           CC="clang" CXX="clang++" cmake \
             -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 \
             ..
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,9 @@ Increment the:
 * [API/SDK] Provider cleanup
   [#2664](https://github.com/open-telemetry/opentelemetry-cpp/pull/2664)
 
+* [Code health] include-what-you-use cleanup
+  [#2692](https://github.com/open-telemetry/opentelemetry-cpp/pull/2692)
+
 Important changes:
 
 * [API/SDK] Provider cleanup

diff --git a/api/include/opentelemetry/nostd/type_traits.h b/api/include/opentelemetry/nostd/type_traits.h
@@ -15,7 +15,7 @@
 #  include <type_traits>
 
 #  include "opentelemetry/config.h"
-#  include "opentelemetry/nostd/detail/void.h"
+#  include "opentelemetry/nostd/detail/void.h"  // IWYU pragma: export
 #  include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE

diff --git a/api/include/opentelemetry/nostd/utility.h b/api/include/opentelemetry/nostd/utility.h
@@ -15,8 +15,8 @@
 #  include <initializer_list>
 #  include <type_traits>
 
-#  include "opentelemetry/nostd/detail/decay.h"
-#  include "opentelemetry/nostd/detail/invoke.h"
+#  include "opentelemetry/nostd/detail/decay.h"   // IWYU pragma: export
+#  include "opentelemetry/nostd/detail/invoke.h"  // IWYU pragma: export
 #  include "opentelemetry/version.h"
 
 OPENTELEMETRY_BEGIN_NAMESPACE

diff --git a/api/include/opentelemetry/plugin/detail/dynamic_load_unix.h b/api/include/opentelemetry/plugin/detail/dynamic_load_unix.h
@@ -3,11 +3,10 @@
 
 #pragma once
 
+#include <dlfcn.h>
 #include <algorithm>
 #include <memory>
 
-#include <dlfcn.h>
-
 #include "opentelemetry/plugin/detail/dynamic_library_handle.h"
 #include "opentelemetry/plugin/detail/loader_info.h"
 #include "opentelemetry/plugin/detail/utility.h"

diff --git a/api/include/opentelemetry/plugin/dynamic_load.h b/api/include/opentelemetry/plugin/dynamic_load.h
@@ -7,9 +7,9 @@
 #include <string>
 
 #ifdef _WIN32
-#  include "opentelemetry/plugin/detail/dynamic_load_windows.h"
+#  include "opentelemetry/plugin/detail/dynamic_load_windows.h"  // IWYU pragma: export
 #else
-#  include "opentelemetry/plugin/detail/dynamic_load_unix.h"
+#  include "opentelemetry/plugin/detail/dynamic_load_unix.h"  // IWYU pragma: export
 #endif
 #include "opentelemetry/version.h"
 

diff --git a/api/include/opentelemetry/plugin/factory.h b/api/include/opentelemetry/plugin/factory.h
@@ -6,7 +6,7 @@
 #include <memory>
 #include <string>
 
-#include "opentelemetry/plugin/detail/utility.h"
+#include "opentelemetry/plugin/detail/utility.h"  // IWYU pragma: export
 #include "opentelemetry/plugin/tracer.h"
 #include "opentelemetry/version.h"
 

diff --git a/api/include/opentelemetry/plugin/tracer.h b/api/include/opentelemetry/plugin/tracer.h
@@ -6,7 +6,7 @@
 #include <memory>
 
 #include "opentelemetry/common/key_value_iterable.h"
-#include "opentelemetry/plugin/detail/tracer_handle.h"
+#include "opentelemetry/plugin/detail/tracer_handle.h"  // IWYU pragma: export
 #include "opentelemetry/trace/span_context_kv_iterable.h"
 #include "opentelemetry/trace/tracer.h"
 #include "opentelemetry/version.h"

diff --git a/examples/batch/main.cc b/examples/batch/main.cc
@@ -1,17 +1,29 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <stdint.h>
+#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"
 #include "opentelemetry/sdk/trace/batch_span_processor_options.h"
-#include "opentelemetry/sdk/trace/exporter.h"
 #include "opentelemetry/sdk/trace/processor.h"
+#include "opentelemetry/sdk/trace/recordable.h"
+#include "opentelemetry/sdk/trace/tracer_provider.h"
 #include "opentelemetry/sdk/trace/tracer_provider_factory.h"
 #include "opentelemetry/trace/provider.h"
-
-#include <chrono>
-#include <thread>
+#include "opentelemetry/trace/span_id.h"
+#include "opentelemetry/trace/tracer.h"
+#include "opentelemetry/trace/tracer_provider.h"
 
 constexpr int kNumSpans  = 10;
 namespace trace_api      = opentelemetry::trace;

diff --git a/examples/common/foo_library/foo_library.cc b/examples/common/foo_library/foo_library.cc
@@ -1,8 +1,14 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#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"
+#include "opentelemetry/trace/tracer.h"
+#include "opentelemetry/trace/tracer_provider.h"
 
 namespace trace = opentelemetry::trace;
 namespace nostd = opentelemetry::nostd;

diff --git a/examples/common/logs_foo_library/foo_library.cc b/examples/common/logs_foo_library/foo_library.cc
@@ -1,11 +1,18 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#include <map>
-#include <string>
+#include "opentelemetry/logs/log_record.h"
+#include "opentelemetry/logs/logger.h"
+#include "opentelemetry/logs/logger_provider.h"
 #include "opentelemetry/logs/provider.h"
+#include "opentelemetry/nostd/shared_ptr.h"
 #include "opentelemetry/sdk/version/version.h"
 #include "opentelemetry/trace/provider.h"
+#include "opentelemetry/trace/scope.h"
+#include "opentelemetry/trace/span.h"
+#include "opentelemetry/trace/span_context.h"
+#include "opentelemetry/trace/tracer.h"
+#include "opentelemetry/trace/tracer_provider.h"
 
 namespace logs  = opentelemetry::logs;
 namespace trace = opentelemetry::trace;

diff --git a/examples/common/metrics_foo_library/foo_library.cc b/examples/common/metrics_foo_library/foo_library.cc
@@ -1,15 +1,25 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#include "foo_library.h"
+#include <stdint.h>
+#include <stdlib.h>
 #include <chrono>
 #include <map>
-#include <memory>
 #include <thread>
+#include <utility>
 #include <vector>
+
+#include "foo_library.h"
+#include "opentelemetry/common/key_value_iterable_view.h"
 #include "opentelemetry/context/context.h"
+#include "opentelemetry/metrics/async_instruments.h"
+#include "opentelemetry/metrics/meter.h"
+#include "opentelemetry/metrics/meter_provider.h"
+#include "opentelemetry/metrics/observer_result.h"
 #include "opentelemetry/metrics/provider.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;

diff --git a/examples/logs_simple/main.cc b/examples/logs_simple/main.cc
@@ -1,19 +1,26 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <memory>
+#include <utility>
+
 #include "opentelemetry/exporters/ostream/log_record_exporter.h"
 #include "opentelemetry/exporters/ostream/span_exporter_factory.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/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 "opentelemetry/trace/tracer_provider.h"
 
 #ifdef BAZEL_BUILD
 #  include "examples/common/logs_foo_library/foo_library.h"

diff --git a/examples/metrics_simple/metrics_ostream.cc b/examples/metrics_simple/metrics_ostream.cc
@@ -1,20 +1,31 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <chrono>
 #include <memory>
+#include <string>
 #include <thread>
+#include <utility>
+#include <vector>
 
+#include "opentelemetry/common/attribute_value.h"
 #include "opentelemetry/exporters/ostream/metric_exporter_factory.h"
+#include "opentelemetry/metrics/meter_provider.h"
 #include "opentelemetry/metrics/provider.h"
-#include "opentelemetry/sdk/metrics/aggregation/default_aggregation.h"
-#include "opentelemetry/sdk/metrics/aggregation/histogram_aggregation.h"
+#include "opentelemetry/sdk/metrics/aggregation/aggregation_config.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/instruments.h"
 #include "opentelemetry/sdk/metrics/meter_provider.h"
 #include "opentelemetry/sdk/metrics/meter_provider_factory.h"
+#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"
+#include "opentelemetry/sdk/metrics/view/instrument_selector.h"
 #include "opentelemetry/sdk/metrics/view/instrument_selector_factory.h"
+#include "opentelemetry/sdk/metrics/view/meter_selector.h"
 #include "opentelemetry/sdk/metrics/view/meter_selector_factory.h"
+#include "opentelemetry/sdk/metrics/view/view.h"
 #include "opentelemetry/sdk/metrics/view/view_factory.h"
 
 #ifdef BAZEL_BUILD

diff --git a/examples/multi_processor/main.cc b/examples/multi_processor/main.cc
@@ -1,13 +1,29 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <algorithm>
+#include <iostream>
+#include <memory>
+#include <string>
+#include <type_traits>
+#include <utility>
+#include <vector>
+
 #include "opentelemetry/exporters/memory/in_memory_span_data.h"
 #include "opentelemetry/exporters/memory/in_memory_span_exporter_factory.h"
 #include "opentelemetry/exporters/ostream/span_exporter_factory.h"
+#include "opentelemetry/nostd/string_view.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_context.h"
+#include "opentelemetry/sdk/trace/span_data.h"
+#include "opentelemetry/sdk/trace/tracer_provider.h"
 #include "opentelemetry/sdk/trace/tracer_provider_factory.h"
 #include "opentelemetry/trace/provider.h"
+#include "opentelemetry/trace/span_id.h"
+#include "opentelemetry/trace/span_metadata.h"
+#include "opentelemetry/trace/trace_id.h"
+#include "opentelemetry/trace/tracer_provider.h"
 
 #ifdef BAZEL_BUILD
 #  include "examples/common/foo_library/foo_library.h"

diff --git a/examples/multithreaded/main.cc b/examples/multithreaded/main.cc
@@ -1,17 +1,27 @@
 // Copyright The OpenTelemetry Authors
 // 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/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 "opentelemetry/trace/scope.h"
-
-#include <algorithm>
-#include <thread>
+#include "opentelemetry/trace/span_id.h"
+#include "opentelemetry/trace/tracer.h"
+#include "opentelemetry/trace/tracer_provider.h"
 
 namespace trace_api = opentelemetry::trace;
 namespace trace_sdk = opentelemetry::sdk::trace;

diff --git a/examples/plugin/load/main.cc b/examples/plugin/load/main.cc
@@ -1,15 +1,17 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#include "opentelemetry/plugin/dynamic_load.h"
-
-#include <cstring>
+#include <cstdio>
 #include <fstream>
 #include <iostream>
 #include <iterator>
 #include <memory>
 #include <string>
 
+#include "opentelemetry/plugin/dynamic_load.h"
+#include "opentelemetry/plugin/factory.h"
+#include "opentelemetry/trace/tracer.h"
+
 int main(int argc, char *argv[])
 {
   if (argc != 3)

diff --git a/examples/plugin/plugin/factory_impl.cc b/examples/plugin/plugin/factory_impl.cc
@@ -1,8 +1,15 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#include <memory>
+#include <new>
+#include <utility>
+
+#include "opentelemetry/nostd/string_view.h"
+#include "opentelemetry/nostd/unique_ptr.h"
 #include "opentelemetry/plugin/factory.h"
 #include "opentelemetry/plugin/hook.h"
+#include "opentelemetry/plugin/tracer.h"
 #include "tracer.h"
 
 namespace nostd  = opentelemetry::nostd;

diff --git a/examples/plugin/plugin/tracer.cc b/examples/plugin/plugin/tracer.cc
@@ -1,11 +1,19 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-#include "tracer.h"
-#include "opentelemetry/nostd/unique_ptr.h"
-
 #include <iostream>
 #include <memory>
+#include <new>
+#include <string>
+#include <utility>
+
+#include "opentelemetry/common/attribute_value.h"
+#include "opentelemetry/common/timestamp.h"
+#include "opentelemetry/context/context_value.h"
+#include "opentelemetry/nostd/unique_ptr.h"
+#include "opentelemetry/trace/span_context.h"
+#include "opentelemetry/trace/span_metadata.h"
+#include "tracer.h"
 
 namespace nostd   = opentelemetry::nostd;
 namespace common  = opentelemetry::common;

diff --git a/examples/plugin/plugin/tracer.h b/examples/plugin/plugin/tracer.h
@@ -3,8 +3,15 @@
 
 #pragma once
 
+#include <stdint.h>
 #include <memory>
 
+#include "opentelemetry/common/key_value_iterable.h"
+#include "opentelemetry/nostd/shared_ptr.h"
+#include "opentelemetry/nostd/string_view.h"
+#include "opentelemetry/trace/span.h"
+#include "opentelemetry/trace/span_context_kv_iterable.h"
+#include "opentelemetry/trace/span_startoptions.h"
 #include "opentelemetry/trace/tracer.h"
 
 class Tracer final : public opentelemetry::trace::Tracer,
Benchmark suite	Current: `f97dc06`	Previous: `fad93f0`	Ratio
`BM_SpinLockThrashing/2/process_time/real_time`	`0.4602362089650832` ms/iter	`0.17294507748791213` ms/iter	`2.66`
`BM_SpinLockThrashing/4/process_time/real_time`	`1.7459844720774684` ms/iter	`0.7851088919290682` ms/iter	`2.22`