.\" -*- 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::Summary 3pm"
.TH Net::Prometheus::Summary 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::Summary" \- summarise individual numeric observations
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&   use Net::Prometheus;
\&   use Time::HiRes qw( time );
\&
\&   my $client = Net::Prometheus\->new;
\&
\&   my $summary = $client\->new_summary(
\&      name => "request_seconds",
\&      help => "Summary request processing time",
\&   );
\&
\&   sub handle_request
\&   {
\&      my $start = time();
\&
\&      ...
\&
\&      $summary\->observe( time() \- $start );
\&   }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class provides a summary metric \- a combination of a running total and a
counter, that can be used to report on total and average values of
observations, usually times. It is a subclass of Net::Prometheus::Metric.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
Instances of this class are not usually constructed directly, but instead via
the Net::Prometheus object that will serve it:
.PP
.Vb 1
\&   $summary = $prometheus\->new_summary( %args )
.Ve
.PP
This takes the same constructor arguments as documented in
Net::Prometheus::Metric.
.SS observe
.IX Subsection "observe"
.Vb 2
\&   $summary\->observe( @label_values, $value )
\&   $summary\->observe( \e%labels, $value )
\&
\&   $child\->observe( $value )
.Ve
.PP
Increment the summary sum by the given value, and the count by 1.
.SH AUTHOR
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>