class documentation
class MetricGauge(MetricCommon): (source)
Known subclasses: temporalio.common._NoopMetricGauge, temporalio.runtime._MetricGauge, temporalio.worker._workflow_instance._ReplaySafeMetricGauge
Gauge metric created by a metric meter.
| Method | set |
Set a value on the gauge. |
Inherited from MetricCommon:
| Method | with |
Create a new metric with the given attributes appended to the current set. |
| Property | description |
Description for the metric if any. |
| Property | name |
Name for the metric. |
| Property | unit |
Unit for the metric if any. |
@abstractmethod
def set(self, value:
def set(self, value:
int, additional_attributes: Optional[ = None):
(source)
¶
overridden in
temporalio.common._NoopMetricGauge, temporalio.runtime._MetricGauge, temporalio.worker._workflow_instance._ReplaySafeMetricGaugeSet a value on the gauge.
| Parameters | |
value:int | A non-negative integer to set. |
additionalOptional[ | Additional attributes to append to the current set. |
| Raises | |
ValueError | Value is negative. |
TypeError | Attribute values are not the expected type. |