root/docs/executable/stratcond.xml

Revision 23dea7e00df87480acb58bb3398283c2bb227949, 4.6 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 3 years ago)

pull docs into master

  • Property mode set to 100644
Line 
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
2   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
3 [
4   <!ENTITY % magic.fixup SYSTEM "http://labs.omniti.com/docbook/ent">
5   %magic.fixup;
6 ]>
7
8 <refentry id="executable.stratcond">
9   <refmeta>
10     <refentrytitle>stratcond</refentrytitle>
11     <manvolnum>8</manvolnum>
12   </refmeta>
13
14   <refentryinfo>
15     <date>09/08/2008</date>
16   </refentryinfo>
17
18   <refnamediv>
19     <refname>stratcond</refname>
20     <refpurpose>Reconnoiter data collector/aggregator.</refpurpose>
21   </refnamediv>
22
23   <refsynopsisdiv>
24     <cmdsynopsis>
25       <command>stratcond</command>
26       <arg choice="opt">-c</arg>
27       <arg choice="opt">-M</arg>
28       <arg choice="opt">-u <replaceable>user</replaceable></arg>
29       <arg choice="opt">-g <replaceable>group</replaceable></arg>
30       <arg choice="opt">-t <replaceable>path</replaceable></arg>
31       <arg choice="opt">-d</arg>
32       <arg choice="opt">-D</arg>
33       <arg choice="opt">-l <replaceable>logstream</replaceable></arg>
34       <arg choice="opt">-L <replaceable>logstream</replaceable></arg>
35       <arg choice="opt">-s</arg>
36       <arg choice="opt">-r</arg>
37       <arg choice="opt">-h</arg>
38     </cmdsynopsis>
39   </refsynopsisdiv>
40
41   <refsect1>
42     <title>Description</title>
43 <para>
44   <command>stratcond</command> is the daemon that coordinates all
45   <command>noitd</command> daemons, processes their data feeds
46   (configuration updates, metrics, checks and statuses) and provides
47   that data to the backend business logic: storage services and
48   fault detection services.
49 </para>
50
51 <variablelist>
52   <varlistentry><term><option>-u</option></term>
53     <listitem>
54       <para>
55         Optionally specifies a username or uid under which to operate.
56       </para>
57     </listitem>
58   </varlistentry>
59   <varlistentry><term><option>-g</option></term>
60     <listitem>
61       <para>
62         Optionally specifies a group name or gid under which to operate.
63       </para>
64     </listitem>
65   </varlistentry> 
66   <varlistentry><term><option>-t</option></term>
67     <listitem>
68       <para>
69         Optionally specifies a path to chroot(2) for operation.  Measures
70         must be taken to ensure that log files can be accessed in the
71         chrooted environment.
72       </para>
73     </listitem>
74   </varlistentry>
75   <varlistentry><term><option>-c</option></term>
76     <listitem>
77       <para>
78         Specifies a configuration file to read.  The default location of the
79         configuration file is <filename>stratcond.conf</filename> in the
80         sysconfdir specified at build time.
81       </para>
82     </listitem>
83   </varlistentry>
84   <varlistentry><term><option>-l</option></term>
85     <listitem>
86       <para>
87         Marks the enabled bit for the specified log stream.  This enables
88         the stream even if it is disabled in the configuration file.  It
89         must exist in the configuration file.
90       </para>
91     </listitem>
92   </varlistentry>
93   <varlistentry><term><option>-L</option></term>
94     <listitem>
95       <para>
96         Disables the enabled bit for the specified log stream.  This disables
97         the stream even if it is enabled in the configuration file.  It
98         must exist in the configuration file.
99       </para>
100     </listitem>
101   </varlistentry>
102   <varlistentry><term><option>-D</option></term>
103     <listitem>
104       <para>
105         Instructs <command>stratcond</command> to run in the foreground.
106         The process remains attached to the terminal.  This is primarily
107         for debugging purposes.
108       </para>
109     </listitem>
110   </varlistentry>
111   <varlistentry><term><option>-d</option></term>
112     <listitem>
113       <para>
114         Enables the debug output facility despite configuration to the
115         contrary.
116       </para>
117     </listitem>
118   </varlistentry>
119   <varlistentry><term><option>-M</option></term>
120     <listitem>
121       <para>
122         Instructs <command>noitd</command> to exit immediately if there
123         where any problems loading specified modules.
124       </para>
125     </listitem>
126   </varlistentry>
127   <varlistentry><term><option>-s</option></term>
128     <listitem>
129       <para>
130         Disables pulling for durable logs from noits and subsequent
131         loading of data into the database.
132       </para>
133     </listitem>
134   </varlistentry>
135   <varlistentry><term><option>-r</option></term>
136     <listitem>
137       <para>
138         Disables pulling for transient logs from noits and subsequent
139         submission to the message queue.
140       </para>
141     </listitem>
142   </varlistentry>
143   <varlistentry><term><option>-h</option></term>
144     <listitem>
145       <para>
146         Displays the usage information.
147       </para>
148     </listitem>
149   </varlistentry>
150 </variablelist>
151 </refsect1>
152 </refentry>
153
154 <!--
155 vim:ts=2:sw=2:et:
156 -->
157
Note: See TracBrowser for help on using the browser.