Telemetry client id generation (#802)

* feat: telemetry client id generation

* feat: add tests

Author: scaliby

src/xpk/core/config.py

@@ -30,6 +30,7 @@
 CFG_BUCKET_KEY = 'cluster-state-gcs-bucket'
 CLUSTER_NAME_KEY = 'cluster-name'
 PROJECT_KEY = 'project-id'
+CLIENT_ID_KEY = 'client-id'
 ZONE_KEY = 'zone'
 KJOB_BATCH_IMAGE = 'batch-image'
 KJOB_BATCH_WORKING_DIRECTORY = 'batch-working-directory'
@@ -45,6 +46,7 @@
     CFG_BUCKET_KEY,
     CLUSTER_NAME_KEY,
     PROJECT_KEY,
+    CLIENT_ID_KEY,
     ZONE_KEY,
     GKE_ENDPOINT_KEY,
     DEPENDENCIES_KEY,

src/xpk/core/telemetry.py

@@ -0,0 +1,24 @@
+"""
+Copyright 2025 Google LLC
+
+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
+
+     https://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.
+"""
+
+import uuid
+from .config import xpk_config, CLIENT_ID_KEY
+
+
+def generate_client_id():
+  """Generates Client ID and stores in configuration if not already present."""
+  if xpk_config.get(CLIENT_ID_KEY) is None:
+    xpk_config.set(CLIENT_ID_KEY, str(uuid.uuid4()))

src/xpk/core/telemetry_test.py

@@ -0,0 +1,31 @@
+"""
+Copyright 2025 Google LLC
+
+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
+
+     https://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.
+"""
+
+from .config import xpk_config, CLIENT_ID_KEY
+from .telemetry import generate_client_id
+
+
+def test_generates_client_id_when_its_not_present():
+  xpk_config.set(CLIENT_ID_KEY, None)
+  generate_client_id()
+  assert xpk_config.get(CLIENT_ID_KEY) is not None
+
+
+def test_does_not_generate_client_id_when_its_present():
+  client_id = '1337'
+  xpk_config.set(CLIENT_ID_KEY, client_id)
+  generate_client_id()
+  assert xpk_config.get(CLIENT_ID_KEY) == client_id

src/xpk/main.py

@@ -37,6 +37,7 @@
 
 from .parser.core import set_parser
 from .core.updates import print_xpk_hello
+from .core.telemetry import generate_client_id
 from .utils.console import xpk_print
 from .utils.execution_context import set_context
 ################### Compatibility Check ###################
@@ -71,6 +72,7 @@ def main() -> None:
       dry_run_value='dry_run' in main_args and main_args.dry_run,
       quiet_value='quiet' in main_args and main_args.quiet,
   )
+  generate_client_id()
   print_xpk_hello()
   main_args.func(main_args)
   xpk_print('XPK Done.', flush=True)