cleanup

Author: marcalff

CHANGELOG.md

@@ -26,8 +26,10 @@ New features:
 * [SDK] Better control of threads executed by opentelemetry-cpp
   [#3175](https://github.com/open-telemetry/opentelemetry-cpp/pull/3175)
 
-  * This feature provides a way for applications, when configuring the SDK and exporters,
-    to participate in the execution path of internal opentelemetry-cpp threads.
+  * This feature provides a way for applications,
+    when configuring the SDK and exporters,
+    to participate in the execution path
+    of internal opentelemetry-cpp threads.
 
   * The opentelemetry-cpp library provides the following:
 
@@ -36,15 +38,18 @@ New features:
       * BatchSpanProcessorRuntimeOptions
       * PeriodicExportingMetricReaderRuntimeOptions
       * BatchLogRecordProcessorRuntimeOptions
-    * new runtime options structures, to optionally configure the OTLP HTTP exporters:
+    * new runtime options structures,
+      to optionally configure the OTLP HTTP exporters:
       * OtlpHttpExporterRuntimeOptions
       * OtlpHttpMetricExporterRuntimeOptions
       * OtlpHttpLogRecordExporterRuntimeOptions
-    * new ThreadInstrumentation parameters, to optionally configure the CURL HttpClient
+    * new ThreadInstrumentation parameters,
+      to optionally configure the CURL HttpClient
 
   * Using the optional runtime options structures,
     an application can subclass the ThreadInstrumentation interface,
-    and be notified of specific events of interest during the execution of an internal opentelemetry-cpp thread.
+    and be notified of specific events of interest during the execution
+    of an internal opentelemetry-cpp thread.
 
   * This allows an application to call, for example:
 
@@ -55,7 +60,8 @@ New features:
 
   * See the documentation for ThreadInstrumentation for details.
 
-  * A new example program, example_otlp_instrumented_http, shows how to use the feature,
+  * A new example program, example_otlp_instrumented_http,
+    shows how to use the feature,
     and add application logic in the thread execution code path.
 
 ## [1.18 2024-11-25]

examples/otlp/http_instrumented_main.cc

@@ -58,6 +58,20 @@ namespace
 
 std::mutex serialize;
 
+/**
+ The purpose of MyThreadInstrumentation is to demonstrate
+ how notifications are delivered to the application.
+
+ Printing to std::cout is useful for debugging,
+ to understand the overall thread execution in the library.
+
+ In production, a real application would instead:
+ - set thread priorities / CPU affinity
+ - set thread local storage keys
+ - set a thread name to the operating system
+ - set network namespaces
+ in the OnXXX() code here.
+*/
 class MyThreadInstrumentation : public opentelemetry::sdk::common::ThreadInstrumentation
 {
 public:
@@ -272,8 +286,8 @@ void CleanupLogger()
 
 /*
   Usage:
-  - example_otlp_http
-  - example_otlp_http <TRACE_URL> <METRIC_URL> <LOG_URL>
+  - example_otlp_instrumented_http
+  - example_otlp_instrumented_http <TRACE_URL> <METRIC_URL> <LOG_URL>
 */
 int main(int argc, char *argv[])
 {