@@ -183,18 +183,18 @@ class MetricBuffer:
183
183
metrics instead of ignoring/exporting them.
184
184
185
185
.. 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 .
190
190
"""
191
191
192
192
def __init__ (self , buffer_size : int ) -> None :
193
193
"""Create a buffer with the given size.
194
194
195
195
.. 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.
198
198
199
199
Args:
200
200
buffer_size: Size of the buffer. Set this to a large value. A value
@@ -207,7 +207,7 @@ def retrieve_updates(self) -> Sequence[BufferedMetricUpdate]:
207
207
"""Drain the buffer and return all metric updates.
208
208
209
209
.. warning::
210
- It is very important that this is called regularly. See
210
+ It is important that this is called regularly. See
211
211
:py:class:`MetricBuffer` warning.
212
212
213
213
Returns:
0 commit comments