A Collector
to bundle metrics of the same name that
differ in their label values. It is usually not used directly but as a
building block for implementations of vectors of a given metric
type. GaugeVec
and CounterVec
are examples already
provided in this package.
create
creates a MetricVec with description desc
, a metric type metric_type
and
a MetricVecBuilder new_metric
.
get_metric_with_label_values
returns the Metric
for the given slice
of label values (same order as the VariableLabels in Desc). If that combination of
label values is accessed for the first time, a new Metric
is created.
It is possible to call this method without using the returned Metric
to only create the new Metric
but leave it at its start value (e.g. a
Histogram
without any observations).
Keeping the Metric
for later use is possible (and should be considered
if performance is critical), but keep in mind that Reset, DeleteLabelValues and Delete can
be used to delete the Metric
from the MetricVec. In thatcase, the
Metric
will still exist, but it will not be exported anymore, even if a
Metric
with the same label values is created later. See also the
CounterVec example.
An error is returned if the number of label values is not the same as the
number of VariableLabels in Desc.
Note that for more than one label value, this method is prone to mistakes
caused by an incorrect order of arguments. Consider get_metric_with(labels) as
an alternative to avoid that type of mistake. For higher label numbers, the
latter has a much more readable (albeit more verbose) syntax, but it comes
with a performance overhead (for creating and processing the Labels map).
get_metric_with
returns the Metric
for the given Labels map (the
label names must match those of the VariableLabels in Desc). If that label map is
accessed for the first time, a new Metric
is created. Implications of
creating a Metric
without using it and keeping the
Metric
for later use are the same as for GetMetricWithLabelValues.
An error is returned if the number and names of the Labels are inconsistent
with those of the VariableLabels in Desc.
This method is used for the same purpose as
get_metric_with_label_values
. See there for pros and cons of the two
methods.
with_label_values
works as get_metric_with_label_values
, but panics if an error
occurs. The method allows neat syntax like:
httpReqs.with_label_values("404", "POST").inc()
with
works as get_metric_with
, but panics if an error occurs. The method allows
neat syntax like:
httpReqs.with(Labels{"status":"404", "method":"POST"}).inc()
remove_label_values
removes the metric where the variable labels are the same
as those passed in as labels (same order as the VariableLabels in Desc). It
returns true if a metric was deleted.
It returns an error if the number of label values is not the same as the
number of VariableLabels in Desc.
Note that for more than one label value, this method is prone to mistakes
caused by an incorrect order of arguments. Consider delete(labels) as an
alternative to avoid that type of mistake. For higher label numbers, the
latter has a much more readable (albeit more verbose) syntax, but it comes
with a performance overhead (for creating and processing the Labels map).
remove
removes the metric where the variable labels are the same as those
passed in as labels. It returns true if a metric was deleted.
It returns an error if the number and names of the Labels are inconsistent
with those of the VariableLabels in the Desc of the MetricVec.
This method is used for the same purpose as delete_label_values
. See
there for pros and cons of the two methods.
reset
deletes all metrics in this vector.
Return descriptors for metrics.
Performs copy-assignment from source
. Read more
Creates owned data from borrowed data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static