polaris-python 0.0.1.dev3__py3-none-any.whl → 0.0.1.dev4__py3-none-any.whl

polaris/_version.py

@@ -13,4 +13,4 @@
 # CONDITIONS OF ANY KIND, either express or implied. See the License for the
 # specific language governing permissions and limitations under the License.
 
-__version__ = "0.0.1.dev3"
+__version__ = "0.0.1.dev4"

polaris/api/log.py

@@ -97,7 +97,9 @@ def _create_file_logger(name, path, level, max_bytes, backup_count, max_age_days
     path.parent.mkdir(parents=True, exist_ok=True)
     handler = ExclusiveRotatingFileHandler(path, "a", max_bytes, backup_count,
                                           encoding="utf-8", max_age_days=max_age_days)
-    handler.setFormatter(logging.Formatter("[%(asctime)s][%(levelname)s][%(process)d]: %(message)s"))
+    handler.setFormatter(logging.Formatter(
+        "[%(asctime)s][%(levelname)s][%(process)d][%(filename)s:%(lineno)d]: %(message)s"
+    ))
     instance = logging.Logger(name, level=level)
     instance.addHandler(handler)
     instance.propagate = False

polaris/plugin/server_connector/grpc_connector/connection.py

@@ -19,12 +19,14 @@ from __future__ import annotations
 
 import asyncio
 import itertools
+import logging
 import time
 import traceback
 from collections.abc import AsyncIterator, Awaitable, Callable, Sequence
 from dataclasses import dataclass
 
 import grpc
+from google.protobuf.json_format import MessageToJson
 from google.protobuf.message import Message
 from polarismesh_specification.api.v1.service_manage import (
     client_pb2,
@@ -53,6 +55,7 @@ _REQUEST_ID_PREFIX = {
     "DownloadSkill": "1",
 }
 _REQUEST_ID_SEEDS = {prefix: itertools.count(1) for prefix in set(_REQUEST_ID_PREFIX.values())}
+REPORT_CLIENT_LOG_INTERVAL_SECONDS = 30 * 60
 
 
 def _request_id(method: str) -> tuple[tuple[str, str], ...]:
@@ -72,6 +75,32 @@ def _response_location(response) -> str:
     return "-"
 
 
+def _report_client_request_summary(request) -> str:
+    try:
+        client_type = client_pb2.Client.ClientType.Name(request.type)
+    except ValueError:
+        client_type = str(request.type)
+    config_metadata = request.config_metadata.value if request.HasField("config_metadata") else ""
+    config_enabled = request.config_enabled.value if request.HasField("config_enabled") else False
+    stats = [
+        (
+            f"{stat.protocol.value or '-'}://{stat.target.value or '-'}:"
+            f"{stat.port.value}{stat.path.value or '/'}"
+        )
+        for stat in request.stat
+    ]
+    return (
+        f"clientId={request.id.value} host={request.host.value} "
+        f"clientType={client_type} clientVersion={request.version.value} "
+        f"configEnabled={config_enabled} configMetadataLen={len(config_metadata)} "
+        f"stats={','.join(stats) or '-'}"
+    )
+
+
+def _compact_message_json(message: Message) -> str:
+    return MessageToJson(message, preserving_proto_field_name=True, indent=None)
+
+
 @dataclass(frozen=True, slots=True)
 class GrpcSettings:
     """Values required by the gRPC transport."""
@@ -115,6 +144,25 @@ class GrpcConnection:
         self.address_resolver = None
         self.on_switch = None
         self._switch_task = None
+        self._last_report_client_log = None
+        self._last_report_client_log_at = None
+
+    def _should_log_report_client(self, request) -> bool:
+        content = request.SerializeToString(deterministic=True)
+        now = time.monotonic()
+        if (
+            content == self._last_report_client_log
+            and self._last_report_client_log_at is not None
+            and now - self._last_report_client_log_at < REPORT_CLIENT_LOG_INTERVAL_SECONDS
+        ):
+            return False
+        self._last_report_client_log = content
+        self._last_report_client_log_at = now
+        return True
+
+    def _reset_report_client_log(self) -> None:
+        self._last_report_client_log = None
+        self._last_report_client_log_at = None
 
     def _metadata(self) -> tuple[tuple[str, str], ...]:
         if not self.settings.token:
@@ -160,29 +208,68 @@ class GrpcConnection:
             address = self._addresses[self._address_index % len(self._addresses)]
             started = time.monotonic()
             response = None
+            request_metadata = _request_id(method) + extra_metadata + self._metadata()
+            request_id = next(
+                (value for key, value in request_metadata if key == "request-id"),
+                "-",
+            )
             try:
+                if method == "ReportClient" and self.base_logger.isEnabledFor(logging.DEBUG):
+                    self.base_logger.debug(
+                        "reportClient request address=%s requestId=%s request=%s",
+                        address,
+                        request_id,
+                        _compact_message_json(request),
+                    )
                 stub = await self._rpc_stub(method, address)
                 rpc: Callable[..., Awaitable[response_pb2.Response]] = getattr(stub, method)
                 response = await rpc(
                     request,
                     timeout=self.settings.timeout_seconds if timeout_seconds is None else timeout_seconds,
-                    metadata=_request_id(method) + extra_metadata + self._metadata(),
+                    metadata=request_metadata,
                 )
                 code = response_code(response)
                 cost = (time.monotonic() - started) * 1000
                 if method == "ReportClient":
+                    summary = _report_client_request_summary(request)
                     if code == ServerCode.ExecuteSuccess:
-                        self.base_logger.info(
-                            "reportClient success address=%s serverCode=%s cost=%.3fms location=%s",
-                            address, code, cost, _response_location(response),
-                        )
+                        if self._should_log_report_client(request):
+                            self.base_logger.info(
+                                "reportClient success address=%s serverCode=%s cost=%.3fms "
+                                "location=%s requestId=%s %s",
+                                address,
+                                code,
+                                cost,
+                                _response_location(response),
+                                request_id,
+                                summary,
+                            )
                     else:
+                        self._reset_report_client_log()
                         self.base_logger.warning(
-                            "reportClient failed address=%s serverCode=%s cost=%.3fms location=%s",
-                            address, code, cost, _response_location(response),
+                            "reportClient failed address=%s serverCode=%s cost=%.3fms "
+                            "location=%s requestId=%s %s",
+                            address,
+                            code,
+                            cost,
+                            _response_location(response),
+                            request_id,
+                            summary,
+                        )
+                    if self.base_logger.isEnabledFor(logging.DEBUG):
+                        self.base_logger.debug(
+                            "reportClient response address=%s requestId=%s response=%s",
+                            address,
+                            request_id,
+                            _compact_message_json(response),
                         )
-                    self.logger.debug("Polaris ReportClient success address=%s code=%s cost=%.3fms",
-                                      address, code, cost)
+                    self.logger.debug(
+                        "Polaris ReportClient success address=%s code=%s requestId=%s %s",
+                        address,
+                        code,
+                        request_id,
+                        summary,
+                    )
                 else:
                     # Heartbeats repeat on every TTL; keep them out of the INFO stream like polaris-go.
                     quiet_methods = {"Heartbeat", "GetServiceContract"}
@@ -196,12 +283,28 @@ class GrpcConnection:
                 last_error = exc
                 cost = (time.monotonic() - started) * 1000
                 if method == "ReportClient":
+                    summary = _report_client_request_summary(request)
+                    self._reset_report_client_log()
                     self.base_logger.warning(
-                        "reportClient failed address=%s code=%s cost=%.3fms: %s",
-                        address, exc.code().name, cost, exc.details(),
+                        "reportClient failed address=%s code=%s cost=%.3fms "
+                        "requestId=%s %s: %s",
+                        address,
+                        exc.code().name,
+                        cost,
+                        request_id,
+                        summary,
+                        exc.details(),
+                    )
+                    self.logger.debug(
+                        "Polaris ReportClient failed address=%s code=%s cost=%.3fms "
+                        "requestId=%s %s: %s",
+                        address,
+                        exc.code().name,
+                        cost,
+                        request_id,
+                        summary,
+                        exc.details(),
                     )
-                    self.logger.debug("Polaris ReportClient failed address=%s code=%s cost=%.3fms: %s",
-                                      address, exc.code().name, cost, exc.details())
                 else:
                     self.logger.error(
                         "Polaris %s failed address=%s code=%s cost=%.3fms: %s",

{polaris_python-0.0.1.dev3.dist-info → polaris_python-0.0.1.dev4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polaris-python
-Version: 0.0.1.dev3
+Version: 0.0.1.dev4
 Summary: Python SDK for Polaris service governance.
 Author-email: evelynwei <evelynwei@tencent.com>
 License-Expression: BSD-3-Clause
@@ -189,24 +189,36 @@ See [TLS](docs/guides/tls.md).
 
 ## Examples
 
-Run all offline verifications:
+From the repository root, Quickstart reads its adjacent `polaris.yaml`:
 
 ```bash
-./examples/verify_all.sh
+export POLARIS_SERVER_ADDRESS=127.0.0.1:8091
+export POLARIS_TOKEN=
+make -C examples run DEMO=quickstart/provider ARGS='--service-token "" --port 0'
+# Another terminal with the same environment
+make -C examples run DEMO=quickstart/consumer ARGS='--port 18080'
 ```
 
-Run or inspect a single demo:
+`--service-token` is required; an empty string works when service authentication is
+disabled. Runs stay in the foreground; use separate terminals or `&`.
 
 ```bash
-cd examples/quickstart
-./run.sh --help
-./verify.sh
-./logs.sh --latest --tail 30
-./cleanup.sh --force
+make -C examples logs ARGS='--only quickstart --latest --tail 30'
+make -C examples cleanup ARGS='--only quickstart --dry-run'
+make -C examples cleanup ARGS='--only quickstart'
 ```
 
-Start with [examples/README.md](examples/README.md). Real registry examples require
-`POLARIS_E2E=1`.
+See [examples/README.md](examples/README.md) for demos, Makefiles and log/cleanup options.
+
+Verification and test artifacts belong to `integration/`:
+
+```bash
+./integration/verify.sh --only quickstart
+./integration/verify_e2e.sh --only quickstart
+```
+
+See the [integration guide](integration/README.md) and
+[quickstart tests](integration/scenarios/quickstart/test.md) for checks and test artifacts.
 
 ## License
 

{polaris_python-0.0.1.dev3.dist-info → polaris_python-0.0.1.dev4.dist-info}/RECORD

@@ -1,11 +1,11 @@
 polaris/__init__.py,sha256=g0tzWZkbmiA08jI9eamped66UghtWNHP52QNSgPeJ28,2471
-polaris/_version.py,sha256=KMXFk_FwAdUVDsP4hvXM2JXs47QArQgdsX84gjLynJ8,710
+polaris/_version.py,sha256=24cjgsjZ51oQN2WKxw5dhXfg4gHwfuN2ubPhXnYC6W8,710
 polaris/plugin_manager.py,sha256=5hngFEOGMSGTeI0dnk-y4Y4Q4CXttS3fsZyxu-rGELg,5690
 polaris/api/__init__.py,sha256=tOUxtVmMBEdzZUP5YqfIIEWUiu1jtrOXpuSTFTHuOs0,1778
 polaris/api/_log_file.py,sha256=LYd__J8ooAdtONz7Ux7KmEridLpMyzKh0jk82BRsgpU,8729
 polaris/api/config.py,sha256=dFm7wKgbjpzZgLrF6yUQYPHW_kFJBmLXu-80mFF_RHw,6023
 polaris/api/consumer.py,sha256=etibb0SYWeqkVKGb_JDl4yCUxQ2r_AVU6YoB-Wj_S_s,10708
-polaris/api/log.py,sha256=3FvOC395PiIXbdxZfD5SlU9nMMpKktSn96OoDPk-T9s,17496
+polaris/api/log.py,sha256=TDTv08enECNWalRBRErix6KPvKSBcZ4Zhp2UH6__P9M,17535
 polaris/api/lossless.py,sha256=Bg6srjmKU7mUNxlQkE2Ctpu_GyQgNr0Ijd7d-DPAxA0,3393
 polaris/api/provider.py,sha256=wZ8yize1GTuaeXR1WB15-y7OuU-esgKvgw2cXblKekU,6936
 polaris/api/skill.py,sha256=j3lCuU0H9Hhyc6OvA0tU9fE_g4lGmhEna3qUATXmXR0,8352
@@ -62,7 +62,7 @@ polaris/plugin/server_connector/__init__.py,sha256=vxOLRFc-K6p6WjDZdtNAe95DRDXIg
 polaris/plugin/server_connector/base.py,sha256=CbCGkZQP3ZuCw2BFlzOhTgxLACFpl9u4BzzUqb8tn9c,3129
 polaris/plugin/server_connector/convert.py,sha256=xhYAqkl2DpLuAyWYFrS8v6tFjKf0ZE26UXH9d3ghJTA,7506
 polaris/plugin/server_connector/grpc_connector/__init__.py,sha256=grRkHuo-nrdQxpBZyDEsNs8bLOKR0XGQfYTe7_NrQFw,883
-polaris/plugin/server_connector/grpc_connector/connection.py,sha256=EJ-w_YQN3gpfhJ0_6rQqkfsd4_kZKAc80heQmhi5Jxo,18373
+polaris/plugin/server_connector/grpc_connector/connection.py,sha256=56sOGVKZZy3W1Cr59PJ4K97T2qne_y7ZI1u7PRKca1M,22488
 polaris/plugin/server_connector/grpc_connector/grpc_client.py,sha256=Q_qK2_5mDBXocqsa0MMpkpEZLtHAwUMD4lSnf3w8AG8,18425
 polaris/plugin/server_connector/grpc_connector/tls.py,sha256=iGLyeqAUOKZsltg4IJAxLnnQFDbCfXAwEWVGacK3NWg,1987
 polaris/plugin/service_router/__init__.py,sha256=MdDHSjiSE7gTKPRTNH5JCWI8o5t60oz4u1Zmaf1Re7E,993
@@ -77,8 +77,8 @@ polaris/plugin/skill/persistence.py,sha256=Lr6D6KbcxHBAkP-vTkMg2sfGMwLhqOxhLyVGL
 polaris/plugin/stat_reporter/__init__.py,sha256=dWFnNx7KLGCJoyIBjDDco8xvm_QgAr6RFnVd3IXj6oY,726
 polaris/plugin/stat_reporter/base.py,sha256=egAQK8ZBTXsFpnFK8fW9fgA_2xDq7BeeQah4aio9T0Y,1178
 polaris/plugin/stat_reporter/prometheus.py,sha256=so0H8CyaGsnJpPMsmW57ryqePyWIsLvQZJu-g2cl-c8,17311
-polaris_python-0.0.1.dev3.dist-info/licenses/LICENSE,sha256=YJW-rt35PlCxHBGzDNLAaMYMaUjgCrrH57V3MJTwpSI,1779
-polaris_python-0.0.1.dev3.dist-info/METADATA,sha256=6qohm4-Fxqc4fKYbBD6vShc_rcwWVSm9pVMRuWPDR0M,6938
-polaris_python-0.0.1.dev3.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
-polaris_python-0.0.1.dev3.dist-info/top_level.txt,sha256=w-dcIlTf_g1vjlHs3857yHM0OcmFnk4xJ2LgBYbPI6w,8
-polaris_python-0.0.1.dev3.dist-info/RECORD,,
+polaris_python-0.0.1.dev4.dist-info/licenses/LICENSE,sha256=YJW-rt35PlCxHBGzDNLAaMYMaUjgCrrH57V3MJTwpSI,1779
+polaris_python-0.0.1.dev4.dist-info/METADATA,sha256=GAP1ScgF4hBW6XAGvaICkEv14pO1OTpL8k7dBf0ztQc,7710
+polaris_python-0.0.1.dev4.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+polaris_python-0.0.1.dev4.dist-info/top_level.txt,sha256=w-dcIlTf_g1vjlHs3857yHM0OcmFnk4xJ2LgBYbPI6w,8
+polaris_python-0.0.1.dev4.dist-info/RECORD,,