path: root/man/man8/puppet-instrumentation_listener.8

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "PUPPET\-INSTRUMENTATION_LISTENER" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-instrumentation_listener\fR \- Manage instrumentation listeners\.
.
.SH "SYNOPSIS"
puppet instrumentation_listener \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
.
.SH "DESCRIPTION"
This subcommand enables/disables or list instrumentation listeners\.
.
.SH "OPTIONS"
Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid configuration parameters, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
.TP
\-\-verbose
Whether to log verbosely\.
.
.TP
\-\-debug
Whether to log debug information\.
.
.TP
\-\-extra HASH
A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
.
.TP
\-\-terminus TERMINUS
Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
.
.IP
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\.
.
.IP
The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\.
.
.SH "ACTIONS"
.
.TP
\fBdestroy\fR \- Invalid for this subcommand\.
\fBSYNOPSIS\fR
.
.IP
puppet instrumentation_listener destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this subcommand\.
.
.TP
\fBdisable\fR \- Disable a given instrumentation listener\.
\fBSYNOPSIS\fR
.
.IP
puppet instrumentation_listener disable [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Disable a given instrumentation listener\. After being disabled the listener will stop receiving instrumentation notifications from the probes\.
.
.IP
\fBRETURNS\fR
.
.IP
Nothing\.
.
.TP
\fBenable\fR \- Enable a given instrumentation listener\.
\fBSYNOPSIS\fR
.
.IP
puppet instrumentation_listener enable [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Enable a given instrumentation listener\. After being enabled the listener will start receiving instrumentation notifications from the probes if those are enabled\.
.
.IP
\fBRETURNS\fR
.
.IP
Nothing\.
.
.TP
\fBfind\fR \- Retrieve a single listener\.
\fBSYNOPSIS\fR
.
.IP
puppet instrumentation_listener find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Retrieve a single listener\.
.
.IP
\fBRETURNS\fR
.
.IP
The status of an instrumentation listener
.
.TP
\fBinfo\fR \- Print the default terminus class for this face\.
\fBSYNOPSIS\fR
.
.IP
puppet instrumentation_listener info [\-\-terminus TERMINUS] [\-\-extra HASH]
.
.IP
\fBDESCRIPTION\fR
.
.IP
Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-run_mode\' option\.
.
.TP
\fBsave\fR \- API only: modify an instrumentation listener status\.
\fBSYNOPSIS\fR
.
.IP
puppet instrumentation_listener save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIlistener\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\.
.
.TP
\fBsearch\fR \- Retrieve all instrumentation listeners statuses\.
\fBSYNOPSIS\fR
.
.IP
puppet instrumentation_listener search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIdummy_text\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Retrieve all instrumentation listeners statuses\.
.
.IP
\fBRETURNS\fR
.
.IP
The statuses of all instrumentation listeners
.
.IP
\fBNOTES\fR
.
.IP
Although this action always returns all instrumentation listeners, it requires a dummy search key; this is a known bug\.
.
.SH "EXAMPLES"
\fBdisable\fR
.
.P
Disable the "performance" listener in the running master:
.
.P
$ puppet instrumentation_listener disable performance \-\-terminus rest
.
.P
\fBenable\fR
.
.P
Enable the "performance" listener in the running master:
.
.P
$ puppet instrumentation_listener enable performance \-\-terminus rest
.
.P
\fBfind\fR
.
.P
Retrieve a given listener:
.
.P
$ puppet instrumentation_listener find performance \-\-terminus rest
.
.P
\fBsearch\fR
.
.P
Retrieve the state of the listeners running in the remote puppet master:
.
.P
$ puppet instrumentation_listener search x \-\-terminus rest
.
.SH "NOTES"
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
.
.IP "\(bu" 4
\fBlocal\fR
.
.IP "\(bu" 4
\fBrest\fR
.
.IP "" 0
.
.SH "COPYRIGHT AND LICENSE"
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING