Net::Prometheus::Types - a collection of support structure types
Net::Prometheus::Types
use Net::Prometheus::Types qw( Sample ); my $ob = Sample( variable => [], 123 ); print "The sample relates to a variable called ", $ob->varname;
This package contains some simple support structures that assist with other parts of the Net::Prometheus distribution.
Each type is exported as a constructor function.
This structure represents an individual value sample; associating a numerical value with a named variable and set of label values.
$sample = Sample( $varname, $labels, $value )
$varname = $sample->varname
The string variable name. This is the basic name, undecorated by label values.
$labels = $sample->labels
A reference to an even-sized ARRAY containing name/value pairs for the labels. Label values should be raw unescaped strings.
$sample->value
The numerical value observed.
This structure represents all the samples made about a given metric, including metadata about the metric itself.
$samples = MetricSamples( $fullname, $type, $help, $samples )
A string giving the fullname of the metric.
A string, one of 'gauge', 'counter', 'summary' or 'histogram'.
'gauge'
'counter'
'summary'
'histogram'
A string containing the descriptive help message text.
A reference to an ARRAY containing individual "Sample" instances.
Paul Evans <leonerd@leonerd.org.uk>
To install Net::Prometheus, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Prometheus
CPAN shell
perl -MCPAN -e shell install Net::Prometheus
For more information on module installation, please visit the detailed CPAN module installation guide.