Add async logger for telemetry

acceptance/bin/wait_file

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+wait_file() {
+    local file_path="$1"
+    local max_attempts=100
+    local attempt=0
+
+    while [ $attempt -lt $max_attempts ]; do
+        if [ -e "$file_path" ]; then
+            echo "File $file_path exists"
+            return 0
+        fi
+        sleep 0.1
+        attempt=$((attempt + 1))
+    done
+
+    echo "Timeout: File $file_path did not appear within 10 seconds"
+    return 1
+}
+
+if [ $# -eq 0 ]; then
+    echo "Usage: $0 <file_path>"
+    exit 1
+fi
+
+wait_file "$1"
+exit $?

acceptance/bin/wait_pid

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+
+# wait <pid> in bash only works for processes that are direct children to the calling
+# shell. This script is more general purpose.
+wait_pid() {
+    local pid=$1
+    local max_attempts=100  # 100 * 0.1 seconds = 10 seconds
+    local attempt=0
+    local sleep_time=0.1
+
+    while [ $attempt -lt $max_attempts ]; do
+        if [[ "$OSTYPE" == "msys"* || "$OSTYPE" == "cygwin"* ]]; then
+            # Windows approach
+            if ! tasklist | grep -q $pid; then
+                echo "Process has ended"
+                return 0
+            fi
+        else
+            # Linux/macOS approach
+            if ! kill -0 $pid 2>/dev/null; then
+                echo "Process has ended"
+                return 0
+            fi
+        fi
+
+        sleep $sleep_time
+        attempt=$((attempt + 1))
+    done
+
+    echo "Timeout: Process $pid did not end within 10 seconds"
+    return 1
+}
+
+# Usage
+if [ $# -eq 0 ]; then
+    echo "Usage: $0 <PID>"
+    exit 1
+fi
+
+wait_pid $1
+exit $?

acceptance/telemetry/dummy-error/out.requests.txt

@@ -0,0 +1 @@
+{"method":"POST","path":"/telemetry-ext","body":{"uploadTime":"UNIX_TIME_MILLIS","items":[],"protoLogs":["{\"frontend_log_event_id\":\"[UUID]\",\"entry\":{\"databricks_cli_log\":{\"execution_context\":{\"cmd_exec_id\":\"[UUID]\",\"version\":\"[DEV_VERSION]\",\"command\":\"telemetry_dummy\",\"operating_system\":\"OS\",\"execution_time_ms\":\"SMALL_INT\",\"exit_code\":0},\"cli_test_event\":{\"name\":\"VALUE1\"}}}}","{\"frontend_log_event_id\":\"[UUID]\",\"entry\":{\"databricks_cli_log\":{\"execution_context\":{\"cmd_exec_id\":\"[UUID]\",\"version\":\"[DEV_VERSION]\",\"command\":\"telemetry_dummy\",\"operating_system\":\"OS\",\"execution_time_ms\":\"SMALL_INT\",\"exit_code\":0},\"cli_test_event\":{\"name\":\"VALUE2\"}}}}"]}}

acceptance/telemetry/dummy-error/out.upload.txt

@@ -0,0 +1,2 @@
+error: Failed to upload telemetry logs: Endpoint not implemented.
+

acceptance/telemetry/dummy-error/output.txt

@@ -0,0 +1,5 @@
+
+>>> [CLI] telemetry dummy
+waiting for telemetry process to finish
+File ./telemetry.pid exists
+Process has ended

acceptance/telemetry/dummy-error/script

@@ -0,0 +1,15 @@
+export DATABRICKS_CLI_TELEMETRY_PID_FILE=./telemetry.pid
+export DATABRICKS_CLI_TELEMETRY_UPLOAD_LOGS_FILE=./out.upload.txt
+
+# This test ensures that the main CLI command does not error even if
+# telemetry upload fails.
+trace $CLI telemetry dummy
+
+echo "waiting for telemetry process to finish"
+
+# Wait for the child telemetry process to finish
+wait_file ./telemetry.pid
+wait_pid $(cat ./telemetry.pid)
+
+# cleanup the pid file
+rm -f ./telemetry.pid

acceptance/telemetry/dummy-error/test.toml

@@ -0,0 +1,24 @@
+LocalOnly = true
+RecordRequests = true
+
+[[Server]]
+Pattern = "POST /telemetry-ext"
+Response.Body = '''
+{
+    "error_code": "ERROR_CODE",
+    "message": "Endpoint not implemented."
+}
+'''
+Response.StatusCode = 501
+
+[[Repls]]
+Old = '17\d{11}'
+New = '"UNIX_TIME_MILLIS"'
+
+[[Repls]]
+Old = 'execution_time_ms\\\":\d{1,5},'
+New = 'execution_time_ms\":\"SMALL_INT\",'
+
+[[Repls]]
+Old = 'darwin|linux|windows'
+New = 'OS'

acceptance/telemetry/dummy/out.requests.txt

@@ -0,0 +1 @@
+{"method":"POST","path":"/telemetry-ext","body":{"uploadTime":"UNIX_TIME_MILLIS","items":[],"protoLogs":["{\"frontend_log_event_id\":\"[UUID]\",\"entry\":{\"databricks_cli_log\":{\"execution_context\":{\"cmd_exec_id\":\"[UUID]\",\"version\":\"[DEV_VERSION]\",\"command\":\"telemetry_dummy\",\"operating_system\":\"OS\",\"execution_time_ms\":\"SMALL_INT\",\"exit_code\":0},\"cli_test_event\":{\"name\":\"VALUE1\"}}}}","{\"frontend_log_event_id\":\"[UUID]\",\"entry\":{\"databricks_cli_log\":{\"execution_context\":{\"cmd_exec_id\":\"[UUID]\",\"version\":\"[DEV_VERSION]\",\"command\":\"telemetry_dummy\",\"operating_system\":\"OS\",\"execution_time_ms\":\"SMALL_INT\",\"exit_code\":0},\"cli_test_event\":{\"name\":\"VALUE2\"}}}}"]}}

acceptance/telemetry/dummy/out.upload.txt

@@ -0,0 +1,3 @@
+Telemetry logs uploaded successfully
+Response:
+{"errors":null,"numProtoSuccess":2}

acceptance/telemetry/dummy/output.txt

@@ -0,0 +1,5 @@
+
+>>> [CLI] telemetry dummy
+waiting for telemetry process to finish
+File ./telemetry.pid exists
+Process has ended

acceptance/telemetry/dummy/script

@@ -0,0 +1,13 @@
+export DATABRICKS_CLI_TELEMETRY_PID_FILE=./telemetry.pid
+export DATABRICKS_CLI_TELEMETRY_UPLOAD_LOGS_FILE=./out.upload.txt
+
+trace $CLI telemetry dummy
+
+echo "waiting for telemetry process to finish"
+
+# Wait for the child telemetry process to finish
+wait_file ./telemetry.pid
+wait_pid $(cat ./telemetry.pid)
+
+# cleanup the pid file
+rm -f ./telemetry.pid

acceptance/telemetry/dummy/test.toml

@@ -0,0 +1,22 @@
+LocalOnly = true
+RecordRequests = true
+
+[[Server]]
+Pattern = "POST /telemetry-ext"
+Response.Body = '''
+{
+    "numProtoSuccess": 2
+}
+'''
+
+[[Repls]]
+Old = '17\d{11}'
+New = '"UNIX_TIME_MILLIS"'
+
+[[Repls]]
+Old = 'execution_time_ms\\\":\d{1,5},'
+New = 'execution_time_ms\":\"SMALL_INT\",'
+
+[[Repls]]
+Old = 'darwin|linux|windows'
+New = 'OS'

acceptance/telemetry/upload/out.requests.txt

@@ -0,0 +1 @@
+{"method":"POST","path":"/telemetry-ext","body":{"uploadTime":"UNIX_TIME_MILLIS","items":[],"protoLogs":["{\"frontend_log_event_id\":\"[UUID]\",\"entry\":{\"databricks_cli_log\":{\"cli_test_event\":{\"name\":\"VALUE1\"}}}}","{\"frontend_log_event_id\":\"[UUID]\",\"entry\":{\"databricks_cli_log\":{\"cli_test_event\":{\"name\":\"VALUE2\"}}}}"]}}

acceptance/telemetry/upload/out.upload.txt

@@ -0,0 +1,3 @@
+Telemetry logs uploaded successfully
+Response:
+{"errors":null,"numProtoSuccess":2}

acceptance/telemetry/upload/output.txt

@@ -0,0 +1,2 @@
+
+>>> [CLI] telemetry upload

acceptance/telemetry/upload/script

@@ -0,0 +1,5 @@
+export DATABRICKS_CLI_TELEMETRY_UPLOAD_LOGS_FILE=./out.upload.txt
+
+# This command / test cannot be run in inprocess / debug mode. This is because
+# it does not go through the [root.Execute] function.
+trace $CLI telemetry upload < stdin

acceptance/telemetry/upload/stdin

@@ -0,0 +1,24 @@
+{
+    "logs": [
+        {
+            "frontend_log_event_id": "BB79BB52-96F6-42C5-9E44-E63EEA84888D",
+            "entry": {
+                "databricks_cli_log": {
+                    "cli_test_event": {
+                        "name": "VALUE1"
+                    }
+                }
+            }
+        },
+        {
+            "frontend_log_event_id": "A7F597B0-66D1-462D-824C-C5C706F232E8",
+            "entry": {
+                "databricks_cli_log": {
+                    "cli_test_event": {
+                        "name": "VALUE2"
+                    }
+                }
+            }
+        }
+    ]
+}

acceptance/telemetry/upload/test.toml

@@ -0,0 +1,19 @@
+LocalOnly = true
+RecordRequests = true
+
+[[Server]]
+Pattern = "POST /telemetry-ext"
+Response.Body = '''
+{
+    "numProtoSuccess": 2
+}
+'''
+
+
+[[Repls]]
+Old = '17\d{11}'
+New = '"UNIX_TIME_MILLIS"'
+
+[[Repls]]
+Old = 'darwin|linux|windows'
+New = 'OS'

cmd/cmd.go

@@ -13,6 +13,7 @@ import (
 	"github.com/databricks/cli/cmd/labs"
 	"github.com/databricks/cli/cmd/root"
 	"github.com/databricks/cli/cmd/sync"
+	"github.com/databricks/cli/cmd/telemetry"
 	"github.com/databricks/cli/cmd/version"
 	"github.com/databricks/cli/cmd/workspace"
 	"github.com/spf13/cobra"
@@ -74,6 +75,6 @@ func New(ctx context.Context) *cobra.Command {
 	cli.AddCommand(labs.New(ctx))
 	cli.AddCommand(sync.New())
 	cli.AddCommand(version.New())
-
+	cli.AddCommand(telemetry.New())
 	return cli
 }