feat: POC to have legacy pilots sending logs

Author: Robin VAN DE MERGHEL

diracx-client/src/diracx/client/_generated/aio/operations/_operations.py

@@ -56,7 +56,9 @@
     build_pilots_add_pilot_stamps_request,
     build_pilots_delete_pilots_request,
     build_pilots_get_pilot_jobs_request,
+    build_pilots_search_logs_request,
     build_pilots_search_request,
+    build_pilots_send_message_request,
     build_pilots_summary_request,
     build_pilots_update_pilot_fields_request,
     build_well_known_get_installation_metadata_request,
@@ -2705,6 +2707,143 @@ async def search(
 
         return deserialized  # type: ignore
 
+    @overload
+    async def search_logs(
+        self,
+        body: Optional[_models.SearchParams] = None,
+        *,
+        page: int = 1,
+        per_page: int = 100,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> List[Dict[str, Any]]:
+        """Search Logs.
+
+        Search Logs.
+
+        :param body: Default value is None.
+        :type body: ~_generated.models.SearchParams
+        :keyword page: Default value is 1.
+        :paramtype page: int
+        :keyword per_page: Default value is 100.
+        :paramtype per_page: int
+        :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: list of dict mapping str to any
+        :rtype: list[dict[str, any]]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
+    async def search_logs(
+        self,
+        body: Optional[IO[bytes]] = None,
+        *,
+        page: int = 1,
+        per_page: int = 100,
+        content_type: str = "application/json",
+        **kwargs: Any
+    ) -> List[Dict[str, Any]]:
+        """Search Logs.
+
+        Search Logs.
+
+        :param body: Default value is None.
+        :type body: IO[bytes]
+        :keyword page: Default value is 1.
+        :paramtype page: int
+        :keyword per_page: Default value is 100.
+        :paramtype per_page: int
+        :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: list of dict mapping str to any
+        :rtype: list[dict[str, any]]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @distributed_trace_async
+    async def search_logs(
+        self,
+        body: Optional[Union[_models.SearchParams, IO[bytes]]] = None,
+        *,
+        page: int = 1,
+        per_page: int = 100,
+        **kwargs: Any
+    ) -> List[Dict[str, Any]]:
+        """Search Logs.
+
+        Search Logs.
+
+        :param body: Is either a SearchParams type or a IO[bytes] type. Default value is None.
+        :type body: ~_generated.models.SearchParams or IO[bytes]
+        :keyword page: Default value is 1.
+        :paramtype page: int
+        :keyword per_page: Default value is 100.
+        :paramtype per_page: int
+        :return: list of dict mapping str to any
+        :rtype: list[dict[str, any]]
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
+        _params = kwargs.pop("params", {}) or {}
+
+        content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
+        cls: ClsType[List[Dict[str, Any]]] = kwargs.pop("cls", None)
+
+        content_type = content_type or "application/json"
+        _json = None
+        _content = None
+        if isinstance(body, (IOBase, bytes)):
+            _content = body
+        else:
+            if body is not None:
+                _json = self._serialize.body(body, "SearchParams")
+            else:
+                _json = None
+
+        _request = build_pilots_search_logs_request(
+            page=page,
+            per_page=per_page,
+            content_type=content_type,
+            json=_json,
+            content=_content,
+            headers=_headers,
+            params=_params,
+        )
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+            _request, stream=_stream, **kwargs
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [200, 206]:
+            map_error(status_code=response.status_code, response=response, error_map=error_map)
+            raise HttpResponseError(response=response)
+
+        response_headers = {}
+        if response.status_code == 206:
+            response_headers["Content-Range"] = self._deserialize("str", response.headers.get("Content-Range"))
+
+        deserialized = self._deserialize("[{object}]", pipeline_response.http_response)
+
+        if cls:
+            return cls(pipeline_response, deserialized, response_headers)  # type: ignore
+
+        return deserialized  # type: ignore
+
     @overload
     async def summary(
         self, body: _models.SummaryParams, *, content_type: str = "application/json", **kwargs: Any
@@ -2799,3 +2938,94 @@ async def summary(self, body: Union[_models.SummaryParams, IO[bytes]], **kwargs:
             return cls(pipeline_response, deserialized, {})  # type: ignore
 
         return deserialized  # type: ignore
+
+    @overload
+    async def send_message(
+        self, body: _models.BodyPilotsSendMessage, *, content_type: str = "application/json", **kwargs: Any
+    ) -> None:
+        """Send Message.
+
+        Send logs with legacy pilot.
+
+        :param body: Required.
+        :type body: ~_generated.models.BodyPilotsSendMessage
+        :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: None
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
+    async def send_message(self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any) -> None:
+        """Send Message.
+
+        Send logs with legacy pilot.
+
+        :param body: Required.
+        :type body: IO[bytes]
+        :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
+         Default value is "application/json".
+        :paramtype content_type: str
+        :return: None
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @distributed_trace_async
+    async def send_message(self, body: Union[_models.BodyPilotsSendMessage, IO[bytes]], **kwargs: Any) -> None:
+        """Send Message.
+
+        Send logs with legacy pilot.
+
+        :param body: Is either a BodyPilotsSendMessage type or a IO[bytes] type. Required.
+        :type body: ~_generated.models.BodyPilotsSendMessage or IO[bytes]
+        :return: None
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        error_map: MutableMapping = {
+            401: ClientAuthenticationError,
+            404: ResourceNotFoundError,
+            409: ResourceExistsError,
+            304: ResourceNotModifiedError,
+        }
+        error_map.update(kwargs.pop("error_map", {}) or {})
+
+        _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
+        _params = kwargs.pop("params", {}) or {}
+
+        content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
+        cls: ClsType[None] = kwargs.pop("cls", None)
+
+        content_type = content_type or "application/json"
+        _json = None
+        _content = None
+        if isinstance(body, (IOBase, bytes)):
+            _content = body
+        else:
+            _json = self._serialize.body(body, "BodyPilotsSendMessage")
+
+        _request = build_pilots_send_message_request(
+            content_type=content_type,
+            json=_json,
+            content=_content,
+            headers=_headers,
+            params=_params,
+        )
+        _request.url = self._client.format_url(_request.url)
+
+        _stream = False
+        pipeline_response: PipelineResponse = await self._client._pipeline.run(  # pylint: disable=protected-access
+            _request, stream=_stream, **kwargs
+        )
+
+        response = pipeline_response.http_response
+
+        if response.status_code not in [204]:
+            map_error(status_code=response.status_code, response=response, error_map=error_map)
+            raise HttpResponseError(response=response)
+
+        if cls:
+            return cls(pipeline_response, None, {})  # type: ignore

diracx-client/src/diracx/client/_generated/models/__init__.py

@@ -15,6 +15,7 @@
     BodyAuthGetOidcToken,
     BodyAuthGetOidcTokenGrantType,
     BodyPilotsAddPilotStamps,
+    BodyPilotsSendMessage,
     BodyPilotsUpdatePilotFields,
     GroupInfo,
     HTTPValidationError,
@@ -23,6 +24,7 @@
     InsertedJob,
     JobCommand,
     JobStatusUpdate,
+    LogLine,
     Metadata,
     OpenIDConfiguration,
     PilotFieldsMapping,
@@ -66,6 +68,7 @@
     "BodyAuthGetOidcToken",
     "BodyAuthGetOidcTokenGrantType",
     "BodyPilotsAddPilotStamps",
+    "BodyPilotsSendMessage",
     "BodyPilotsUpdatePilotFields",
     "GroupInfo",
     "HTTPValidationError",
@@ -74,6 +77,7 @@
     "InsertedJob",
     "JobCommand",
     "JobStatusUpdate",
+    "LogLine",
     "Metadata",
     "OpenIDConfiguration",
     "PilotFieldsMapping",

diracx-client/src/diracx/client/_generated/models/_models.py

@@ -162,6 +162,41 @@ def __init__(
         self.pilot_status = pilot_status
 
 
+class BodyPilotsSendMessage(_serialization.Model):
+    """Body_pilots_send_message.
+
+    All required parameters must be populated in order to send to server.
+
+    :ivar lines: Message from the pilot to the logging system. Required.
+    :vartype lines: list[~_generated.models.LogLine]
+    :ivar pilot_stamp: PilotStamp, required as legacy pilots do not have a token with stamp in it.
+     Required.
+    :vartype pilot_stamp: str
+    """
+
+    _validation = {
+        "lines": {"required": True},
+        "pilot_stamp": {"required": True},
+    }
+
+    _attribute_map = {
+        "lines": {"key": "lines", "type": "[LogLine]"},
+        "pilot_stamp": {"key": "pilot_stamp", "type": "str"},
+    }
+
+    def __init__(self, *, lines: List["_models.LogLine"], pilot_stamp: str, **kwargs: Any) -> None:
+        """
+        :keyword lines: Message from the pilot to the logging system. Required.
+        :paramtype lines: list[~_generated.models.LogLine]
+        :keyword pilot_stamp: PilotStamp, required as legacy pilots do not have a token with stamp in
+         it. Required.
+        :paramtype pilot_stamp: str
+        """
+        super().__init__(**kwargs)
+        self.lines = lines
+        self.pilot_stamp = pilot_stamp
+
+
 class BodyPilotsUpdatePilotFields(_serialization.Model):
     """Body_pilots_update_pilot_fields.
 
@@ -503,6 +538,53 @@ def __init__(
         self.source = source
 
 
+class LogLine(_serialization.Model):
+    """LogLine.
+
+    All required parameters must be populated in order to send to server.
+
+    :ivar timestamp: Timestamp. Required.
+    :vartype timestamp: str
+    :ivar severity: Severity. Required.
+    :vartype severity: str
+    :ivar message: Message. Required.
+    :vartype message: str
+    :ivar scope: Scope. Required.
+    :vartype scope: str
+    """
+
+    _validation = {
+        "timestamp": {"required": True},
+        "severity": {"required": True},
+        "message": {"required": True},
+        "scope": {"required": True},
+    }
+
+    _attribute_map = {
+        "timestamp": {"key": "timestamp", "type": "str"},
+        "severity": {"key": "severity", "type": "str"},
+        "message": {"key": "message", "type": "str"},
+        "scope": {"key": "scope", "type": "str"},
+    }
+
+    def __init__(self, *, timestamp: str, severity: str, message: str, scope: str, **kwargs: Any) -> None:
+        """
+        :keyword timestamp: Timestamp. Required.
+        :paramtype timestamp: str
+        :keyword severity: Severity. Required.
+        :paramtype severity: str
+        :keyword message: Message. Required.
+        :paramtype message: str
+        :keyword scope: Scope. Required.
+        :paramtype scope: str
+        """
+        super().__init__(**kwargs)
+        self.timestamp = timestamp
+        self.severity = severity
+        self.message = message
+        self.scope = scope
+
+
 class Metadata(_serialization.Model):
     """Metadata.