.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Prometheus::Registry 3pm"
.TH Net::Prometheus::Registry 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
"Net::Prometheus::Registry" \- a collection of metrics collectors
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class, or instances of it, acts as a simple storage array for instances
derived from Net::Prometheus::Metric, known as "collectors".
.PP
A single global collection is stored by the module, accessible via the class
methods. Additional collections may be made with the constructor and then
accessed by instance methods.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.SS new
.IX Subsection "new"
.Vb 1
\&   $registry = Net::Prometheus::Registry\->new
.Ve
.PP
Returns a new registry instance.
.SH METHODS
.IX Header "METHODS"
.SS register
.IX Subsection "register"
.Vb 2
\&   $collector = Net::Prometheus::Registry\->register( $collector )
\&   $collector = $registry\->register( $collector )
.Ve
.PP
Adds a new collector to the registry. The collector instance itself is
returned, for convenience of chaining method calls on it.
.SS unregister
.IX Subsection "unregister"
.Vb 2
\&   Net::Prometheus::Registry\->unregister( $collector )
\&   $registry\->unregister( $collector )
.Ve
.PP
Removes a previously-registered collector.
.SS collectors
.IX Subsection "collectors"
.Vb 2
\&   @collectors = Net::Prometheus::Registry\->collectors
\&   @collectors = $registry\->collectors
.Ve
.PP
Returns a list of the currently-registered collectors.
.SH AUTHOR
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>