refactor: Rename span event methods to simplify API and remove example

Author: alessandrobologna

CHANGELOG.md

@@ -2,11 +2,9 @@
 
 ### Added
 
-- Add `OpenTelemetrySpanExt::add_otel_span_event` function to allow adding OpenTelemetry
-  events directly to a `tracing::Span`, enabling the use of dynamic attribute keys.
-- Add `OpenTelemetrySpanExt::add_otel_span_event_with_timestamp` function, similar to
-  `add_otel_span_event`, but allowing a specific `SystemTime` to be provided for the event.
-- Add `examples/opentelemetry-span-event.rs` demonstrating the usage of the new span event methods.
+- Add `OpenTelemetrySpanExt::add_event` and `OpenTelemetrySpanExt::add_event_with_timestamp` 
+  functions to allow adding OpenTelemetry events directly to a `tracing::Span`, enabling the use of dynamic attribute keys 
+  and custom event timestamps.
 
 # 0.30.0 (March 23, 2025)
 

README.md

@@ -45,7 +45,7 @@ The crate provides the following types:
   injected and extracted from a `tracing` [span]. It also provides methods
   to directly set span attributes (`set_attribute`), span status (`set_status`),
   and add OpenTelemetry events with dynamic attributes using the current time
-  (`add_otel_span_event`) or a specific timestamp (`add_otel_span_event_with_timestamp`).
+  (`add_event`) or a specific timestamp (`add_event_with_timestamp`).
 
 [`OpenTelemetryLayer`]: https://docs.rs/tracing-opentelemetry/latest/tracing_opentelemetry/struct.OpenTelemetryLayer.html
 [`OpenTelemetrySpanExt`]: https://docs.rs/tracing-opentelemetry/latest/tracing_opentelemetry/trait.OpenTelemetrySpanExt.html

examples/opentelemetry-span-event.rs

@@ -177,18 +177,18 @@ pub trait OpenTelemetrySpanExt {
     /// ];
     ///
     /// // Add event using the extension method
-    /// app_root.add_otel_span_event("job_started".to_string(), dynamic_attrs);
+    /// app_root.add_event("job_started".to_string(), dynamic_attrs);
     ///
     /// // ... perform work ...
     ///
-    /// app_root.add_otel_span_event("job_completed", vec![KeyValue::new("status", "success")]);
+    /// app_root.add_event("job_completed", vec![KeyValue::new("status", "success")]);
     /// ```
-    fn add_otel_span_event<T>(&self, name: T, attributes: Vec<KeyValue>)
+    fn add_event<T>(&self, name: T, attributes: Vec<KeyValue>)
     where
         T: Into<Cow<'static, str>>;
 
     /// Adds an OpenTelemetry event with a specific timestamp directly to this span.
-    /// Similar to `add_otel_span_event`, but allows overriding the event timestamp.
+    /// Similar to `add_event`, but allows overriding the event timestamp.
     ///
     /// # Examples
     ///
@@ -205,9 +205,9 @@ pub trait OpenTelemetrySpanExt {
     /// let event_attrs = vec![KeyValue::new("record_id", "rec-456")];
     /// let event_name: Cow<'static, str> = "event_from_past".into();
     ///
-    /// app_root.add_otel_span_event_with_timestamp(event_name, event_time, event_attrs);
+    /// app_root.add_event_with_timestamp(event_name, event_time, event_attrs);
     /// ```
-    fn add_otel_span_event_with_timestamp<T>(
+    fn add_event_with_timestamp<T>(
         &self,
         name: T,
         timestamp: SystemTime,
@@ -307,19 +307,15 @@ impl OpenTelemetrySpanExt for tracing::Span {
         });
     }
 
-    fn add_otel_span_event<T>(&self, name: T, attributes: Vec<KeyValue>)
+    fn add_event<T>(&self, name: T, attributes: Vec<KeyValue>)
     where
         T: Into<Cow<'static, str>>,
     {
-        self.add_otel_span_event_with_timestamp(name, time::now(), attributes);
+        self.add_event_with_timestamp(name, time::now(), attributes);
     }
 
-    fn add_otel_span_event_with_timestamp<T>(
-        &self,
-        name: T,
-        timestamp: SystemTime,
-        attributes: Vec<KeyValue>,
-    ) where
+    fn add_event_with_timestamp<T>(&self, name: T, timestamp: SystemTime, attributes: Vec<KeyValue>)
+    where
         T: Into<Cow<'static, str>>,
     {
         self.with_subscriber(move |(id, subscriber)| {

src/span_ext.rs

@@ -73,7 +73,7 @@ fn set_status_helper(status: Status) -> SpanData {
 }
 
 #[test]
-fn test_add_otel_span_event() {
+fn test_add_event() {
     let (_tracer, provider, exporter, subscriber) = test_tracer();
 
     let event_name = "my_event";
@@ -87,7 +87,7 @@ fn test_add_otel_span_event() {
         let _enter = root.enter(); // Enter span to make it current for the event addition
 
         // Add the event using the new extension method
-        root.add_otel_span_event(event_name, event_attrs.clone());
+        root.add_event(event_name, event_attrs.clone());
     });
 
     drop(provider); // flush all spans
@@ -111,7 +111,7 @@ fn test_add_otel_span_event() {
 }
 
 #[test]
-fn test_add_otel_span_event_with_timestamp() {
+fn test_add_event_with_timestamp() {
     use std::time::{Duration, SystemTime};
 
     let (_tracer, provider, exporter, subscriber) = test_tracer();
@@ -126,11 +126,7 @@ fn test_add_otel_span_event_with_timestamp() {
         let _enter = root.enter();
 
         // Add the event using the new extension method with the specific timestamp
-        root.add_otel_span_event_with_timestamp(
-            event_name,
-            specific_timestamp,
-            event_attrs.clone(),
-        );
+        root.add_event_with_timestamp(event_name, specific_timestamp, event_attrs.clone());
     });
 
     drop(provider); // flush all spans