chore: improve logging in telemetry crate

Author: ganeshnj

Cargo.lock

@@ -1,4 +1,4 @@
-root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, cc_utils, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, datadog-library-config, datadog-library-config-ffi, datadog-live-debugger, datadog-live-debugger-ffi, datadog-profiling, datadog-profiling-protobuf, datadog-profiling-ffi, data-pipeline-ffi, data-pipeline, datadog-trace-protobuf, datadog-trace-utils, datadog-trace-normalization, dogstatsd-client, datadog-log-ffi, datadog-log, ddsketch-ffi, ddtelemetry-ffi, symbolizer-ffi, datadog-profiling-replayer, datadog-remote-config, datadog-sidecar, datadog-sidecar-macros, datadog-sidecar-ffi, datadog-trace-obfuscation, datadog-tracer-flare, sidecar_mockgen, test_spawn_from_lib
+root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, cc_utils, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, datadog-library-config, datadog-library-config-ffi, datadog-live-debugger, datadog-live-debugger-ffi, datadog-profiling, datadog-profiling-protobuf, datadog-profiling-ffi, data-pipeline-ffi, data-pipeline, datadog-trace-protobuf, datadog-trace-utils, datadog-trace-normalization, dogstatsd-client, datadog-log, datadog-log-ffi, ddsketch-ffi, ddtelemetry-ffi, symbolizer-ffi, datadog-profiling-replayer, datadog-remote-config, datadog-sidecar, datadog-sidecar-macros, datadog-sidecar-ffi, datadog-trace-obfuscation, datadog-tracer-flare, sidecar_mockgen, test_spawn_from_lib
 third_party_libraries:
 - package_name: addr2line
   package_version: 0.24.2
@@ -26639,9 +26639,9 @@ third_party_libraries:
 - package_name: stringmetrics
   package_version: 2.2.2
   repository: https://github.com/pluots/stringmetrics
-  license: License specified in file ($CARGO_HOME/registry/src/github.com-25cdd57fae9f0462/stringmetrics-2.2.2/LICENSE)
+  license: License specified in file ($CARGO_HOME/registry/src/index.crates.io-1949cf8c6b5b557f/stringmetrics-2.2.2/LICENSE)
   licenses:
-  - license: License specified in file ($CARGO_HOME/registry/src/github.com-25cdd57fae9f0462/stringmetrics-2.2.2/LICENSE)
+  - license: License specified in file ($CARGO_HOME/registry/src/index.crates.io-1949cf8c6b5b557f/stringmetrics-2.2.2/LICENSE)
     text: |
       Copyright 2022 Trevor Gross
 

LICENSE-3rdparty.yml

@@ -11,7 +11,7 @@ use ddcommon_ffi::{
     {slice::AsBytes, slice::ByteSlice},
 };
 use std::{ptr::NonNull, time::Duration};
-use tracing::error;
+use tracing::{debug, error};
 
 #[cfg(all(feature = "catch_panic", panic = "unwind"))]
 use std::panic::{catch_unwind, AssertUnwindSafe};
