SNOW-2306184: config refactor - telemetry

Author: sfc-gh-mraba

src/snowflake/cli/_app/telemetry.py

@@ -61,6 +61,11 @@ class CLITelemetryField(Enum):
     COMMAND_CI_ENVIRONMENT = "command_ci_environment"
     # Configuration
     CONFIG_FEATURE_FLAGS = "config_feature_flags"
+    CONFIG_PROVIDER_TYPE = "config_provider_type"
+    CONFIG_SOURCES_USED = "config_sources_used"
+    CONFIG_SOURCE_WINS = "config_source_wins"
+    CONFIG_TOTAL_KEYS_RESOLVED = "config_total_keys_resolved"
+    CONFIG_KEYS_WITH_OVERRIDES = "config_keys_with_overrides"
     # Metrics
     COUNTERS = "counters"
     SPANS = "spans"
@@ -219,6 +224,55 @@ def python_version() -> str:
     return f"{py_ver.major}.{py_ver.minor}.{py_ver.micro}"
 
 
+def _get_config_telemetry() -> TelemetryDict:
+    """Get configuration resolution telemetry data."""
+    try:
+        from snowflake.cli.api.config_ng.telemetry_integration import (
+            get_config_telemetry_payload,
+        )
+        from snowflake.cli.api.config_provider import (
+            AlternativeConfigProvider,
+            get_config_provider_singleton,
+        )
+
+        provider = get_config_provider_singleton()
+
+        # Identify which config provider is being used
+        provider_type = (
+            "ng" if isinstance(provider, AlternativeConfigProvider) else "legacy"
+        )
+
+        result: TelemetryDict = {CLITelemetryField.CONFIG_PROVIDER_TYPE: provider_type}
+
+        # Get detailed telemetry if using ng config
+        if isinstance(provider, AlternativeConfigProvider):
+            provider._ensure_initialized()  # noqa: SLF001
+            payload = get_config_telemetry_payload(provider._resolver)  # noqa: SLF001
+
+            # Map payload keys to telemetry fields
+            if payload:
+                if "config_sources_used" in payload:
+                    result[CLITelemetryField.CONFIG_SOURCES_USED] = payload[
+                        "config_sources_used"
+                    ]
+                if "config_source_wins" in payload:
+                    result[CLITelemetryField.CONFIG_SOURCE_WINS] = payload[
+                        "config_source_wins"
+                    ]
+                if "config_total_keys_resolved" in payload:
+                    result[CLITelemetryField.CONFIG_TOTAL_KEYS_RESOLVED] = payload[
+                        "config_total_keys_resolved"
+                    ]
+                if "config_keys_with_overrides" in payload:
+                    result[CLITelemetryField.CONFIG_KEYS_WITH_OVERRIDES] = payload[
+                        "config_keys_with_overrides"
+                    ]
+
+        return result
+    except Exception:
+        return {}
+
+
 class CLITelemetryClient:
     @property
     def _ctx(self) -> _CliGlobalContextAccess:
@@ -239,6 +293,7 @@ def generate_telemetry_data_dict(
                 k: str(v) for k, v in get_feature_flags_section().items()
             },
             **_find_command_info(),
+            **_get_config_telemetry(),
             **telemetry_payload,
         }
         # To map Enum to string, so we don't have to use .value every time

src/snowflake/cli/api/config_ng/__init__.py

@@ -72,6 +72,10 @@
     SnowSQLSection,
     get_merged_variables,
 )
