etw-exporter-metrics updates to opentelemetry, better error logging (#105)

Author: cijothomas

opentelemetry-etw-metrics/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## vNext
 
+## v0.4.0
+
+- Improved logging when ETW write fails due to size limit being hit.
+    [105](https://github.com/open-telemetry/opentelemetry-rust-contrib/pull/105)
+- Bump opentelemetry,opentelemetry_sdk and opentelemetry-proto versions to 0.25
+    [105](https://github.com/open-telemetry/opentelemetry-rust-contrib/pull/105)
+
 ## v0.3.0
 
 ### Changed

opentelemetry-etw-metrics/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "opentelemetry-etw-metrics"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 description = "OpenTelemetry metrics exporter to ETW (Event Tracing for Windows)"
 homepage = "https://github.com/open-telemetry/opentelemetry-rust-contrib/tree/main/opentelemetry-etw-metrics"
@@ -11,9 +11,9 @@ license = "Apache-2.0"
 rust-version = "1.65"
 
 [dependencies]
-opentelemetry = { workspace = true, features = ["metrics"] }
-opentelemetry_sdk = { workspace = true, features = ["metrics", "rt-tokio"] }
-opentelemetry-proto = { workspace = true, features = ["gen-tonic", "metrics"] }
+opentelemetry = { version = "0.25", features = ["metrics"] }
+opentelemetry_sdk = { version = "0.25", features = ["metrics", "rt-tokio"] }
+opentelemetry-proto = { version = "0.25", features = ["gen-tonic", "metrics"] }
 async-trait = "0.1"
 prost = "0.13"
 tracelogging = "1.2.1"

opentelemetry-etw-metrics/examples/advanced.rs

@@ -1,11 +1,10 @@
-//! run with `$ cargo run --example basic --all-features
-use opentelemetry::{metrics::MeterProvider as _, KeyValue};
+//! run with `$ cargo run --example basic
+use opentelemetry::{global, metrics::MeterProvider as _, KeyValue};
 use opentelemetry_etw_metrics::MetricsExporter;
 use opentelemetry_sdk::{
     metrics::{PeriodicReader, SdkMeterProvider},
     runtime, Resource,
 };
-use std::{thread, time::Duration};
 
 const SERVICE_NAME: &str = "service-name";
 
@@ -24,6 +23,7 @@ fn setup_meter_provider() -> SdkMeterProvider {
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let meter_provider = setup_meter_provider();
+    global::set_meter_provider(meter_provider.clone());
 
     let meter = meter_provider.meter("user-event-test");
     let c = meter
@@ -81,10 +81,6 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
         .as_ref(),
     );
 
-    // Sleep for 1 second
-    thread::sleep(Duration::from_secs(1));
-    println!("Running...");
-
     meter_provider.shutdown()?;
     Ok(())
 }

opentelemetry-etw-metrics/examples/basic.rs

@@ -11,6 +11,7 @@ tlg::define_provider!(
 );
 
 static ETW_PROVIDER_REGISTRANT: Once = Once::new();
+pub(crate) const MAX_EVENT_SIZE: usize = 65360;
 
 /// Register the ETW provider.
 pub fn register() {

opentelemetry-etw-metrics/src/etw/mod.rs

@@ -70,14 +70,25 @@ impl PushMetricsExporter for MetricsExporter {
             .encode(&mut byte_array)
             .map_err(|err| MetricsError::Other(err.to_string()))?;
 
-        let result = etw::write(&byte_array);
-        if result != 0 {
+        if (byte_array.len()) > etw::MAX_EVENT_SIZE {
             global::handle_error(MetricsError::Other(format!(
-                "Failed to write ETW event with error code: {}",
-                result
+                "Exporting failed due to event size {} exceeding the maximum size of {} bytes",
+                byte_array.len(),
+                etw::MAX_EVENT_SIZE
             )));
+        } else {
+            let result = etw::write(&byte_array);
+            // TODO: Better logging/internal metrics needed here for non-failure
+            // case Uncomment the line below to see the exported bytes until a
+            // better logging solution is implemented
+            // println!("Exported {} bytes to ETW", byte_array.len());
+            if result != 0 {
+                global::handle_error(MetricsError::Other(format!(
+                    "Failed to write ETW event with error code: {}",
+                    result
+                )));
+            }
         }
-
         Ok(())
     }