Display more spans to the user. (#426)

### What Just so they're more aware of what's going on. This will help users diagnose issues with latency. ### How We add the `internal.visibility = "user"` property to the span, which tells the Console to display it.
hasura · Apr 16, 2024 · a5cf07d · a5cf07d
1 parent 819e19d
commit a5cf07d
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 8 deletions.
diff --git a/crates/query-engine/execution/src/mutation.rs b/crates/query-engine/execution/src/mutation.rs
@@ -23,7 +23,10 @@ pub async fn execute(
     let acquisition_timer = metrics.time_connection_acquisition_wait();
     let connection_result = pool
         .acquire()
-        .instrument(info_span!("Acquire connection"))
+        .instrument(info_span!(
+            "Acquire connection",
+            internal.visibility = "user",
+        ))
         .await;
     let mut connection = acquisition_timer
         .complete_with(connection_result)
@@ -104,7 +107,10 @@ async fn execute_query(
 ) -> Result<(), Error> {
     // build query
     let sqlx_query = build_query_with_params(query)
-        .instrument(info_span!("Build query with params"))
+        .instrument(info_span!(
+            "Build query with params",
+            internal.visibility = "user",
+        ))
         .await?;
 
     // run and fetch from the database
@@ -174,7 +180,10 @@ pub async fn explain(
             let acquisition_timer = metrics.time_connection_acquisition_wait();
             let connection_result = pool
                 .acquire()
-                .instrument(info_span!("Acquire connection"))
+                .instrument(info_span!(
+                    "Acquire connection",
+                    internal.visibility = "user",
+                ))
                 .await;
             let mut connection =
                 acquisition_timer
@@ -190,7 +199,10 @@ pub async fn explain(
             );
 
             let sqlx_query = build_query_with_params(&query_sql)
-                .instrument(info_span!("Build mutation with params"))
+                .instrument(info_span!(
+                    "Build mutation with params",
+                    internal.visibility = "user",
+                ))
                 .await?;
 
             let rows: Vec<sqlx::postgres::PgRow> = {

diff --git a/crates/query-engine/execution/src/query.rs b/crates/query-engine/execution/src/query.rs
@@ -25,7 +25,10 @@ pub async fn execute(
     let acquisition_timer = metrics.time_connection_acquisition_wait();
     let connection_result = pool
         .acquire()
-        .instrument(info_span!("Acquire connection"))
+        .instrument(info_span!(
+            "Acquire connection",
+            internal.visibility = "user",
+        ))
         .await;
     let mut connection = acquisition_timer
         .complete_with(connection_result)
@@ -74,7 +77,10 @@ pub async fn explain(
             let acquisition_timer = metrics.time_connection_acquisition_wait();
             let connection_result = pool
                 .acquire()
-                .instrument(info_span!("Acquire connection"))
+                .instrument(info_span!(
+                    "Acquire connection",
+                    internal.visibility = "user",
+                ))
                 .await;
             let mut connection =
                 acquisition_timer
@@ -95,7 +101,10 @@ pub async fn explain(
             );
 
             let sqlx_query = build_query_with_params(&query_sql, query.variables)
-                .instrument(info_span!("Build query with params"))
+                .instrument(info_span!(
+                    "Build query with params",
+                    internal.visibility = "user",
+                ))
                 .await?;
 
             let rows: Vec<sqlx::postgres::PgRow> = {
@@ -165,7 +174,10 @@ async fn execute_query(
 
     // build query
     let sqlx_query = build_query_with_params(&query_sql, query.variables)
-        .instrument(info_span!("Build query with params"))
+        .instrument(info_span!(
+            "Build query with params",
+            internal.visibility = "user",
+        ))
         .await?;
 
     // run and fetch from the database