@@ -325,16 +325,16 @@ pub unsafe extern "C" fn ddog_trace_exporter_config_enable_telemetry(
     catch_panic!(
         if let Option::Some(config) = config {
             if let Option::Some(telemetry_cfg) = telemetry_cfg {
-                config.telemetry_cfg = Some(TelemetryConfig {
+                let cfg = TelemetryConfig {
                     heartbeat: telemetry_cfg.interval,
                     runtime_id: match sanitize_string(telemetry_cfg.runtime_id) {
                         Ok(s) => Some(s),
                         Err(e) => return Some(e),
                     },
                     debug_enabled: telemetry_cfg.debug_enabled,
-                })
-            } else {
-                config.telemetry_cfg = Some(TelemetryConfig::default());
+                };
+                debug!(telemetry_cfg = ?cfg, "Configuring telemetry");
+                config.telemetry_cfg = Some(cfg);
             }
             None
         } else {
@@ -467,7 +467,7 @@ pub unsafe extern "C" fn ddog_trace_exporter_new(
             }
 
             if let Some(cfg) = &config.telemetry_cfg {
-                builder.enable_telemetry(Some(cfg.clone()));
+                builder.enable_telemetry(cfg.clone());
             }
 
             if let Some(token) = &config.test_session_token {
@@ -795,8 +795,7 @@ mod tests {
             let mut cfg = TraceExporterConfig::default();
             let error = ddog_trace_exporter_config_enable_telemetry(Some(&mut cfg), None);
             assert!(error.is_none());
-            assert_eq!(cfg.telemetry_cfg.as_ref().unwrap().heartbeat, 0);
-            assert!(cfg.telemetry_cfg.as_ref().unwrap().runtime_id.is_none());
+            assert!(cfg.telemetry_cfg.is_none());
 
             let mut cfg = TraceExporterConfig::default();
             let error = ddog_trace_exporter_config_enable_telemetry(

data-pipeline-ffi/src/trace_exporter.rs

@@ -52,6 +52,7 @@ harness = false
 path = "benches/main.rs"
 
 [dev-dependencies]
+datadog-log = { path = "../datadog-log" }
 clap = { version = "4.0", features = ["derive"] }
 criterion = "0.5.1"
 datadog-trace-utils = { path = "../datadog-trace-utils", features = [

data-pipeline/Cargo.toml

@@ -3,7 +3,10 @@
 
 use clap::Parser;
 use data_pipeline::trace_exporter::{
-    TraceExporter, TraceExporterInputFormat, TraceExporterOutputFormat,
+    TelemetryConfig, TraceExporter, TraceExporterInputFormat, TraceExporterOutputFormat,
+};
+use datadog_log::logger::{
+    logger_configure_std, logger_set_log_level, LogEventLevel, StdConfig, StdTarget,
 };
 use datadog_trace_protobuf::pb;
 use std::{
@@ -44,7 +47,14 @@ struct Args {
 }
 
 fn main() {
+    logger_configure_std(StdConfig {
+        target: StdTarget::Out,
+    })
+    .expect("Failed to configure logger");
+    logger_set_log_level(LogEventLevel::Debug).expect("Failed to set log level");
+
     let args = Args::parse();
+    let telemetry_cfg = TelemetryConfig::default();
     let mut builder = TraceExporter::builder();
     builder
         .set_url(&args.url)
@@ -57,20 +67,28 @@ fn main() {
         .set_language_version(env!("CARGO_PKG_RUST_VERSION"))
         .set_input_format(TraceExporterInputFormat::V04)
         .set_output_format(TraceExporterOutputFormat::V04)
+        .enable_telemetry(telemetry_cfg)
         .enable_stats(Duration::from_secs(10));
-    let exporter = builder.build().unwrap();
-    let now = UNIX_EPOCH.elapsed().unwrap().as_nanos() as i64;
+    let exporter = builder.build().expect("Failed to build TraceExporter");
+    let now = UNIX_EPOCH
+        .elapsed()
+        .expect("Failed to get time since UNIX_EPOCH")
+        .as_nanos() as i64;
 
     let mut traces = Vec::new();
-    for trace_id in 1..=100 {
+    for trace_id in 1..=2 {
         let mut trace = Vec::new();
-        for span_id in 1..=1000 {
+        for span_id in 1..=2 {
             trace.push(get_span(now, trace_id, span_id));
         }
         traces.push(trace);
     }
-    let data = rmp_serde::to_vec_named(&traces).unwrap();
+    let data = rmp_serde::to_vec_named(&traces).expect("Failed to serialize traces");
 
-    exporter.send(data.as_ref(), 100).unwrap();
-    exporter.shutdown(None).unwrap();
+    exporter
+        .send(data.as_ref(), 2)
+        .expect("Failed to send traces");
+    exporter
+        .shutdown(None)
+        .expect("Failed to shutdown exporter");
 }

data-pipeline/examples/send-traces-with-stats.rs

@@ -193,12 +193,8 @@ impl TraceExporterBuilder {
     }
 
     /// Enables sending telemetry metrics.
-    pub fn enable_telemetry(&mut self, cfg: Option<TelemetryConfig>) -> &mut Self {
-        if let Some(cfg) = cfg {
-            self.telemetry = Some(cfg);
-        } else {
-            self.telemetry = Some(TelemetryConfig::default());
-        }
+    pub fn enable_telemetry(&mut self, cfg: TelemetryConfig) -> &mut Self {
+        self.telemetry = Some(cfg);
         self
     }
 
@@ -381,11 +377,11 @@ mod tests {
             .set_input_format(TraceExporterInputFormat::Proxy)
             .set_output_format(TraceExporterOutputFormat::V04)
             .set_client_computed_stats()
-            .enable_telemetry(Some(TelemetryConfig {
+            .enable_telemetry(TelemetryConfig {
                 heartbeat: 1000,
                 runtime_id: None,
                 debug_enabled: false,
-            }));
+            });
         let exporter = builder.build().unwrap();
 
         assert_eq!(

data-pipeline/src/trace_exporter/builder.rs

@@ -1080,10 +1080,10 @@ mod tests {
         };
 
         if enable_telemetry {
-            builder.enable_telemetry(Some(TelemetryConfig {
+            builder.enable_telemetry(TelemetryConfig {
                 heartbeat: 100,
                 ..Default::default()
-            }));
+            });
         }
 
         builder.build().unwrap()
@@ -1619,10 +1619,10 @@ mod tests {
             .set_language("nodejs")
             .set_language_version("1.0")
             .set_language_interpreter("v8")
-            .enable_telemetry(Some(TelemetryConfig {
+            .enable_telemetry(TelemetryConfig {
                 heartbeat: 100,
                 ..Default::default()
-            }));
+            });
         let exporter = builder.build().unwrap();
 
         let traces = vec![0x90];
@@ -1743,10 +1743,10 @@ mod tests {
             .set_language("nodejs")
             .set_language_version("1.0")
             .set_language_interpreter("v8")
-            .enable_telemetry(Some(TelemetryConfig {
+            .enable_telemetry(TelemetryConfig {
                 heartbeat: 100,
                 ..Default::default()
-            }))
+            })
             .set_input_format(TraceExporterInputFormat::V04)
             .set_output_format(TraceExporterOutputFormat::V05);
 

data-pipeline/src/trace_exporter/mod.rs

@@ -10,7 +10,7 @@ license.workspace = true
 bench = false
 
 [features]
-default = []
+default = ["tracing"]
 tracing = ["tracing/std"]
 https = ["ddcommon/https"]
 

ddtelemetry/Cargo.toml

@@ -4,6 +4,7 @@
 use ddcommon::{config::parse_env, parse_uri, Endpoint};
 use http::{uri::PathAndQuery, Uri};
 use std::{borrow::Cow, time::Duration};
+use tracing::debug;
 
 pub const DEFAULT_DD_SITE: &str = "datadoghq.com";
 pub const PROD_INTAKE_SUBDOMAIN: &str = "instrumentation-telemetry-intake";
@@ -119,6 +120,10 @@ impl Settings {
     const _DD_SHARED_LIB_DEBUG: &'static str = "_DD_SHARED_LIB_DEBUG";
 
     pub fn from_env() -> Self {
+        debug!(
+            config.source = "environment",
+            "Loading telemetry settings from environment variables"
+        );
         let default = Self::default();
         Self {
             agent_host: parse_env::str_not_empty(Self::DD_AGENT_HOST),

ddtelemetry/src/config.rs

@@ -10,6 +10,7 @@
 #![cfg_attr(not(test), deny(clippy::unimplemented))]
 
 use ddcommon::entity_id;
+use tracing::debug;
 
 pub mod config;
 pub mod data;
@@ -18,11 +19,24 @@ pub mod metrics;
 pub mod worker;
 
 pub fn build_host() -> data::Host {
+    debug!("Building telemetry host information");
+    let hostname = info::os::real_hostname().unwrap_or_else(|_| String::from("unknown_hostname"));
+    let container_id = entity_id::get_container_id().map(|f| f.to_string());
+    let os_version = info::os::os_version().ok();
+
+    debug!(
+        host.hostname = %hostname,
+        host.container_id = ?container_id,
+        host.os = info::os::os_name(),
+        host.os_version = ?os_version,
+        "Built telemetry host information"
+    );
+
     data::Host {
-        hostname: info::os::real_hostname().unwrap_or_else(|_| String::from("unknown_hostname")),
-        container_id: entity_id::get_container_id().map(|f| f.to_string()),
+        hostname,
+        container_id,
         os: Some(String::from(info::os::os_name())),
-        os_version: info::os::os_version().ok(),
+        os_version,
         kernel_name: None,
         kernel_release: None,
         kernel_version: None,