uipath 2.0.51__py3-none-any.whl → 2.0.52__py3-none-any.whl

uipath/_cli/cli_auth.py

@@ -7,6 +7,7 @@ import webbrowser
 import click
 from dotenv import load_dotenv
 
+from ..telemetry import track
 from ._auth._auth_server import HTTPSServer
 from ._auth._oidc_utils import get_auth_config, get_auth_url
 from ._auth._portal_service import PortalService, select_tenant
@@ -63,6 +64,7 @@ def set_port():
     required=False,
     help="Force new token",
 )
+@track
 def auth(domain, force: None | bool = False):
     """Authenticate with UiPath Cloud Platform."""
     with console.spinner("Authenticating with UiPath ..."):

uipath/_cli/cli_deploy.py

@@ -1,6 +1,7 @@
 # type: ignore
 import click
 
+from ..telemetry import track
 from .cli_pack import pack
 from .cli_publish import publish
 
@@ -21,6 +22,7 @@ from .cli_publish import publish
     help="Whether to publish to the personal workspace",
 )
 @click.argument("root", type=str, default="./")
+@track
 def deploy(root, feed):
     """Pack and publish the project."""
     ctx = click.get_current_context()

uipath/_cli/cli_init.py

@@ -7,6 +7,7 @@ from typing import Optional
 
 import click
 
+from ..telemetry import track
 from ._utils._console import ConsoleLogger
 from ._utils._input_args import generate_args
 from ._utils._parse_ast import generate_bindings_json
@@ -52,6 +53,7 @@ def get_user_script(directory: str, entrypoint: Optional[str] = None) -> Optiona
 
 @click.command()
 @click.argument("entrypoint", required=False, default=None)
+@track
 def init(entrypoint: str) -> None:
     """Create uipath.json with input/output schemas and bindings."""
     with console.spinner("Initializing UiPath project ..."):

uipath/_cli/cli_invoke.py

@@ -14,6 +14,7 @@ try:
 except ImportError:
     import tomli as tomllib
 
+from ..telemetry import track
 from ._utils._common import get_env_vars
 from ._utils._folders import get_personal_workspace_info
 from ._utils._processes import get_release_info
@@ -50,6 +51,7 @@ def _read_project_details() -> [str, str]:
     type=click.Path(exists=True),
     help="File path for the .json input",
 )
+@track
 def invoke(
     entrypoint: Optional[str], input: Optional[str], file: Optional[str]
 ) -> None:

uipath/_cli/cli_new.py

@@ -4,6 +4,7 @@ import shutil
 
 import click
 
+from ..telemetry import track
 from ._utils._console import ConsoleLogger
 from .middlewares import Middlewares
 
@@ -38,6 +39,7 @@ requires-python = ">=3.10"
 
 @click.command()
 @click.argument("name", type=str, default="")
+@track
 def new(name: str):
     """Generate a quick-start project."""
     directory = os.getcwd()

uipath/_cli/cli_pack.py

@@ -12,6 +12,7 @@ try:
 except ImportError:
     import tomli as tomllib
 
+from ..telemetry import track
 from ._utils._console import ConsoleLogger
 
 console = ConsoleLogger()
@@ -366,6 +367,7 @@ def display_project_info(config):
 
 @click.command()
 @click.argument("root", type=str, default="./")
+@track
 def pack(root):
     """Pack the project."""
     version = get_project_version(root)

uipath/_cli/cli_publish.py

@@ -6,6 +6,7 @@ import click
 import httpx
 from dotenv import load_dotenv
 
+from ..telemetry import track
 from ._utils._common import get_env_vars
 from ._utils._console import ConsoleLogger
 from ._utils._folders import get_personal_workspace_info
@@ -63,6 +64,7 @@ def get_available_feeds(
     flag_value="personal",
     help="Whether to publish to the personal workspace",
 )
+@track
 def publish(feed):
     """Publish the package."""
     current_path = os.getcwd()

uipath/_cli/cli_run.py

@@ -9,6 +9,10 @@ from uuid import uuid4
 import click
 from dotenv import load_dotenv
 
+from .._utils.constants import (
+    ENV_JOB_ID,
+)
+from ..telemetry import track
 from ._runtime._contracts import (
     UiPathRuntimeContext,
     UiPathRuntimeError,
@@ -108,6 +112,7 @@ Usage: `uipath run <entrypoint_path> <input_arguments> [-f <input_json_file_path
     type=click.Path(exists=True),
     help="File path for the .json input",
 )
+@track(when=lambda *_a, **_kw: env.get(ENV_JOB_ID) is None)
 def run(
     entrypoint: Optional[str], input: Optional[str], resume: bool, file: Optional[str]
 ) -> None:

uipath/_utils/constants.py

@@ -8,6 +8,8 @@ ENV_JOB_KEY = "UIPATH_JOB_KEY"
 ENV_JOB_ID = "UIPATH_JOB_ID"
 ENV_ROBOT_KEY = "UIPATH_ROBOT_KEY"
 ENV_TENANT_ID = "UIPATH_TENANT_ID"
+ENV_ORGANIZATION_ID = "UIPATH_ORGANIZATION_ID"
+ENV_TELEMETRY_ENABLED = "TELEMETRY_ENABLED"
 
 # Headers
 HEADER_FOLDER_KEY = "x-uipath-folderkey"

uipath/telemetry/__init__.py

@@ -0,0 +1,3 @@
+from ._track import track  # noqa: D104
+
+__all__ = ["track"]

uipath/telemetry/_constants.py

@@ -0,0 +1,11 @@
+_CONNECTION_STRING = ""
+
+_APP_INSIGHTS_EVENT_MARKER_ATTRIBUTE = "APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE"
+_OTEL_RESOURCE_ATTRIBUTES = "OTEL_RESOURCE_ATTRIBUTES"
+_SDK_VERSION = "SDK_VERSION"
+
+_CODE_FILEPATH = "code.filepath"
+_CODE_FUNCTION = "code.function"
+_CODE_LINENO = "code.lineno"
+
+_UNKNOWN = "unknown"

uipath/telemetry/_track.py

@@ -0,0 +1,125 @@
+import os
+from functools import wraps
+from importlib.metadata import version
+from logging import INFO, LogRecord, getLogger
+from typing import Any, Callable, Dict, Optional, Union
+
+from azure.monitor.opentelemetry import configure_azure_monitor
+from opentelemetry.sdk._logs import LoggingHandler
+from opentelemetry.util.types import Attributes
+
+from .._utils.constants import (
+    ENV_BASE_URL,
+    ENV_ORGANIZATION_ID,
+    ENV_TELEMETRY_ENABLED,
+    ENV_TENANT_ID,
+)
+from ._constants import (
+    _APP_INSIGHTS_EVENT_MARKER_ATTRIBUTE,
+    _CODE_FILEPATH,
+    _CODE_FUNCTION,
+    _CODE_LINENO,
+    _CONNECTION_STRING,
+    _OTEL_RESOURCE_ATTRIBUTES,
+    _SDK_VERSION,
+    _UNKNOWN,
+)
+
+_logger = getLogger(__name__)
+_logger.propagate = False
+
+
+class _AzureMonitorOpenTelemetryEventHandler(LoggingHandler):
+    @staticmethod
+    def _get_attributes(record: LogRecord) -> Attributes:
+        attributes = dict(LoggingHandler._get_attributes(record) or {})
+        attributes[_APP_INSIGHTS_EVENT_MARKER_ATTRIBUTE] = True
+        attributes[ENV_TENANT_ID] = os.getenv(ENV_TENANT_ID, _UNKNOWN)
+        attributes[ENV_ORGANIZATION_ID] = os.getenv(ENV_ORGANIZATION_ID, _UNKNOWN)
+        attributes[ENV_BASE_URL] = os.getenv(ENV_BASE_URL, _UNKNOWN)
+        attributes[_SDK_VERSION] = version("uipath")
+
+        if _CODE_FILEPATH in attributes:
+            del attributes[_CODE_FILEPATH]
+        if _CODE_FUNCTION in attributes:
+            del attributes[_CODE_FUNCTION]
+        if _CODE_LINENO in attributes:
+            del attributes[_CODE_LINENO]
+
+        return attributes
+
+
+class _TelemetryClient:
+    """A class to handle telemetry."""
+
+    _initialized = False
+    _enabled = os.getenv(ENV_TELEMETRY_ENABLED, "true").lower() == "true"
+
+    @staticmethod
+    def _initialize():
+        """Initialize the telemetry client."""
+        if _TelemetryClient._initialized or not _TelemetryClient._enabled:
+            return
+
+        try:
+            os.environ[_OTEL_RESOURCE_ATTRIBUTES] = (
+                "service.name=uipath-sdk,service.instance.id=" + version("uipath")
+            )
+            os.environ["OTEL_TRACES_EXPORTER"] = "none"
+
+            configure_azure_monitor(
+                connection_string=_CONNECTION_STRING,
+                disable_offline_storage=True,
+            )
+
+            _logger.addHandler(_AzureMonitorOpenTelemetryEventHandler())
+            _logger.setLevel(INFO)
+
+            _TelemetryClient._initialized = True
+        except Exception:
+            pass
+
+    @staticmethod
+    def _track_method(name: str, attrs: Optional[Dict[str, Any]] = None):
+        """Track function invocations."""
+        if not _TelemetryClient._enabled:
+            return
+
+        _TelemetryClient._initialize()
+
+        _logger.info(name, extra=attrs)
+
+
+def track(
+    name_or_func: Optional[Union[str, Callable[..., Any]]] = None,
+    *,
+    when: Optional[Union[bool, Callable[..., bool]]] = True,
+    extra: Optional[Dict[str, Any]] = None,
+):
+    """Decorator that will trace function invocations.
+
+    Args:
+        name_or_func: The name of the event to track or the function itself.
+        extra: Extra attributes to add to the telemetry event.
+    """
+
+    def decorator(func: Callable[..., Any]):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            event_name = (
+                name_or_func if isinstance(name_or_func, str) else func.__name__
+            )
+
+            should_track = when(*args, **kwargs) if callable(when) else when
+
+            if should_track:
+                _TelemetryClient._track_method(event_name, extra)
+
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    if callable(name_or_func):
+        return decorator(name_or_func)
+
+    return decorator

{uipath-2.0.51.dist-info → uipath-2.0.52.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.51
+Version: 2.0.52
 Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-python
@@ -14,9 +14,10 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.10
+Requires-Dist: azure-monitor-opentelemetry>=1.6.8
 Requires-Dist: click>=8.1.8
 Requires-Dist: httpx>=0.28.1
-Requires-Dist: opentelemetry-sdk>=1.32.1
+Requires-Dist: opentelemetry-sdk>=1.31.1
 Requires-Dist: pathlib>=1.0.1
 Requires-Dist: pydantic>=2.11.1
 Requires-Dist: python-dotenv>=1.0.1

{uipath-2.0.51.dist-info → uipath-2.0.52.dist-info}/RECORD

@@ -6,14 +6,14 @@ uipath/_uipath.py,sha256=6gBDQWyh3u6Nc1q306DERjS_oCKn0VwrfFLaPJqwfYA,3650
 uipath/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uipath/_cli/README.md,sha256=GLtCfbeIKZKNnGTCsfSVqRQ27V1btT1i2bSAyW_xZl4,474
 uipath/_cli/__init__.py,sha256=vGz3vJHkUvgK9_lKdzqiwwHkge1TCALRiOzGGwyr-8E,1885
-uipath/_cli/cli_auth.py,sha256=Gg6MR1XnDwPV5Kzn3FANDgbG8KZaCplIqWqBbZUFLOU,3918
-uipath/_cli/cli_deploy.py,sha256=lDqZQOsTPe8UyUApSQyFDMChj5HR6_hrEbn5tXtbHQE,608
-uipath/_cli/cli_init.py,sha256=qleaHOuXZyqQ001XXFX3m8W2y3pW-miwuvMBl6rHCa4,3699
-uipath/_cli/cli_invoke.py,sha256=QsWqSvwB6vFtgeNQ6kiM682d8gEl2VdHOAUJWDTlNYw,3762
-uipath/_cli/cli_new.py,sha256=6lLK_p7kRFQPgsc2i9t1v0Su4O1rC7zK55ic3y54QR8,2065
-uipath/_cli/cli_pack.py,sha256=-rUGw4vB50QpY-oNmVhIUXXmmFmk7_dhtafqZFBDyZg,14981
-uipath/_cli/cli_publish.py,sha256=f6ClG7L-jAzAs77mEOkQuq61w163yQtOZoUI5ArDg70,5973
-uipath/_cli/cli_run.py,sha256=ke4UQiqzagv4ST60-mvcC7nh1dQMw_Z6GQ2hAbnspU0,5074
+uipath/_cli/cli_auth.py,sha256=kbZzJ6wLcHM1nlqaEZDGHuMJmhlYxxY_yt1OR_DbdbE,3955
+uipath/_cli/cli_deploy.py,sha256=KPCmQ0c_NYD5JofSDao5r6QYxHshVCRxlWDVnQvlp5w,645
+uipath/_cli/cli_init.py,sha256=6qIjGFwfmeDs_7yzDqfl4zdnpDzlIjPAth0dY7kAP04,3736
+uipath/_cli/cli_invoke.py,sha256=k_T5IG5vm1uO_WEphmV-cMl5Weu04HDNnvGCmSSDQK4,3799
+uipath/_cli/cli_new.py,sha256=9378NYUBc9j-qKVXV7oja-jahfJhXBg8zKVyaon7ctY,2102
+uipath/_cli/cli_pack.py,sha256=8Ahk0vr_8eqMsq9ehhYWNfeII0VIiZVBXMpRF7Dbvtg,15018
+uipath/_cli/cli_publish.py,sha256=Ba0TJ1TSfuQbLU2AIgtM8QWkLHgr4tsAP1CaX12113U,6010
+uipath/_cli/cli_run.py,sha256=CoXx7lKUCq-wbACT5mJByx3FGc1GGe-m40nDt4qGa64,5215
 uipath/_cli/middlewares.py,sha256=IiJgjsqrJVKSXx4RcIKHWoH-SqWqpHPbhzkQEybmAos,3937
 uipath/_cli/spinner.py,sha256=bS-U_HA5yne11ejUERu7CQoXmWdabUD2bm62EfEdV8M,1107
 uipath/_cli/_auth/_auth_server.py,sha256=GRdjXUcvZO2O2GecolFJ8uMv7_DUD_VXeBJpElqmtIQ,7034
@@ -60,7 +60,7 @@ uipath/_utils/_read_overwrites.py,sha256=dODvjNnDjcYOxVKnt0KqqqXmysULLBObKaEF8gJ
 uipath/_utils/_request_override.py,sha256=_vibG78vEDWS3JKg2cJ5l6tpoBMLChUOauiqL1ozFPc,530
 uipath/_utils/_request_spec.py,sha256=iCtBLqtbWUpFG5g1wtIZBzSupKsfaRLiQFoFc_4B70Q,747
 uipath/_utils/_user_agent.py,sha256=pVJkFYacGwaQBomfwWVAvBQgdBUo62e4n3-fLIajWUU,563
-uipath/_utils/constants.py,sha256=xW-gbRasjdOwSj2rke4wfRCml69710oUaDNJcwFAZug,775
+uipath/_utils/constants.py,sha256=6jtBwOXhf6LPM6fTNAf3rh--j6Ls2W5lIYieBTSLoQM,866
 uipath/models/__init__.py,sha256=tQF2CbEjmB_1sqL1lJrtVe3K2o8F0LKzzoXKiUUBqxc,1178
 uipath/models/action_schema.py,sha256=lKDhP7Eix23fFvfQrqqNmSOiPyyNF6tiRpUu0VZIn_M,714
 uipath/models/actions.py,sha256=ekSH4YUQR4KPOH-heBm9yOgOfirndx0In4_S4VYWeEU,2993
@@ -76,12 +76,15 @@ uipath/models/job.py,sha256=f9L6_kg_VP0dAYvdcz1DWEWzy4NZPdlpHREod0uNK1E,3099
 uipath/models/llm_gateway.py,sha256=0sl5Wtve94V14H3AHwmJSoXAhoc-Fai3wJxP8HrnBPg,1994
 uipath/models/processes.py,sha256=Atvfrt6X4TYST3iA62jpS_Uxc3hg6uah11p-RaKZ6dk,2029
 uipath/models/queues.py,sha256=N_s0GKucbyjh0RnO8SxPk6wlRgvq8KIIYsfaoIY46tM,6446
+uipath/telemetry/__init__.py,sha256=Wna32UFzZR66D-RzTKlPWlvji9i2HJb82NhHjCCXRjY,61
+uipath/telemetry/_constants.py,sha256=wULKBQDsr_wcc6Hl3lWLMughrPn48S7zGmTOMiESz3I,312
+uipath/telemetry/_track.py,sha256=N2KHCXNaC7nsxI2oqHj8zYkBqyMJSNkadek53TmL_og,3738
 uipath/tracing/__init__.py,sha256=GimSzv6qkCOlHOG1WtjYKJsZqcXpA28IgoXfR33JhiA,139
 uipath/tracing/_otel_exporters.py,sha256=x0PDPmDKJcxashsuehVsSsqBCzRr6WsNFaq_3_HS5F0,3014
 uipath/tracing/_traced.py,sha256=GFxOp73jk0vGTN_H7YZOOsEl9rVLaEhXGztMiYKIA-8,16634
 uipath/tracing/_utils.py,sha256=5SwsTGpHkIouXBndw-u8eCLnN4p7LM8DsTCCuf2jJgs,10165
-uipath-2.0.51.dist-info/METADATA,sha256=47ZdjgQM8vSG8AUablbu0_DYJ0X518Wsc2BB1F9EYBo,6254
-uipath-2.0.51.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-uipath-2.0.51.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
-uipath-2.0.51.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
-uipath-2.0.51.dist-info/RECORD,,
+uipath-2.0.52.dist-info/METADATA,sha256=dCTRBp4flmPG4H5CPIV06TF6ENiCBy-a4lGOT3ZN6AU,6304
+uipath-2.0.52.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+uipath-2.0.52.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
+uipath-2.0.52.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
+uipath-2.0.52.dist-info/RECORD,,