feat(telemetry): Collect information about starters (#1257)

* Not mask starters argument

Signed-off-by: Ankita Katiyar <[email protected]>

* Add test case for starters

Signed-off-by: Ankita Katiyar <[email protected]>

* Release notes + lint

Signed-off-by: Ankita Katiyar <[email protected]>

* Add more test cases

Signed-off-by: Ankita Katiyar <[email protected]>

* Mask custom starters

Signed-off-by: Ankita Katiyar <[email protected]>

---------

Signed-off-by: Ankita Katiyar <[email protected]>
Signed-off-by: Ankita Katiyar <[email protected]>

Author: ankatiyar

kedro-telemetry/RELEASE.md

@@ -1,5 +1,6 @@
 # Upcoming release
 * Dropped support for Python 3.9 (EOL Oct 2025). Minimum supported version is now 3.10.
+* Updated collection of command usage information to include which starter is used when creating a new project.
 * Update collection of project statistics to include what types of datasets are used in the project. This will not include dataset type name if a custom dataset is used.
 
 # Release 0.6.5

kedro-telemetry/kedro_telemetry/masking.py

@@ -7,6 +7,12 @@
 import click
 
 MASK = "*****"
+STARTERS = [
+    "astro-airflow-iris",
+    "databricks-iris",
+    "spaceflights-pandas",
+    "spaceflights-pyspark",
+]
 
 
 def _recurse_cli(
@@ -103,20 +109,30 @@ def _mask_kedro_cli(cli: click.CommandCollection, command_args: list[str]) -> li
         output.append(command_args[arg_index])
         current_CLI = current_CLI[command_args[arg_index]]
         arg_index += 1
-
     # Mask everything except parameter keywords
+    prev_arg = None
     for arg in command_args[arg_index:]:
         if arg.startswith("-"):
             if "=" in arg:
-                arg_left = arg.split("=")[0]
-                if arg_left in current_CLI:
+                arg_left, arg_right = arg.split("=", 1)
+                is_valid_param = arg_left in current_CLI
+                is_starter = arg_left in ("--starter", "-s")
+
+                if is_valid_param:
                     output.append(arg_left)
-                output.append(MASK)
-            elif arg in current_CLI:
-                output.append(arg)
+                    prev_arg = arg_left
+                else:
+                    prev_arg = None
+
+                output.append(
+                    arg_right if is_starter and arg_right in STARTERS else MASK
+                )
             else:
-                output.append(MASK)
+                is_valid_param = arg in current_CLI
+                output.append(arg if is_valid_param else MASK)
+                prev_arg = arg if is_valid_param else None
         else:
-            output.append(MASK)
-
+            is_starter = prev_arg in ("--starter", "-s")
+            output.append(arg if is_starter and arg in STARTERS else MASK)
+            prev_arg = None
     return output

kedro-telemetry/kedro_telemetry/plugin.py

@@ -185,7 +185,6 @@ def before_command_run(
         # get KedroCLI and its structure from actual project root
         cli = KedroCLI(project_path=project_path if project_path else Path.cwd())
         masked_command_args = _mask_kedro_cli(cli, command_args=command_args)
-
         self._user_uuid = _get_or_create_uuid()
 
         event_properties = _get_project_properties(self._user_uuid, project_path)

kedro-telemetry/tests/test_masking.py

@@ -177,6 +177,18 @@ def test_get_cli_structure_help(self, mocker, fake_metadata):
                 ["run", "--params=hello=4", "--pipeline=my_pipeline"],
                 ["run", "--params", MASK, "--pipeline", MASK],
             ),
+            (
+                ["new", "--starter=spaceflights-pandas", "--name=my_project"],
+                ["new", "--starter", "spaceflights-pandas", "--name", MASK],
+            ),
+            (
+                ["new", "--starter", "my_starter", "--name=my_project"],
+                ["new", "--starter", MASK, "--name", MASK],
+            ),
+            (
+                ["new", "-s=databricks-iris", "-n=my_project"],
+                ["new", "-s", "databricks-iris", "-n", MASK],
+            ),
         ],
     )
     def test_mask_kedro_cli(