+from snowflake.cli.api.config_ng.telemetry_integration import (
+    get_config_telemetry_payload,
+    record_config_source_usage,
+)
 
 __all__ = [
     "check_value_source",
@@ -91,12 +95,14 @@
     "extract_root_level_connection_params",
     "FILE_SOURCE_NAMES",
     "format_summary_for_display",
+    "get_config_telemetry_payload",
     "get_merged_variables",
     "get_resolution_summary",
     "get_resolver",
     "INTERNAL_CLI_PARAMETERS",
     "is_resolution_logging_available",
     "merge_params_into_connections",
+    "record_config_source_usage",
     "ResolutionEntry",
     "ResolutionHistory",
     "ResolutionHistoryTracker",

src/snowflake/cli/api/config_ng/telemetry_integration.py

@@ -0,0 +1,100 @@
+# Copyright (c) 2024 Snowflake Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Telemetry integration for config_ng system.
+
+This module provides functions to track configuration source usage
+and integrate with the CLI's telemetry system.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Dict, Optional
+
+if TYPE_CHECKING:
+    from snowflake.cli.api.config_ng.resolver import ConfigurationResolver
+
+
+# Map source names to counter field names
+SOURCE_TO_COUNTER = {
+    "snowsql_config": "config_source_snowsql",
+    "cli_config_toml": "config_source_cli_toml",
+    "connections_toml": "config_source_connections_toml",
+    "snowsql_env": "config_source_snowsql_env",
+    "connection_specific_env": "config_source_connection_env",
+    "cli_env": "config_source_cli_env",
+    "cli_arguments": "config_source_cli_args",
+}
+
+
+def record_config_source_usage(resolver: ConfigurationResolver) -> None:
+    """
+    Record configuration source usage to CLI metrics.
+
+    This should be called after configuration resolution completes.
+    Sets counters to 1 for sources that provided winning values, 0 otherwise.
+
+    Args:
+        resolver: The ConfigurationResolver instance
+    """
+    try:
+        from snowflake.cli.api.cli_global_context import get_cli_context
+        from snowflake.cli.api.metrics import CLICounterField
+
+        cli_context = get_cli_context()
+        summary = resolver.get_tracker().get_summary()
+
+        # Track which sources won (provided final values)
+        source_wins = summary.get("source_wins", {})
+
+        # Set counters for each source
+        for source_name, counter_name in SOURCE_TO_COUNTER.items():
+            # Set to 1 if this source provided any winning values, 0 otherwise
+            value = 1 if source_wins.get(source_name, 0) > 0 else 0
+            counter_field = getattr(CLICounterField, counter_name.upper(), None)
+            if counter_field:
+                cli_context.metrics.set_counter(counter_field, value)
+
+    except Exception:
+        # Don't break execution if telemetry fails
+        pass
+
+
+def get_config_telemetry_payload(
+    resolver: Optional[ConfigurationResolver],
+) -> Dict[str, Any]:
+    """
+    Get configuration telemetry payload for inclusion in command telemetry.
+
+    Args:
+        resolver: Optional ConfigurationResolver instance
+
+    Returns:
+        Dictionary with config telemetry data
+    """
+    if resolver is None:
+        return {}
+
+    try:
+        summary = resolver.get_tracker().get_summary()
+
+        return {
+            "config_sources_used": list(summary.get("source_usage", {}).keys()),
+            "config_source_wins": summary.get("source_wins", {}),
+            "config_total_keys_resolved": summary.get("total_keys_resolved", 0),
+            "config_keys_with_overrides": summary.get("keys_with_overrides", 0),
+        }
+    except Exception:
+        return {}

src/snowflake/cli/api/config_provider.py

@@ -293,8 +293,26 @@ def _ensure_initialized(self) -> None:
         if not self._config_cache:
             self._config_cache = self._resolver.resolve()
 
+        # Record telemetry about config sources used
+        self._record_config_telemetry()
+
         self._initialized = True
 
+    def _record_config_telemetry(self) -> None:
+        """Record configuration source usage to telemetry system."""
+        if self._resolver is None:
+            return
+
+        try:
+            from snowflake.cli.api.config_ng.telemetry_integration import (
+                record_config_source_usage,
+            )
+
+            record_config_source_usage(self._resolver)
+        except Exception:
+            # Don't break initialization if telemetry fails
+            pass
+
     def read_config(self) -> None:
         """
         Load configuration from all sources.

src/snowflake/cli/api/metrics.py

@@ -76,6 +76,28 @@ class CLICounterField:
     EVENT_SHARING_ERROR = (
         f"{_TypePrefix.FEATURES}.{_DomainPrefix.APP}.event_sharing_error"
     )
+    # Config source usage tracking
+    CONFIG_SOURCE_SNOWSQL = (
+        f"{_TypePrefix.FEATURES}.{_DomainPrefix.GLOBAL}.config_source_snowsql"
+    )
+    CONFIG_SOURCE_CLI_TOML = (
+        f"{_TypePrefix.FEATURES}.{_DomainPrefix.GLOBAL}.config_source_cli_toml"
+    )
+    CONFIG_SOURCE_CONNECTIONS_TOML = (
+        f"{_TypePrefix.FEATURES}.{_DomainPrefix.GLOBAL}.config_source_connections_toml"
+    )
+    CONFIG_SOURCE_SNOWSQL_ENV = (
+        f"{_TypePrefix.FEATURES}.{_DomainPrefix.GLOBAL}.config_source_snowsql_env"
+    )
+    CONFIG_SOURCE_CONNECTION_ENV = (
+        f"{_TypePrefix.FEATURES}.{_DomainPrefix.GLOBAL}.config_source_connection_env"
+    )
+    CONFIG_SOURCE_CLI_ENV = (
+        f"{_TypePrefix.FEATURES}.{_DomainPrefix.GLOBAL}.config_source_cli_env"
+    )
+    CONFIG_SOURCE_CLI_ARGS = (
+        f"{_TypePrefix.FEATURES}.{_DomainPrefix.GLOBAL}.config_source_cli_args"
+    )
 
 
 @dataclass