root/docs/executable/stratcond.xml

Revision 412c3dbfb208525e7fa8d2885a956e8295721507, 5.6 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 4 years ago)

Actual native docbook.

  • Property mode set to 100644
Line 
1 <?xml version="1.0" encoding="UTF-8"?>
2 <?xml-model href="http://docbook.org/xml/5.0/rng/docbookxi.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
3 <?xml-model href="http://docbook.org/xml/5.0/rng/docbook.rng" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>
4 <refentry xmlns="http://docbook.org/ns/docbook"
5           xmlns:xi="http://www.w3.org/2001/XInclude"
6           xmlns:xlink="http://www.w3.org/1999/xlink"
7           version="5.0"
8           xml:id="executable.stratcond">
9   <refmeta>
10     <refentrytitle>stratcond</refentrytitle>
11     <manvolnum>8</manvolnum>
12   </refmeta>
13
14   <refnamediv>
15     <refname>stratcond</refname>
16     <refpurpose>Reconnoiter data collector/aggregator.</refpurpose>
17   </refnamediv>
18
19   <refsynopsisdiv>
20     <cmdsynopsis>
21       <command>stratcond</command>
22       <arg choice="opt">-c</arg>
23       <arg choice="opt">-M</arg>
24       <arg choice="opt">-u <replaceable>user</replaceable></arg>
25       <arg choice="opt">-g <replaceable>group</replaceable></arg>
26       <arg choice="opt">-t <replaceable>path</replaceable></arg>
27       <arg choice="opt">-n <replaceable>address:port</replaceable></arg>
28       <arg choice="opt">-d</arg>
29       <arg choice="opt">-D</arg>
30       <arg choice="opt">-l <replaceable>logstream</replaceable></arg>
31       <arg choice="opt">-L <replaceable>logstream</replaceable></arg>
32       <arg choice="opt">-s</arg>
33       <arg choice="opt">-r</arg>
34       <arg choice="opt">-h</arg>
35     </cmdsynopsis>
36   </refsynopsisdiv>
37
38   <refsect1>
39     <title>Description</title>
40 <para>
41   <command>stratcond</command> is the daemon that coordinates all
42   <command>noitd</command> daemons, processes their data feeds
43   (configuration updates, metrics, checks and statuses) and provides
44   that data to the backend business logic: storage services and
45   fault detection services.
46 </para>
47
48 <variablelist>
49   <varlistentry><term><option>-u</option></term>
50     <listitem>
51       <para>
52         Optionally specifies a username or uid under which to operate.
53       </para>
54     </listitem>
55   </varlistentry>
56   <varlistentry><term><option>-g</option></term>
57     <listitem>
58       <para>
59         Optionally specifies a group name or gid under which to operate.
60       </para>
61     </listitem>
62   </varlistentry> 
63   <varlistentry><term><option>-t</option></term>
64     <listitem>
65       <para>
66         Optionally specifies a path to chroot(2) for operation.  Measures
67         must be taken to ensure that log files can be accessed in the
68         chrooted environment.
69       </para>
70     </listitem>
71   </varlistentry>
72   <varlistentry><term><option>-n</option></term>
73     <listitem>
74       <para>
75         Optionally specifies an address to *not* listen on. It can be
76         a unix path (:port omitted), just a port (:port), or a complete
77         address (IP:port).  The parameter can be specified multiple times.
78         It will cause any listener configured on such an address to be
79         skipped during boot.
80       </para>
81     </listitem>
82   </varlistentry>
83   <varlistentry><term><option>-c</option></term>
84     <listitem>
85       <para>
86         Specifies a configuration file to read.  The default location of the
87         configuration file is <filename>stratcond.conf</filename> in the
88         sysconfdir specified at build time.
89       </para>
90     </listitem>
91   </varlistentry>
92   <varlistentry><term><option>-l</option></term>
93     <listitem>
94       <para>
95         Marks the enabled bit for the specified log stream.  This enables
96         the stream even if it is disabled in the configuration file.  It
97         must exist in the configuration file.
98       </para>
99     </listitem>
100   </varlistentry>
101   <varlistentry><term><option>-L</option></term>
102     <listitem>
103       <para>
104         Disables the enabled bit for the specified log stream.  This disables
105         the stream even if it is enabled in the configuration file.  It
106         must exist in the configuration file.
107       </para>
108     </listitem>
109   </varlistentry>
110   <varlistentry><term><option>-D</option></term>
111     <listitem>
112       <para>
113         Instructs <command>stratcond</command> to run in the foreground.
114         The process remains attached to the terminal.  This is primarily
115         for debugging purposes.
116       </para>
117       <para>
118         If this flag is specified more than once, <command>stratcond</command>
119         stay in the foreground, but the foreground process will actually
120         be the monitor process and the child will be forked off and
121         respawned on unexpected failures.
122       </para>
123     </listitem>
124   </varlistentry>
125   <varlistentry><term><option>-d</option></term>
126     <listitem>
127       <para>
128         Enables the debug output facility despite configuration to the
129         contrary.
130       </para>
131     </listitem>
132   </varlistentry>
133   <varlistentry><term><option>-M</option></term>
134     <listitem>
135       <para>
136         Instructs <command>noitd</command> to exit immediately if there
137         where any problems loading specified modules.
138       </para>
139     </listitem>
140   </varlistentry>
141   <varlistentry><term><option>-s</option></term>
142     <listitem>
143       <para>
144         Disables pulling for durable logs from noits and subsequent
145         loading of data into the database.
146       </para>
147     </listitem>
148   </varlistentry>
149   <varlistentry><term><option>-r</option></term>
150     <listitem>
151       <para>
152         Disables pulling for transient logs from noits and subsequent
153         submission to the message queue.
154       </para>
155     </listitem>
156   </varlistentry>
157   <varlistentry><term><option>-h</option></term>
158     <listitem>
159       <para>
160         Displays the usage information.
161       </para>
162     </listitem>
163   </varlistentry>
164 </variablelist>
165 </refsect1>
166 </refentry>
167
168 <!--
169 vim:ts=2:sw=2:et:
170 -->
171
Note: See TracBrowser for help on using the browser.