Small changes and TODOs

Signed-off-by: Caleb Schoepp <[email protected]>

Author: calebschoepp

crates/factor-observe/src/lib.rs

@@ -57,14 +57,15 @@ pub struct InstanceState {
 impl SelfInstanceBuilder for InstanceState {}
 
 impl InstanceState {
+    /// TODO comment
     pub fn get_observe_context(&self) -> ObserveContext {
         ObserveContext {
             state: self.state.clone(),
         }
     }
 }
 
-/// Internal state of the observe host component.
+/// Internal state of the observe factor.
 pub(crate) struct State {
     /// A resource table that holds the guest spans.
     pub guest_spans: table::Table<GuestSpan>,
@@ -83,14 +84,16 @@ pub struct GuestSpan {
     pub inner: opentelemetry_sdk::trace::Span,
 }
 
+/// TODO comment
 pub struct ObserveContext {
     pub(crate) state: Arc<RwLock<State>>,
 }
 
 impl ObserveContext {
     /// TODO comment
     /// Make sure to mention this should only be called from an instrumented function in a factor.
-    pub fn reparent_tracing_span_this_was_lanns_idea(&self) {
+    /// Make sure this is called before any awaits
+    pub fn reparent_tracing_span(&self) {
         // TODO: Move this duplicate logic into its own impl
         let state = self.state.read().unwrap();
         if state.active_spans.is_empty() {
@@ -110,5 +113,4 @@ impl ObserveContext {
     }
 }
 
-// TODO(Caleb): Reorder things
 // TODO(Caleb): Make otel a workspace dependency

crates/factor-outbound-http/src/spin.rs

@@ -13,8 +13,7 @@ impl spin_http::Host for crate::InstanceState {
         fields(otel.kind = "client", url.full = Empty, http.request.method = Empty,
         http.response.status_code = Empty, otel.name = Empty, server.address = Empty, server.port = Empty))]
     async fn send_request(&mut self, req: Request) -> Result<Response, HttpError> {
-        self.observe_context
-            .reparent_tracing_span_this_was_lanns_idea();
+        self.observe_context.reparent_tracing_span();
 
         let span = Span::current();
         record_request_fields(&span, &req);

crates/factor-outbound-http/src/wasi.rs

@@ -86,9 +86,7 @@ impl<'a> WasiHttpView for WasiHttpImplInner<'a> {
         mut request: Request<wasmtime_wasi_http::body::HyperOutgoingBody>,
         mut config: wasmtime_wasi_http::types::OutgoingRequestConfig,
     ) -> wasmtime_wasi_http::HttpResult<wasmtime_wasi_http::types::HostFutureIncomingResponse> {
-        self.state
-            .observe_context
-            .reparent_tracing_span_this_was_lanns_idea();
+        self.state.observe_context.reparent_tracing_span();
 
         // wasmtime-wasi-http fills in scheme and authority for relative URLs
         // (e.g. https://:443/<path>), which makes them hard to reason about.

crates/trigger-http/src/wasi.rs

@@ -99,6 +99,7 @@ impl HttpExecutor for WasiHttpExecutor {
             };
 
         // TODO(Caleb): Verify that using tracing::Span::current() does not cause regressions
+        // TODO(Caleb): Do we even need the second instrument?
         let handle = task::spawn(
             async move {
                 let result = match handler {

wit/deps/observe/traces.wit

@@ -20,7 +20,8 @@ interface traces {
         /// If one of the keys already exists for an attribute of the Span it will be overwritten with the corresponding new value.
         set-attributes: func(attributes: list<key-value>);
 
-        // TODO: Get span context?
+        /// Get the `span-context` for this `span`.
+        // span-context: func() -> span-context;
 
         // TODO: Is recording?
 
@@ -69,7 +70,7 @@ interface traces {
         s64-array(list<s64>),
     }
 
-    /// Identifying trace information about a span.
+    /// Identifying trace information about a span that can be serialized and propagated.
     // TODO: Make types for the trace-id's and such?
     record span-context {
       /// Hexidecimal representation of the trace id.