.\" -*- 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 "Munin::Master::Utils 3pm"
.TH Munin::Master::Utils 3pm 2024-02-28 "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
Munin::Master::Utils \- Exports a lot of utility functions.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Munin::Master::Utils;
.Ve
.SH SUBROUTINES
.IX Header "SUBROUTINES"
.IP \fBmunin_category_status\fR 4
.IX Item "munin_category_status"
Gets current status of a category.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the hash node whose children to check
 \- \f(CW$limits:\fR A ref to the root node of the limits tree
 \- \f(CW$category:\fR The category to review
 \- \f(CW$check_draw:\fR [optional] Ignore undrawn fields
.Sp
Returns:
 \- Success: The status of the field
 \- Failure: undef
.IP \fBmunin_readconfig_base\fR 4
.IX Item "munin_readconfig_base"
Read configuration file, include dir files, and initialize important
default values that are optional.
.Sp
Parameters:
 \- \f(CW$file:\fR munin.conf filename. If omitted, default filename is used.
.Sp
Returns:
 \- Success: The \f(CW$config\fR hash (also cached in module)
.IP \fBmunin_copy_node\fR 4
.IX Item "munin_copy_node"
Copy hash node.
.Sp
Parameters:
 \- \f(CW$from:\fR Hash node to copy
 \- \f(CW$to:\fR Where to copy it to
.Sp
Returns:
 \- Success: \f(CW$to\fR
 \- Failure: undef
.IP \fBmunin_copy_node_toloc\fR 4
.IX Item "munin_copy_node_toloc"
Copy hash node at.
.Sp
Parameters:
 \- \f(CW$from:\fR Hash node to copy
 \- \f(CW$to:\fR Where to copy it to
 \- \f(CW$loc:\fR Path to node under \f(CW$to\fR
.Sp
Returns:
 \- Success: \f(CW$to\fR
 \- Failure: undef
.IP \fBmunin_createlock\fR 4
.IX Item "munin_createlock"
.PD 0
.IP \fBmunin_delete\fR 4
.IX Item "munin_delete"
.IP \fBmunin_draw_field\fR 4
.IX Item "munin_draw_field"
.PD
Check whether a field will be visible in the graph or not.
.Sp
Parameters:
 \- \f(CW$hash:\fR A ref to the hash node for the field
.Sp
Returns:
 \- Success: Boolean; true if field will be graphed, false if not
 \- Failure: undef
.IP \fBmunin_field_status\fR 4
.IX Item "munin_field_status"
Gets current status of a field.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the field hash node
 \- \f(CW$limits:\fR A ref to the root node of the limits tree
 \- \f(CW$check_draw:\fR [optional] Ignore undrawn fields
.Sp
Returns:
 \- Success: The status of the field
 \- Failure: undef
.IP \fBmunin_find_field\fR 4
.IX Item "munin_find_field"
Search a hash to find hash nodes with \f(CW$field\fR defined.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A hash ref to search
 \- \f(CW$field:\fR The name of the field to search for, or a regex
 \- \f(CW$avoid:\fR [optional] Stop traversing further down if this field is found
.Sp
Returns:
 \- Success: A ref to an array of the hash nodes containing \f(CW$field\fR.
 \- Failure: undef
.IP \fBmunin_get\fR 4
.IX Item "munin_get"
Get variable.
.Sp
Parameters:
 \- \f(CW$hash:\fR Ref to hash node
 \- \f(CW$field:\fR Name of field to get
 \- \f(CW$default:\fR [optional] Value to return if \f(CW$field\fR isn't set
.Sp
Returns:
 \- Success: field contents
 \- Failure: \f(CW$default\fR if defined, else undef
.IP \fBmunin_get_bool\fR 4
.IX Item "munin_get_bool"
Get boolean variable.
.Sp
Parameters:
 \- \f(CW$hash:\fR Ref to hash node
 \- \f(CW$field:\fR Name of field to get
 \- \f(CW$default:\fR [optional] Value to return if \f(CW$field\fR isn't set
.Sp
Returns:
 \- Success: 1 or 0 (true or false)
 \- Failure: \f(CW$default\fR if defined, else undef
.IP \fBmunin_get_bool_val\fR 4
.IX Item "munin_get_bool_val"
.PD 0
.IP \fBmunin_get_children\fR 4
.IX Item "munin_get_children"
.PD
Get all child hash nodes.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A hash ref to the parent node
.Sp
Returns:
 \- Success: A ref to an array of the child nodes
 \- Failure: undef
.IP \fBmunin_get_field_order\fR 4
.IX Item "munin_get_field_order"
Get the field order in a graph.
.Sp
Parameters:
 \- \f(CW$hash:\fR A hash ref to the service
.Sp
Returns:
 \- Success: A ref to an array of the field names
 \- Failure: undef
.IP \fBmunin_get_filename\fR 4
.IX Item "munin_get_filename"
Get rrd filename for a field, without any bells or whistles. Used by
munin-update to figure out which file to update.
.Sp
Parameters:
 \- \f(CW$hash:\fR Ref to hash field
.Sp
Returns:
 \- Success: Full path to rrd file
 \- Failure: undef
.IP \fBmunin_get_html_filename\fR 4
.IX Item "munin_get_html_filename"
Get the full path-name of an html file.
.Sp
Parameters:
 \- \f(CW$hash:\fR A ref to the service hash node
.Sp
Returns:
 \- Success: The file name with full path
 \- Failure: undef
.IP \fBmunin_get_max_label_length\fR 4
.IX Item "munin_get_max_label_length"
Get the length of the longest label in a graph.
.Sp
Parameters:
 \- \f(CW$hash:\fR the graph in question
 \- \f(CW$order:\fR A ref to an array of fields (graph_order)
.Sp
Returns:
 \- Success: The length of the longest label in the graph
 \- Failure: undef
.IP \fBmunin_get_node\fR 4
.IX Item "munin_get_node"
Gets a node by loc.
.Sp
Parameters:
 \- \f(CW$hash:\fR A ref to the hash to set the variable in
 \- \f(CW$loc:\fR A ref to an array with the full path of the node
.Sp
Returns:
 \- Success: The node ref found by \f(CW$loc\fR
 \- Failure: undef
.IP \fBmunin_get_node_loc\fR 4
.IX Item "munin_get_node_loc"
Get location array for hash node.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the node
.Sp
Returns:
 \- Success: Ref to an array with the full path of the variable
 \- Failure: undef
.IP \fBmunin_get_node_name\fR 4
.IX Item "munin_get_node_name"
Return the name of the hash node supplied.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the hash node
.Sp
Returns:
 \- Success: The name of the node
.IP \fBmunin_get_node_partialpath\fR 4
.IX Item "munin_get_node_partialpath"
Gets a node from a partial path.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the "current" location in the hash tree
 \- \f(CW$var:\fR A path string with relative location (from the \f(CW$hash\fR).
.Sp
Returns:
 \- Success: The node
 \- Failure: undef
.IP \fBmunin_get_parent\fR 4
.IX Item "munin_get_parent"
Get parent node of a hash.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the node
.Sp
Returns:
 \- Success: Ref to an parent
 \- Failure: undef
.IP \fBmunin_get_parent_name\fR 4
.IX Item "munin_get_parent_name"
Return the name of the parent of the hash node supplied
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the hash node
.Sp
Returns:
 \- Success: The name of the parent node
 \- Failure: If no parent node exists, "none" is returned.
.IP \fBmunin_get_picture_filename\fR 4
.IX Item "munin_get_picture_filename"
Get the full path+name of a picture file.
.Sp
Parameters:
 \- \f(CW$hash:\fR A ref to the service hash node
 \- \f(CW$scale:\fR [optional] The scale (day, week, year, month)
 \- \f(CW$sum:\fR [optional] Boolean value, whether it's a sum graph or not.
.Sp
Returns:
 \- Success: The file name with full path
 \- Failure: undef
.IP \fBmunin_get_picture_loc\fR 4
.IX Item "munin_get_picture_loc"
Get location array for hash node for picture purposes. Differs from
munin_get_node_loc in that it honors #%#origin metadata
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the node
.Sp
Returns: 
 \- Success: Ref to an array with the full path of the variable
 \- Failure: undef
.IP \fBmunin_get_root_node\fR 4
.IX Item "munin_get_root_node"
Get the root node of the hash tree.
.Sp
Parameters:
 \- \f(CW$hash:\fR A hash node to traverse up from
.Sp
Returns:
 \- Success: A ref to the root hash node
 \- Failure: undef
.IP \fBmunin_get_rrd_filename\fR 4
.IX Item "munin_get_rrd_filename"
Get the name of the rrd file corresponding to a field. Checks for lots
of bells and whistles.  This function is the correct one to use when
figuring out where to fetch data from.
.Sp
Parameters:
 \- \f(CW$field:\fR The hash object of the field
 \- \f(CW$path:\fR [optional] The path to the field (as given in graph_order/sum/stack/et al)
.Sp
Returns:
 \- Success: A string with the filename of the rrd file
 \- Failure: undef
.IP \fBmunin_get_separated_node\fR 4
.IX Item "munin_get_separated_node"
Copy a node to a separate node without "specials".
.Sp
Parameters:
 \- \f(CW$hash:\fR The node to copy
.Sp
Returns:
 \- Success: A ref to a new node without "#%#"\-fields
 \- Failure: undef
.IP \fBmunin_get_var_path\fR 4
.IX Item "munin_get_var_path"
.PD 0
.IP \fBmunin_getlock\fR 4
.IX Item "munin_getlock"
.IP \fBmunin_graph_column_headers\fR 4
.IX Item "munin_graph_column_headers"
.IP \fBmunin_has_subservices\fR 4
.IX Item "munin_has_subservices"
.PD
.Vb 1
\&  munin_has_subservices($hash);
.Ve
.Sp
Checks whether the service represented by \f(CW$hash\fR has subservices (multigraph),
and returns the result.
.Sp
Parameters:
 \- \f(CW$hash:\fR Hash reference pointing to a service
.Sp
Returns:
 \- true: if the hash is indeed a service, and said service has got subservices
 \- false: otherwise
.IP \fBmunin_mkdir_p\fR 4
.IX Item "munin_mkdir_p"
.Vb 1
\& munin_mkdir_p(\*(Aq/a/path/\*(Aq, oct(\*(Aq777\*(Aq));
.Ve
.Sp
Make a directory and recursively any nonexistent directory in the path
to it.
.IP \fBmunin_node_status\fR 4
.IX Item "munin_node_status"
.PD 0
.IP \fBmunin_nscasend\fR 4
.IX Item "munin_nscasend"
.IP \fBmunin_overwrite\fR 4
.IX Item "munin_overwrite"
.PD
Take contents of one config-namespace and replace/insert the instances
needed.
.IP \fBmunin_parse_config\fR 4
.IX Item "munin_parse_config"
.PD 0
.IP \fBmunin_path_to_loc\fR 4
.IX Item "munin_path_to_loc"
.PD
Returns a loc array from a path string.
.Sp
Parameters: 
 \- \f(CW$path:\fR A path string
.Sp
Returns:
 \- Success: A ref to an array with the loc
 \- Failure: undef
.IP \fBmunin_readconfig_part\fR 4
.IX Item "munin_readconfig_part"
Read a partial configuration
.Sp
Parameters:
 \- \f(CW$what:\fR name of the part that should be loaded (datafile or limits)
.Sp
Returns:
 \- Success: a \f(CW$config\fR with the \f(CW$specified\fR part, but overwritten by \f(CW$config\fR
.IP \fBmunin_removelock\fR 4
.IX Item "munin_removelock"
.PD 0
.IP \fBmunin_runlock\fR 4
.IX Item "munin_runlock"
.IP \fBmunin_service_status\fR 4
.IX Item "munin_service_status"
.PD
Gets current status of a service.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the field hash node
 \- \f(CW$limits:\fR A ref to the root node of the limits tree
 \- \f(CW$check_draw:\fR [optional] Ignore undrawn fields
.Sp
Returns:
 \- Success: The status of the field
 \- Failure: undef
.IP \fBmunin_set\fR 4
.IX Item "munin_set"
Sets a variable in a hash.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the hash to set the variable in
 \- \f(CW$var:\fR The name of the variable
 \- \f(CW$val:\fR The value to set the variable to
.Sp
Returns:
 \- Success: The \f(CW$hash\fR we were handed
 \- Failure: undef
.IP \fBmunin_set_var_loc\fR 4
.IX Item "munin_set_var_loc"
Sets a variable in a hash.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the hash to set the variable in
 \- \f(CW$loc:\fR A ref to an array with the full path of the variable
 \- \f(CW$val:\fR The value to set the variable to
.Sp
Returns:
 \- Success: The \f(CW$hash\fR we were handed
 \- Failure: undef
.IP \fBmunin_set_var_path\fR 4
.IX Item "munin_set_var_path"
Sets a variable in a hash.
.Sp
Parameters: 
 \- \f(CW$hash:\fR A ref to the hash to set the variable in
 \- \f(CW$var:\fR A string with the full path of the variable
 \- \f(CW$val:\fR The value to set the variable to
.Sp
Returns:
 \- Success: The \f(CW$hash\fR we were handed
 \- Failure: The \f(CW$hash\fR we were handed
.IP \fBmunin_writeconfig\fR 4
.IX Item "munin_writeconfig"
.PD 0
.IP \fBmunin_writeconfig_loop\fR 4
.IX Item "munin_writeconfig_loop"
.PD
.SH COPYING
.IX Header "COPYING"
Copyright (C) 2003\-2007 Jimmy Olsen, Audun Ytterdal
.PP
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; version 2 dated June,
1991.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA.