User-events log exporter - cleanup public API (#174)

Author: cijothomas

.cspell.json

@@ -42,6 +42,7 @@
         "Kumar",
         "Lalit",
         "msrv",
+        "myprovider",
         "Ochtman",
         "openetelemetry",
         "opentelemetry",

opentelemetry-user-events-logs/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## vNext
 
+- Removed provider group from being appended to the tracepoint name.
+  For example, tracepoint `myprovider_L2K1Gmyprovider` becomes `myprovider_L2K1`.
+- Added the `with_user_event_exporter` trait method to `LoggerProviderBuilder`.
+  This is now the only way to add a user-events exporter. The following line
+  will add a user-events exporter using the given provider name:
+
+  ```rust
+  SdkLoggerProvider::builder().with_user_event_exporter("my-provider").build();
+  ```
+
+- Removed `opentelemetry_user_events_logs::{ExporterConfig, ReentrantLogProcessor, UserEventsExporter}` from the public API. Ability to customize Provider Group, Keyword will be added future.
+
 ## v0.9.0
 
 - Bump msrv to 1.75.0

opentelemetry-user-events-logs/examples/basic-logs.rs

@@ -2,8 +2,7 @@
 
 use opentelemetry_appender_tracing::layer;
 use opentelemetry_sdk::logs::SdkLoggerProvider;
-use opentelemetry_user_events_logs::{ExporterConfig, ReentrantLogProcessor, UserEventsExporter};
-use std::collections::HashMap;
+use opentelemetry_user_events_logs::UserEventsLoggerProviderBuilderExt;
 use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::Arc;
 use std::{thread, time::Duration};
@@ -15,14 +14,8 @@ fn init_logger() -> SdkLoggerProvider {
     let fmt_layer = tracing_subscriber::fmt::layer().with_filter(filter_fmt);
     let _guard = tracing_subscriber::registry().with(fmt_layer).set_default(); // Temporary subscriber active for this function
 
-    let exporter_config = ExporterConfig {
-        default_keyword: 1,
-        keywords_map: HashMap::new(),
-    };
-    let exporter = UserEventsExporter::new("test", None, exporter_config);
-    let reenterant_processor = ReentrantLogProcessor::new(exporter);
     SdkLoggerProvider::builder()
-        .with_log_processor(reenterant_processor)
+        .with_user_event_exporter("myprovider")
         .build()
 }
 

opentelemetry-user-events-logs/src/logs/mod.rs

@@ -1,5 +1,39 @@
-mod exporter;
-pub use exporter::*;
+use std::collections::HashMap;
+
+use exporter::{ExporterConfig, UserEventsExporter};
+use opentelemetry_sdk::logs::LoggerProviderBuilder;
+use reentrant_logprocessor::ReentrantLogProcessor;
 
+mod exporter;
 mod reentrant_logprocessor;
-pub use reentrant_logprocessor::*;
+
+/// Extension trait for adding a user event exporter to the logger provider builder.
+pub trait UserEventsLoggerProviderBuilderExt {
+    /// Adds a user event exporter to the logger provider builder with the given provider name.
+    ///
+    /// Tracepoint names are generated by combining the provider name with the event level and keyword
+    /// in the following format:
+    /// `ProviderName + '_' + 'L' + EventLevel + 'K' + EventKeyword`
+    ///
+    /// For example, if "myprovider" is the provider name, the following tracepoint names are created:
+    /// - `myprovider_L4K1`
+    /// - `myprovider_L5K1`
+    /// - `myprovider_L3K1`
+    /// - `myprovider_L2K1`
+    /// - `myprovider_L1K1`
+    ///
+    /// Note that the `EventKeyword` is currently hardcoded to be `1`.
+    fn with_user_event_exporter(self, provider_name: &str) -> Self;
+}
+
+impl UserEventsLoggerProviderBuilderExt for LoggerProviderBuilder {
+    fn with_user_event_exporter(self, provider_name: &str) -> Self {
+        let exporter_config = ExporterConfig {
+            default_keyword: 1,
+            keywords_map: HashMap::new(),
+        };
+        let exporter = UserEventsExporter::new(provider_name, None, exporter_config);
+        let reenterant_processor = ReentrantLogProcessor::new(exporter);
+        self.with_log_processor(reenterant_processor)
+    }
+}

stress/src/user_events.rs

@@ -24,22 +24,15 @@
 
 use opentelemetry_appender_tracing::layer;
 use opentelemetry_sdk::logs::SdkLoggerProvider;
-use opentelemetry_user_events_logs::{ExporterConfig, ReentrantLogProcessor, UserEventsExporter};
-use std::collections::HashMap;
+use opentelemetry_user_events_logs::UserEventsLoggerProviderBuilderExt;
 use tracing::info;
 use tracing_subscriber::prelude::*;
 mod throughput;
 
 // Function to initialize the logger
 fn init_logger() -> SdkLoggerProvider {
-    let exporter_config = ExporterConfig {
-        default_keyword: 1,
-        keywords_map: HashMap::new(),
-    };
-    let exporter = UserEventsExporter::new("testprovider", None, exporter_config);
-    let reentrant_processor = ReentrantLogProcessor::new(exporter);
     SdkLoggerProvider::builder()
-        .with_log_processor(reentrant_processor)
+        .with_user_event_exporter("provider_name")
         .build()
 }