instrument NADE commands using metric spans

src/snowflake/cli/_app/telemetry.py

@@ -67,6 +67,10 @@ class CLITelemetryField(Enum):
     CONFIG_FEATURE_FLAGS = "config_feature_flags"
     # Metrics
     COUNTERS = "counters"
+    SPANS = "spans"
+    COMPLETED_SPANS = "completed_spans"
+    NUM_SPANS_PAST_DEPTH_LIMIT = "num_spans_past_depth_limit"
+    NUM_SPANS_PAST_TOTAL_LIMIT = "num_spans_past_total_limit"
     # Information
     EVENT = "event"
     ERROR_MSG = "error_msg"
@@ -129,9 +133,12 @@ def _get_command_metrics() -> TelemetryDict:
     cli_context = get_cli_context()
 
     return {
-        CLITelemetryField.COUNTERS: {
-            **cli_context.metrics.counters,
-        }
+        CLITelemetryField.COUNTERS: cli_context.metrics.counters,
+        CLITelemetryField.SPANS: {
+            CLITelemetryField.COMPLETED_SPANS.value: cli_context.metrics.completed_spans,
+            CLITelemetryField.NUM_SPANS_PAST_DEPTH_LIMIT.value: cli_context.metrics.num_spans_past_depth_limit,
+            CLITelemetryField.NUM_SPANS_PAST_TOTAL_LIMIT.value: cli_context.metrics.num_spans_past_total_limit,
+        },
     }
 
 

src/snowflake/cli/_plugins/nativeapp/codegen/compiler.py

@@ -88,7 +88,7 @@ def compile_artifacts(self):
         if not self._should_invoke_processors():
             return
 
-        with cc.phase("Invoking artifact processors"):
+        with cc.phase("Invoking artifact processors", span_name="compile_artifacts"):
             if self._bundle_ctx.generated_root.exists():
                 raise ClickException(
                     f"Path {self._bundle_ctx.generated_root} already exists. Please choose a different name for your generated directory in the project definition file."

src/snowflake/cli/_plugins/nativeapp/entities/application.py

@@ -43,6 +43,7 @@
 from snowflake.cli._plugins.nativeapp.sf_facade import get_snowflake_facade
 from snowflake.cli._plugins.nativeapp.utils import needs_confirmation
 from snowflake.cli._plugins.workspace.context import ActionContext
+from snowflake.cli.api.cli_global_context import start_cli_metrics_span
 from snowflake.cli.api.entities.common import EntityBase, get_sql_executor
 from snowflake.cli.api.entities.utils import (
     drop_generic_object,
@@ -420,6 +421,7 @@ def get_objects_owned_by_application(self) -> List[ApplicationOwnedObject]:
             ).fetchall()
             return [{"name": row[1], "type": row[2]} for row in results]
 
+    @start_cli_metrics_span("create_or_upgrade_app")
     def create_or_upgrade_app(
         self,
         package: ApplicationPackageEntity,
@@ -513,10 +515,10 @@ def create_or_upgrade_app(
                     create_cursor = sql_executor.execute_query(
                         dedent(
                             f"""\
-                        create application {self.name}
-                            from application package {package.name} {using_clause} {debug_mode_clause}
-                            comment = {SPECIAL_COMMENT}
-                        """
+                            create application {self.name}
+                                from application package {package.name} {using_clause} {debug_mode_clause}
+                                comment = {SPECIAL_COMMENT}
+                            """
                         ),
                     )
                     print_messages(console, create_cursor)

src/snowflake/cli/_plugins/nativeapp/entities/application_package.py

@@ -43,6 +43,7 @@
 from snowflake.cli._plugins.stage.diff import DiffResult
 from snowflake.cli._plugins.stage.manager import StageManager
 from snowflake.cli._plugins.workspace.context import ActionContext
+from snowflake.cli.api.cli_global_context import start_cli_metrics_span
 from snowflake.cli.api.entities.common import EntityBase, get_sql_executor
 from snowflake.cli.api.entities.utils import (
     drop_generic_object,
@@ -915,6 +916,7 @@ def validate_setup_script(
             if validation_result["status"] == "FAIL":
                 raise SetupScriptFailedValidation()
 
+    @start_cli_metrics_span("get_validation_result")
     def get_validation_result(
         self, use_scratch_stage: bool, interactive: bool, force: bool
     ):

src/snowflake/cli/_plugins/workspace/manager.py

@@ -61,7 +61,10 @@ def perform_action(self, entity_id: str, action: EntityActions, *args, **kwargs)
             action_ctx = ActionContext(
                 get_entity=self.get_entity,
             )
-            return entity.perform(action, action_ctx, *args, **kwargs)
+            with get_cli_context().metrics.start_span(
+                f"{type(entity).__name__}.{action.value}"
+            ):
+                return entity.perform(action, action_ctx, *args, **kwargs)
         else:
             raise ValueError(f'This entity type does not support "{action.value}"')
 

src/snowflake/cli/api/cli_global_context.py

@@ -17,6 +17,7 @@
 from contextlib import contextmanager
 from contextvars import ContextVar
 from dataclasses import dataclass, field, replace
+from functools import wraps
 from pathlib import Path
 from typing import TYPE_CHECKING, Iterator
 
@@ -157,7 +158,7 @@ def enable_tracebacks(self) -> bool:
         return self._manager.enable_tracebacks
 
     @property
-    def metrics(self):
+    def metrics(self) -> CLIMetrics:
         return self._manager.metrics
 
     @property
@@ -213,6 +214,26 @@ def get_cli_context() -> _CliGlobalContextAccess:
     return _CliGlobalContextAccess(get_cli_context_manager())
 
 
+def start_cli_metrics_span(span_name: str):
+    """
+    Decorator to start a command metrics span that encompasses a whole function
+
+    Must be used instead of directly calling @get_cli_context().metrics.start_span(span_name)
+    as a decorator to ensure that the cli context is grabbed at run time instead of at
+    module load time, which would not reflect forking
+    """
+
+    def decorator(func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            with get_cli_context().metrics.start_span(span_name):
+                return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
 @contextmanager
 def fork_cli_context(
     connection_overrides: dict | None = None,

src/snowflake/cli/api/console/abc.py

@@ -68,6 +68,7 @@ def phase(
         self,
         enter_message: str,
         exit_message: Optional[str] = None,
+        span_name: Optional[str] = None,
     ) -> Iterator[Callable[[str], None]]:
         """A context manager for organising steps into logical group."""
 

src/snowflake/cli/api/console/console.py

@@ -14,11 +14,12 @@
 
 from __future__ import annotations
 
-from contextlib import contextmanager
+from contextlib import contextmanager, nullcontext
 from typing import Optional
 
 from rich.style import Style
 from rich.text import Text
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.console.abc import AbstractConsole
 from snowflake.cli.api.console.enum import Output
 
@@ -68,7 +69,12 @@ def _format_message(self, message: str, output: Output) -> Text:
         return text
 
     @contextmanager
-    def phase(self, enter_message: str, exit_message: Optional[str] = None):
+    def phase(
+        self,
+        enter_message: str,
+        exit_message: Optional[str] = None,
+        span_name: Optional[str] = None,
+    ):
         """A context manager for organising steps into logical group."""
         if self.in_phase:
             raise CliConsoleNestingProhibitedError("Only one phase allowed at a time.")
@@ -81,7 +87,10 @@ def phase(self, enter_message: str, exit_message: Optional[str] = None):
         self._in_phase = True
 
         try:
-            yield self.step
+            with get_cli_context().metrics.start_span(
+                span_name
+            ) if span_name else nullcontext():
+                yield self.step
         finally:
             self._in_phase = False
             if exit_message:

src/snowflake/cli/api/entities/utils.py

@@ -23,7 +23,7 @@
     to_stage_path,
 )
 from snowflake.cli._plugins.stage.utils import print_diff_to_console
-from snowflake.cli.api.cli_global_context import get_cli_context
+from snowflake.cli.api.cli_global_context import get_cli_context, start_cli_metrics_span
 from snowflake.cli.api.console.abc import AbstractConsole
 from snowflake.cli.api.entities.common import get_sql_executor
 from snowflake.cli.api.errno import (
@@ -76,6 +76,7 @@ def _get_stage_paths_to_sync(
     return stage_paths
 
 
+@start_cli_metrics_span("sync_deploy_root_with_stage")
 def sync_deploy_root_with_stage(
     console: AbstractConsole,
     deploy_root: Path,
@@ -219,7 +220,10 @@ def execute_post_deploy_hooks(
 
     get_cli_context().metrics.set_counter(CLICounterField.POST_DEPLOY_SCRIPTS, 1)
 
-    with console.phase(f"Executing {deployed_object_type} post-deploy actions"):
+    with console.phase(
+        f"Executing {deployed_object_type} post-deploy actions",
+        span_name="execute_post_deploy_hooks",
+    ):
         sql_scripts_paths = []
         display_paths = []
         for hook in post_deploy_hooks:
@@ -304,6 +308,7 @@ def validation_item_to_str(item: dict[str, str | int]):
     return s
 
 
+@start_cli_metrics_span("drop_generic_object")
 def drop_generic_object(
     console: AbstractConsole,
     object_type: str,