.\" -*- 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::Node::Service 3pm"
.TH Munin::Node::Service 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::Node::Service \- Methods related to handling of Munin services
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\& my $services = Munin::Node::Service\->new(timeout => 30);
\& $services\->prepare_plugin_environment;
\& if ($services\->is_a_runnable_service($file_name)) {
\&    $services\->fork_service($file_name);
\& }
.Ve
.SH METHODS
.IX Header "METHODS"
.IP \fBnew\fR 4
.IX Item "new"
.Vb 1
\& my $services = Munin::Node::Service\->new(%args);
.Ve
.Sp
Constructor.  All arguments are optional.  Valid arguments are:
.RS 4
.ie n .IP """servicedir""" 8
.el .IP \f(CWservicedir\fR 8
.IX Item "servicedir"
The directory that will be searched for services.
.ie n .IP """defuser"", ""defgroup""" 8
.el .IP "\f(CWdefuser\fR, \f(CWdefgroup\fR" 8
.IX Item "defuser, defgroup"
The default uid and gid that services will run as.  Service-specific user and
group directives (as set by the service configuration files) will override
this.
.ie n .IP """timeout""" 8
.el .IP \f(CWtimeout\fR 8
.IX Item "timeout"
The default timeout for services.  Services taking longer than this to run will
be killed.  Service-specific timeouts will (as set in the service configuration
files) will override this value.
.RE
.RS 4
.RE
.IP \fBis_a_runnable_service\fR 4
.IX Item "is_a_runnable_service"
.Vb 1
\& my $bool = $services\->is_a_runnable_service($file_name);
.Ve
.Sp
Runs miscellaneous tests on \f(CW$file_name\fR in the service directory, to try and
establish whether it is a runnable service.
.IP \fBlist\fR 4
.IX Item "list"
.Vb 1
\&  my @services = $services\->list;
.Ve
.Sp
Returns a list of all the runnable services in the directory.
.IP \fBprepare_plugin_environment\fR 4
.IX Item "prepare_plugin_environment"
.Vb 1
\& $services\->prepare_plugin_environment(@services);
.Ve
.Sp
Carries out various tasks that plugins require before being run, such as
loading service configurations and exporting common environment variables.
.IP \fBexport_service_environment\fR 4
.IX Item "export_service_environment"
.Vb 1
\& $services\->export_service_enviromnent($service);
.Ve
.Sp
Exports all the environment variables specific to service \f(CW$service\fR.
.IP \fBchange_real_and_effective_user_and_group\fR 4
.IX Item "change_real_and_effective_user_and_group"
.Vb 1
\& $service\->change_real_and_effective_user_and_group($service);
.Ve
.Sp
Changes the current process' effective group and user IDs to those specified in
the configuration, or the default user or group otherwise.  Also changes the
real group and user IDs if the operating system supports it.
.Sp
On failure, causes the process to exit.
.IP \fBexec_service\fR 4
.IX Item "exec_service"
.Vb 1
\& $service\->exec_service($service, [@arguments]);
.Ve
.Sp
Replaces the current process with an instance of service \f(CW$service\fR in
\&\f(CW$directory\fR, running with the correct environment and privileges.
.Sp
This function never returns.  The process will \fBexit\fR\|(2) if the service to be run
failed the paranoia check.
.IP \fBfork_service\fR 4
.IX Item "fork_service"
.Vb 1
\& $result = $service\->fork_service($service, [$argument]);
.Ve
.Sp
Identical to \fBexec_service()\fR, except it runs the service in a subprocess.  If
the service takes longer than the timeout, it will be terminated.
.Sp
Returns a hash reference containing (among other things) the service's output
and exit value.  (See documentation for \fBrun_as_child()\fR in
Munin::Node::Service for a comprehensive description.)