.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Metrics::Any::Adapter::Test 3pm"
.TH Metrics::Any::Adapter::Test 3pm "2022-12-30" "perl v5.36.0" "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"
"Metrics::Any::Adapter::Test" \- a metrics reporting adapter for unit testing
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&   use Test::More;
\&   use Metrics::Any::Adapter \*(AqTest\*(Aq;
\&
\&   {
\&      Metrics::Any::Adapter::Test\->clear;
\&
\&      # perform some work in the code under test
\&
\&      is( Metrics::Any::Adapter::Test\->metrics,
\&         "an_expected_metric = 1\en",
\&         \*(AqMetrics were reported while doing something\*(Aq
\&      );
\&   }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This Metrics::Any adapter type stores reported metrics locally, allowing
access to them by the \*(L"metrics\*(R" method. This is useful to use in a unit test
to check that the code under test reports the correct metrics.
.PP
This adapter supports timer metrics by storing as distributions. By default,
distributions store only a summary, giving the count and total duration. If
required, the full values can be stored by setting \*(L"use_full_distributions\*(R".
.PP
For predictable output of timer metrics in unit tests, a unit test may wish to
use the \*(L"override_timer_duration\*(R" method.
.PP
This adapter type supports batch mode reporting. Callbacks are invoked at the
beginning of the \*(L"metrics\*(R" method.
.SH "METHODS"
.IX Header "METHODS"
.SS "metrics"
.IX Subsection "metrics"
.Vb 1
\&   $result = Metrics::Any::Adapter::Test\->metrics
.Ve
.PP
This class method returns a string describing all of the stored metric values.
Each is reported on a line formatted as
.PP
.Vb 1
\&   name = value
.Ve
.PP
Each line, including the final one, is terminated by a linefeed. The metrics
are sorted alphabetically. Any multi-part metric names will be joined with
underscores (\f(CW\*(C`_\*(C'\fR).
.PP
Metrics that have additional labels are formatted with additional label names
and label values in declared order after the name and before the \f(CW\*(C`=\*(C'\fR symbol:
.PP
.Vb 1
\&   name l1:v1 l2:v2 = value
.Ve
.SS "use_full_distributions"
.IX Subsection "use_full_distributions"
.Vb 1
\&   Metrics::Any::Adapter::Test\->use_full_distributions;  # enables the option
\&
\&   Metrics::Any::Adapter::Test\->use_full_distributions( $enable );
.Ve
.PP
\&\fISince version 0.08.\fR
.PP
If enabled, this option stores the full value of every reported observation
into distributions, rathr than just the count-and-total summary.
.PP
Full value distributions will be formatted as a sequence of lines containing
the count of observations at that particular value, in square brackets,
followed by the summary count.
.PP
.Vb 4
\&   name[v1] = c1
\&   name[v2] = c2
\&   ...
\&   name_count = c
.Ve
.PP
In order not to be too sensitive to numerical rounding errors, values are
stored to only 3 decimal places.
.SS "clear"
.IX Subsection "clear"
.Vb 1
\&   Metrics::Any::Adapter::Test\->clear
.Ve
.PP
This class method removes all of the stored values of reported metrics.
.SS "override_timer_duration"
.IX Subsection "override_timer_duration"
.Vb 1
\&   Metrics::Any::Adapter::Test\->override_timer_duration( $duration )
.Ve
.PP
This class method sets a duration value, that any subsequent call to
\&\f(CW\*(C`inc_timer\*(C'\fR will use instead of the value the caller actually passed in. This
will ensure reliably predictable output in unit tests.
.PP
Any value set here will be cleared by \*(L"clear\*(R".
.SH "AUTHOR"
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>