ray.util.metrics.Counter
ray.util.metrics.Counter#
- class ray.util.metrics.Counter(name: str, description: str = '', tag_keys: Optional[Tuple[str, ...]] = None)[source]#
Bases:
ray.util.metrics.Metric
A cumulative metric that is monotonically increasing.
This corresponds to Prometheus’ counter metric: https://prometheus.io/docs/concepts/metric_types/#counter
- Parameters
name – Name of the metric.
description – Description of the metric.
tag_keys – Tag keys of the metric.
DeveloperAPI: This API may change across minor Ray releases.
Methods
Increment the counter by
value
(defaults to 1).Record the metric point of the metric.
Set default tags of metrics.
Attributes
Return the information of this metric.