From 2f751de44badfb0cb8d543286345b51b2ec26d09 Mon Sep 17 00:00:00 2001 From: Chad Retz Date: Fri, 29 Sep 2023 07:22:22 -0500 Subject: [PATCH] Update core and alter docs for log+drop behavior --- temporalio/bridge/sdk-core | 2 +- temporalio/runtime.py | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/temporalio/bridge/sdk-core b/temporalio/bridge/sdk-core index e9a6f06f..617612aa 160000 --- a/temporalio/bridge/sdk-core +++ b/temporalio/bridge/sdk-core @@ -1 +1 @@ -Subproject commit e9a6f06f0e752ad73cbd9cd4eff8fe5fa5f35c88 +Subproject commit 617612aa419d687aebabcf0258ac86f5c36df189 diff --git a/temporalio/runtime.py b/temporalio/runtime.py index aba5ac79..eb494bcf 100644 --- a/temporalio/runtime.py +++ b/temporalio/runtime.py @@ -183,18 +183,18 @@ class MetricBuffer: metrics instead of ignoring/exporting them. .. warning:: - It is very important that the buffer size is set to a high number and - that :py:meth:`retrieve_updates` is called regularly. Metric updates - will not be lost, so they can cause the system to halt if there is not - enough room in the buffer. + It is important that the buffer size is set to a high number and that + :py:meth:`retrieve_updates` is called regularly to drain the buffer. If + the buffer is full, metric updates will be dropped and an error will be + logged. """ def __init__(self, buffer_size: int) -> None: """Create a buffer with the given size. .. warning:: - It is very important that the buffer size is set to a high number - and is drained regularly. See :py:class:`MetricBuffer` warning. + It is important that the buffer size is set to a high number and is + drained regularly. See :py:class:`MetricBuffer` warning. Args: buffer_size: Size of the buffer. Set this to a large value. A value @@ -207,7 +207,7 @@ def retrieve_updates(self) -> Sequence[BufferedMetricUpdate]: """Drain the buffer and return all metric updates. .. warning:: - It is very important that this is called regularly. See + It is important that this is called regularly. See :py:class:`MetricBuffer` warning. Returns: