Skip to content

Commit 2f751de

Browse files
committed
Update core and alter docs for log+drop behavior
1 parent dd301cd commit 2f751de

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

temporalio/runtime.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -183,18 +183,18 @@ class MetricBuffer:
183183
metrics instead of ignoring/exporting them.
184184
185185
.. warning::
186-
It is very important that the buffer size is set to a high number and
187-
that :py:meth:`retrieve_updates` is called regularly. Metric updates
188-
will not be lost, so they can cause the system to halt if there is not
189-
enough room in the buffer.
186+
It is important that the buffer size is set to a high number and that
187+
:py:meth:`retrieve_updates` is called regularly to drain the buffer. If
188+
the buffer is full, metric updates will be dropped and an error will be
189+
logged.
190190
"""
191191

192192
def __init__(self, buffer_size: int) -> None:
193193
"""Create a buffer with the given size.
194194
195195
.. warning::
196-
It is very important that the buffer size is set to a high number
197-
and is drained regularly. See :py:class:`MetricBuffer` warning.
196+
It is important that the buffer size is set to a high number and is
197+
drained regularly. See :py:class:`MetricBuffer` warning.
198198
199199
Args:
200200
buffer_size: Size of the buffer. Set this to a large value. A value
@@ -207,7 +207,7 @@ def retrieve_updates(self) -> Sequence[BufferedMetricUpdate]:
207207
"""Drain the buffer and return all metric updates.
208208
209209
.. warning::
210-
It is very important that this is called regularly. See
210+
It is important that this is called regularly. See
211211
:py:class:`MetricBuffer` warning.
212212
213213
Returns:

0 commit comments

Comments
 (0)