jetstream-api 0.1.3__tar.gz → 0.1.5__tar.gz

{jetstream_api-0.1.3/jetstream_api.egg-info → jetstream_api-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jetstream-api
-Version: 0.1.3
+Version: 0.1.5
 Summary: Python client API for iLink M.O.M. (Message Oriented Middleware)
 Author: snowjeans
 License: Boost Software License - Version 1.0 - August 17th, 2003
@@ -42,6 +42,15 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Dynamic: license-file
 
-# jetstream-client
+# jetstream-api
 
-ILink 클라이언트 API입니다.
+Python으로 작성된 ILink 클라이언트 API입니다.
+
+## 시스템 요구 사항
+시스템에 python 13 이상, pip가 설치되어 있어야 합니다.
+
+## 설치 방법
+pip install jetstream-api
+
+## 개발자 가이드 문서
+추후 업데이트 예정..

jetstream_api-0.1.5/README.md

@@ -0,0 +1,12 @@
+# jetstream-api
+
+Python으로 작성된 ILink 클라이언트 API입니다.
+
+## 시스템 요구 사항
+시스템에 python 13 이상, pip가 설치되어 있어야 합니다.
+
+## 설치 방법
+pip install jetstream-api
+
+## 개발자 가이드 문서
+추후 업데이트 예정..

{jetstream_api-0.1.3 → jetstream_api-0.1.5}/ilink/__init__.py

@@ -1,90 +1,90 @@
-"""iLink - Python client API for iLink M.O.M. (Message Oriented Middleware)."""
-
-__version__ = "0.1.3"
-
-# --- Admin / Service ---
-from .admin import ILAdminService, ILAdminQmgr, ILLogBrowser, ILQueueBrowser
-
-# --- Queue Manager & Queue ---
-from .qmgr import ILQmgr, ILQueue
-
-# --- Message ---
-from .msg import ILMsg, ILMsgUtil
-
-# --- Constants & Enums ---
-from .common import ILC, ILCC, ILRC, MatchOption
-
-# --- Properties ---
-from .properties import (
-    DestItem,
-    PartitionItem,
-    ILQueueProperty,
-    ILChannelProperty,
-    ILChannelType,
-    ILChannelStatus,
-    ILChannelDirection,
-    ILChannelSecurity,
-    ILChannelBalanceMode,
-    ILQmgrProperty,
-    ILSessionProperty,
-    ILServiceProperty,
-    ILSpokeProperty,
-    ILAccessRuleProperty,
-    ILSecureFileProperty,
-    ILQueueRealTimeInfo,
-    ILQueueFlow,
-)
-
-# --- Exceptions ---
-from .exception import (
-    ILException,
-    ILNoMsgException,
-    ILTimeoutException,
-    ILOperationException,
-    ILSessionException,
-    ILMsgTypeException,
-)
-
-__all__ = [
-    # Admin
-    "ILAdminService",
-    "ILAdminQmgr",
-    "ILLogBrowser",
-    "ILQueueBrowser",
-    # QMgr / Queue
-    "ILQmgr",
-    "ILQueue",
-    # Message
-    "ILMsg",
-    "ILMsgUtil",
-    # Constants
-    "ILC",
-    "ILCC",
-    "ILRC",
-    "MatchOption",
-    # Properties
-    "DestItem",
-    "PartitionItem",
-    "ILQueueProperty",
-    "ILChannelProperty",
-    "ILChannelType",
-    "ILChannelStatus",
-    "ILChannelDirection",
-    "ILChannelSecurity",
-    "ILChannelBalanceMode",
-    "ILQmgrProperty",
-    "ILSessionProperty",
-    "ILServiceProperty",
-    "ILSpokeProperty",
-    "ILAccessRuleProperty",
-    "ILSecureFileProperty",
-    "ILQueueRealTimeInfo",
-    "ILQueueFlow",
-    # Exceptions
-    "ILException",
-    "ILNoMsgException",
-    "ILTimeoutException",
-    "ILOperationException",
-    "ILSessionException",
-    "ILMsgTypeException",
-]
+"""iLink - Python client API for iLink M.O.M. (Message Oriented Middleware)."""
+
+__version__ = "0.1.5"
+
+# --- Admin / Service ---
+from .admin import ILAdminService, ILAdminQmgr, ILLogBrowser, ILQueueBrowser
+
+# --- Queue Manager & Queue ---
+from .qmgr import ILQmgr, ILQueue
+
+# --- Message ---
+from .msg import ILMsg, ILMsgUtil
+
+# --- Constants & Enums ---
+from .common import ILC, ILCC, ILRC, MatchOption
+
+# --- Properties ---
+from .properties import (
+    DestItem,
+    PartitionItem,
+    ILQueueProperty,
+    ILChannelProperty,
+    ILChannelType,
+    ILChannelStatus,
+    ILChannelDirection,
+    ILChannelSecurity,
+    ILChannelBalanceMode,
+    ILQmgrProperty,
+    ILSessionProperty,
+    ILServiceProperty,
+    ILSpokeProperty,
+    ILAccessRuleProperty,
+    ILSecureFileProperty,
+    ILQueueRealTimeInfo,
+    ILQueueFlow,
+)
+
+# --- Exceptions ---
+from .exception import (
+    ILException,
+    ILNoMsgException,
+    ILTimeoutException,
+    ILOperationException,
+    ILSessionException,
+    ILMsgTypeException,
+)
+
+__all__ = [
+    # Admin
+    "ILAdminService",
+    "ILAdminQmgr",
+    "ILLogBrowser",
+    "ILQueueBrowser",
+    # QMgr / Queue
+    "ILQmgr",
+    "ILQueue",
+    # Message
+    "ILMsg",
+    "ILMsgUtil",
+    # Constants
+    "ILC",
+    "ILCC",
+    "ILRC",
+    "MatchOption",
+    # Properties
+    "DestItem",
+    "PartitionItem",
+    "ILQueueProperty",
+    "ILChannelProperty",
+    "ILChannelType",
+    "ILChannelStatus",
+    "ILChannelDirection",
+    "ILChannelSecurity",
+    "ILChannelBalanceMode",
+    "ILQmgrProperty",
+    "ILSessionProperty",
+    "ILServiceProperty",
+    "ILSpokeProperty",
+    "ILAccessRuleProperty",
+    "ILSecureFileProperty",
+    "ILQueueRealTimeInfo",
+    "ILQueueFlow",
+    # Exceptions
+    "ILException",
+    "ILNoMsgException",
+    "ILTimeoutException",
+    "ILOperationException",
+    "ILSessionException",
+    "ILMsgTypeException",
+]

{jetstream_api-0.1.3 → jetstream_api-0.1.5}/ilink/admin.py

@@ -2829,6 +2829,172 @@ class ILAdminQmgr:
             raise ILException(exc) from exc
 
 
+    # ------------------------------------------------------------------
+    # v6.3.4 statistics / diagnosis / time-series APIs (v0.1.5)
+    # ------------------------------------------------------------------
+
+    def getStatisticsInfo(self, level: int = 3, windowMin: int = 60) -> str:
+        """Retrieve the queue manager statistics as a JSON string.
+
+        The response contains four blocks: ``current`` (latest raw samples),
+        ``window_agg`` (window aggregates), ``props`` (queue configs) and
+        ``descriptors`` (per-minute trend slopes).
+
+        Requires engine v6.3.4 (rev 3231) or later.
+
+        Args:
+            level: Detail level (1-3, normally 3).
+            windowMin: Aggregation window in minutes (normally 60).
+
+        Returns:
+            Statistics JSON string, or an empty string when statistics
+            collection is disabled on the queue manager.
+        """
+        try:
+            if 0 < self.revision < 3231:
+                raise ILOperationException(
+                    "MIMQE_NOT_SUPPORTED (getStatisticsInfo requires engine rev 3231+, "
+                    f"current: {self.revision})"
+                )
+            res_msg = self.service.inquire(
+                ILMsgUtil.create_request_msg_with_qmgr(
+                    self.qmgrName, ILC.MIMQ_GET_STATISTICS_INFO, None,
+                    str(level), str(windowMin)
+                ),
+                False,
+            )
+            return self._pickStatText(res_msg)
+        except _PASSTHROUGH_EXCEPTIONS:
+            raise
+        except Exception as exc:
+            raise ILException(exc) from exc
+
+    def getDiagnosisInfo(
+        self,
+        targetType: str,
+        targetName: str = "",
+        level: int = 3,
+        windowMin: int = 60,
+        format: str = "TEXT",
+    ) -> str:
+        """Retrieve an engine-side operational diagnosis.
+
+        The engine evaluates its statistics against built-in rules and returns
+        either an 80-column ASCII report (``format="TEXT"``) or a structured
+        JSON document (``format="JSON"``) with the schema
+        ``{qmgr, target, window, verdict(NORMAL|WARNING|CRITICAL), score(0-100),
+        counts, findings[], rankings[](MANAGER only), notFound}``.
+
+        Requires engine v6.3.4 (rev 3263) or later.
+
+        Args:
+            targetType: One of ``"MANAGER"``, ``"QUEUE"``, ``"CHANNEL"``, ``"CLIENT"``.
+            targetName: Target object name (empty for ``MANAGER``).
+            level: Output detail (1=summary, 2=+scorecard/WARN, 3=+rankings).
+            windowMin: Aggregation window in minutes.
+            format: ``"TEXT"`` or ``"JSON"``.
+
+        Returns:
+            Diagnosis string, or an empty string when statistics collection
+            is disabled on the queue manager.
+        """
+        try:
+            if 0 < self.revision < 3263:
+                raise ILOperationException(
+                    "MIMQE_NOT_SUPPORTED (getDiagnosisInfo requires engine rev 3263+, "
+                    f"current: {self.revision})"
+                )
+            options = f"{level},{windowMin},{format if format else 'TEXT'}"
+            res_msg = self.service.inquire(
+                ILMsgUtil.create_request_msg_with_qmgr(
+                    self.qmgrName, ILC.MIMQ_GET_DIAGNOSIS_INFO, None,
+                    targetType, targetName or "", options
+                ),
+                False,
+            )
+            return self._pickStatText(res_msg)
+        except _PASSTHROUGH_EXCEPTIONS:
+            raise
+        except Exception as exc:
+            raise ILException(exc) from exc
+
+    def getStatSeries(
+        self,
+        domain: str,
+        objectName: str = "",
+        metrics: str = "",
+        resolution: str = "",
+        last: int = 0,
+        maxPoints: int = 0,
+    ) -> str:
+        """Retrieve a statistics time-series as a JSON string.
+
+        Combines domain x object x metrics x resolution to provide pinpoint
+        trends (queue depth, in/out bytes, cpu-mem-disk, channel throughput,
+        error frequency, ...).  Response schema:
+        ``{qmgr, domain, name, resolution, metrics, range, periodMs,
+        pointCount, downsampled, points:[{ts, <metric>...}]}``.
+        When more than ``maxPoints`` points match, the series is stride
+        downsampled (``downsampled=true``).
+
+        Requires engine v6.3.4 (rev 3263) or later.
+
+        Args:
+            domain: ``"queue"`` | ``"channel"`` | ``"client"`` | ``"resource"`` | ``"error"``.
+            objectName: Object name (empty = queue-manager-wide totals;
+                always empty for ``resource``).
+            metrics: Comma-separated metrics (empty = per-domain defaults,
+                e.g. ``"depth,putMsgCount"``, ``"cpu.total"``, rollup
+                selector ``"depth.max"``).
+            resolution: ``"minute"`` (default) | ``"hour"`` | ``"day"`` | ``"month"``.
+            last: Last N periods (0 = per-resolution default: 60m/24h/30d/12mo).
+            maxPoints: Point cap (0 = default 500, max 2000).
+
+        Returns:
+            Time-series JSON string, or an empty string when statistics
+            collection is disabled on the queue manager.
+        """
+        try:
+            if 0 < self.revision < 3263:
+                raise ILOperationException(
+                    "MIMQE_NOT_SUPPORTED (getStatSeries requires engine rev 3263+, "
+                    f"current: {self.revision})"
+                )
+            options = ""
+            if metrics:
+                options += f"metrics={metrics};"
+            if resolution:
+                options += f"res={resolution};"
+            if last > 0:
+                options += f"last={last};"
+            if maxPoints > 0:
+                options += f"maxPoints={maxPoints};"
+            res_msg = self.service.inquire(
+                ILMsgUtil.create_request_msg_with_qmgr(
+                    self.qmgrName, ILC.MIMQ_GET_STAT_SERIES, None,
+                    domain, objectName or "", options
+                ),
+                False,
+            )
+            return self._pickStatText(res_msg)
+        except _PASSTHROUGH_EXCEPTIONS:
+            raise
+        except Exception as exc:
+            raise ILException(exc) from exc
+
+    def _pickStatText(self, res_msg: ILMsg) -> str:
+        # Shared response handling for statistics/diagnosis/series calls.
+        # A REPORT with MIMQ_STATISTICS_NOT_ENABLED means statistics are off
+        # -> return an empty string instead of raising (same contract as the
+        # C++ ILAdminAPI and the Java client).
+        if res_msg.getType() == ILC.MIMQ_REPORT_MESSAGE:
+            report_msg = res_msg.getReportMsg()
+            if report_msg.getCode() == ILRC.MIMQ_STATISTICS_NOT_ENABLED:
+                return ""
+            raise ILOperationException(report_msg.getArg2())
+        return res_msg.getDataMsg().getData().decode("utf-8")
+
+
 class ILLogBrowser:
     """Iterator-style browser for reading server, error, or session log entries.