feat: add user agent format

Author: justinmerrell

runpod/__init__.py

@@ -2,6 +2,7 @@
 
 import os
 import logging
+import platform
 
 from . import serverless
 from .serverless.modules.rp_logger import RunPodLogger
@@ -35,6 +36,13 @@
 endpoint_url_base = "https://api.runpod.ai/v2"  # pylint: disable=invalid-name
 
 
+# ----------------------------- Config User Agent ---------------------------- #
+os_info = f"{platform.system()} {platform.release()}; {platform.machine()}"
+USER_AGENT = f"RunPod-Python-SDK/{__version__} ({os_info}) Language/Python{platform.python_version()}"  # pylint: disable=line-too-long
+
+if os.environ.get('RUNPOD_UA_INTEGRATION') is not None:
+    USER_AGENT += f" {os.environ.get('RUNPOD_UA_INTEGRATION')}"
+
 # --------------------------- Force Logging Levels --------------------------- #
 logging.getLogger("urllib3").setLevel(logging.WARNING)
 logging.getLogger("paramiko").setLevel(logging.WARNING)

runpod/api/graphql.py

@@ -7,19 +7,23 @@
 
 import requests
 
-from runpod import error
+from runpod import error, USER_AGENT
 
 HTTP_STATUS_UNAUTHORIZED = 401
 
+
 def run_graphql_query(query: str) -> Dict[str, Any]:
     '''
     Run a GraphQL query
     '''
     from runpod import api_key  # pylint: disable=import-outside-toplevel, cyclic-import
     url = f"https://api.runpod.io/graphql?api_key={api_key}"
+
     headers = {
         "Content-Type": "application/json",
+        "User-Agent": USER_AGENT,
     }
+
     data = json.dumps({"query": query})
     response = requests.post(url, headers=headers, data=data, timeout=30)
 

runpod/serverless/worker.py

@@ -8,6 +8,7 @@
 
 import aiohttp
 
+from runpod import USER_AGENT
 from runpod.serverless.modules import (
     rp_logger, rp_local, rp_handler, rp_ping,
     rp_scale
@@ -24,7 +25,10 @@
 
 def _get_auth_header() -> Dict[str, str]:
     """ Returns the authorization header with the API key. """
-    return {"Authorization": f"{os.environ.get('RUNPOD_AI_API_KEY')}"}
+    return {
+        "Authorization": f"{os.environ.get('RUNPOD_AI_API_KEY')}",
+        "User-Agent": USER_AGENT
+    }
 
 
 def _is_local(config) -> bool: