Server telemetry reporting (#814)

feat: server telemetry reporting

Author: scaliby

src/xpk/core/telemetry.py

@@ -18,10 +18,68 @@
 import uuid
 import json
 import time
+import sys
+import importlib
+import subprocess
+import tempfile
 from enum import Enum
+from typing import Any
 from dataclasses import dataclass
 from .config import xpk_config, CLIENT_ID_KEY, __version__ as xpk_version
 from ..utils.execution_context import is_dry_run
+from ..utils.user_agent import get_user_agent
+
+
+def send_clearcut_payload(data: str, wait_to_complete: bool = False) -> None:
+  """Sends payload to clearcut endpoint."""
+  try:
+    file_path = _store_payload_in_temp_file(data)
+    _flush_temp_file_to_clearcut(file_path, wait_to_complete)
+  except Exception:  # pylint: disable=broad-exception-caught
+    pass
+
+
+def _store_payload_in_temp_file(data: str) -> str:
+  with tempfile.NamedTemporaryFile(
+      mode="w", delete=False, encoding="utf-8"
+  ) as file:
+    json.dump(
+        {
+            "data": data,
+            "url": "https://play.googleapis.com/log",
+            "params": {"format": "json_proto"},
+            "headers": {"User-Agent": get_user_agent()},
+            "method": "POST",
+        },
+        file,
+    )
+    return file.name
+
+
+def _flush_temp_file_to_clearcut(
+    file_path: str, wait_to_complete: bool
+) -> None:
+  with importlib.resources.path("xpk", "telemetry_uploader.py") as path:
+    kwargs: dict[str, Any] = {}
+    if sys.platform == "win32":
+      kwargs["creationflags"] = (
+          subprocess.DETACHED_PROCESS | subprocess.CREATE_NO_WINDOW
+      )
+    else:
+      kwargs["start_new_session"] = True
+
+    process = subprocess.Popen(
+        args=[
+            sys.executable,
+            str(path),
+            file_path,
+        ],
+        stdout=sys.stdout if wait_to_complete else subprocess.DEVNULL,
+        stderr=sys.stderr if wait_to_complete else subprocess.DEVNULL,
+        **kwargs,
+    )
+    if wait_to_complete:
+      process.wait()
 
 
 def ensure_client_id() -> str:

src/xpk/main.py

@@ -37,7 +37,7 @@
 
 from .parser.core import set_parser
 from .core.updates import print_xpk_hello
-from .core.telemetry import MetricsCollector
+from .core.telemetry import MetricsCollector, send_clearcut_payload
 from .utils.feature_flags import FeatureFlags
 from .utils.console import xpk_print, exit_code_to_int
 from .utils.execution_context import set_context
@@ -90,8 +90,7 @@ def main() -> None:
     raise
   finally:
     if FeatureFlags.TELEMETRY_ENABLED:
-      # TODO(@scaliby): Flush to server instead of a console
-      xpk_print(MetricsCollector.flush())
+      send_clearcut_payload(MetricsCollector.flush())
 
 
 if __name__ == '__main__':

src/xpk/telemetry_uploader.py

@@ -0,0 +1,29 @@
+"""
+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 sys
+import os
+import requests
+import json
+
+file_path = sys.argv[1]
+if os.path.exists(file_path):
+  with open(file_path, mode="r", encoding="utf-8") as file:
+    kwargs = json.load(file)
+    response = requests.request(**kwargs)
+    print(f"Telemetry upload finished with {response.status_code} status code")
+
+  os.remove(file_path)

src/xpk/utils/user_agent.py

@@ -0,0 +1,35 @@
+"""
+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 platform
+from ..core.config import __version__ as xpk_version
+
+
+def get_user_agent() -> str:
+  return f'XPK/{xpk_version} ({_get_user_agent_platform()})'
+
+
+def _get_user_agent_platform() -> str:
+  system = platform.system().lower()
+  if system == 'windows':
+    return f'Windows NT {platform.version()}'
+  elif system == 'linux':
+    return f'Linux; {platform.machine()}'
+  elif system == 'darwin':
+    version, _, arch = platform.mac_ver()
+    return f'Macintosh; {arch} Mac OS X {version}'
+  else:
+    return ''

src/xpk/utils/user_agent_test.py

@@ -0,0 +1,44 @@
+"""
+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 .user_agent import get_user_agent
+
+
+def test_get_user_agent_returns_correct_value_for_windows(mocker):
+  mocker.patch('xpk.utils.user_agent.xpk_version', 'v1.0.0')
+  mocker.patch('platform.system', return_value='Windows')
+  mocker.patch('platform.version', return_value='10.0')
+  assert get_user_agent() == 'XPK/v1.0.0 (Windows NT 10.0)'
+
+
+def test_get_user_agent_returns_correct_value_for_linux(mocker):
+  mocker.patch('xpk.utils.user_agent.xpk_version', 'v1.0.0')
+  mocker.patch('platform.system', return_value='Linux')
+  mocker.patch('platform.machine', return_value='x86_64')
+  assert get_user_agent() == 'XPK/v1.0.0 (Linux; x86_64)'
+
+
+def test_get_user_agent_returns_correct_value_for_darwin(mocker):
+  mocker.patch('xpk.utils.user_agent.xpk_version', 'v1.0.0')
+  mocker.patch('platform.system', return_value='Darwin')
+  mocker.patch('platform.mac_ver', return_value=('10.15', '', 'x86_64'))
+  assert get_user_agent() == 'XPK/v1.0.0 (Macintosh; x86_64 Mac OS X 10.15)'
+
+
+def test_get_user_agent_returns_correct_value_for_unknown(mocker):
+  mocker.patch('xpk.utils.user_agent.xpk_version', 'v1.0.0')
+  mocker.patch('platform.system', return_value='Unknown')
+  assert get_user_agent() == 'XPK/v1.0.0 ()'