[otrs-cvs] SystemMonitoring/doc/en SystemMonitoring.xml,1.3,1.4
"CVS commits notifications of OTRS.org" <[email protected]> Tue, 28 May 2013 09:34:40 +0000
| Newsgroups | gmane.comp.otrs.cvs |
|---|---|
| Message-ID | <[email protected]> |
Comments:
Update of /home/cvs/SystemMonitoring/doc/en
In directory lancelot:/tmp/cvs-serv8697/doc/en
Modified Files:
SystemMonitoring.xml
Log Message:
Added documentation for missnaming of dynamic fields and error messages for missnamed dynamic fields.
Author: rs
Index: SystemMonitoring.xml
===================================================================
RCS file: /home/cvs/SystemMonitoring/doc/en/SystemMonitoring.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -2 -u -d -r1.3 -r1.4
--- SystemMonitoring.xml 15 Nov 2010 20:48:31 -0000 1.3
+++ SystemMonitoring.xml 28 May 2013 09:34:35 -0000 1.4
@@ -19,24 +19,29 @@
<preface id="preface">
<title>Preface</title>
- <para>This module implements a basic interface to System Monitoring Suites. It
- works by receiving email messages sent by a Network Monitoring Suite. New
- tickets are created in case of component failures. Once a ticket has
- been opened messages regarding the effected component are attached to
- this ticket. When the component recovers, the ticket state can be
- changed or the ticket can be closed.
-</para>
- <para>If an open ticket for a given Host/Service combination exists, all
- mails concerning this particular combination will be attached to the
- ticket until it's closed.
-</para>
- <para>Please contact your commercial support ([email protected]) if you have any queries regarding this document or need further information.</para>
+ <para>
+ This module implements a basic interface to System Monitoring Suites. It
+ works by receiving email messages sent by a Network Monitoring Suite. New
+ tickets are created in case of component failures. Once a ticket has
+ been opened messages regarding the effected component are attached to
+ this ticket. When the component recovers, the ticket state can be
+ changed or the ticket can be closed.
+ </para>
+ <para>
+ If an open ticket for a given Host/Service combination exists, all
+ mails concerning this particular combination will be attached to the
+ ticket until it's closed.
+ </para>
+ <para>
+ Please contact your commercial support ([email protected]) if you have any queries regarding this document or need further information.
+ </para>
</preface>
<chapter>
<title>Control flow</title>
- <para>The following diagram illustrates how mails are handled by this module
- and in which cases they trigger which action. Pretty much all checks are
- configurable using the regular expressions given by the parameters listed
- above.
-</para>
+ <para>
+ The following diagram illustrates how mails are handled by this module
+ and in which cases they trigger which action. Pretty much all checks are
+ configurable using the regular expressions given by the parameters listed
+ above.
+ </para>
<para><screen><![CDATA[
Mail matches 'FromAddress'?
@@ -63,9 +68,9 @@
'CloseActionState']]>
</screen></para>
-<para>Besides of a few additional sanity checks this is how the
- SystemMonitoring module treats incoming mails. By changing the regular
- expressions it should be possible to adopt it to different monitoring
- systems.
-</para>
+ <para>Besides of a few additional sanity checks this is how the
+ SystemMonitoring module treats incoming mails. By changing the regular
+ expressions it should be possible to adopt it to different monitoring
+ systems.
+ </para>
</chapter>
<chapter>
@@ -75,6 +80,6 @@
<para>The following OTRS framework is required:</para>
<para>
- $Framework
- </para>
+ $Framework
+ </para>
</sect1>
<sect1>
@@ -82,6 +87,6 @@
<para>Following packages are required:</para>
<para>
- $PackageRequired
- </para>
+ $PackageRequired
+ </para>
</sect1>
<sect1>
@@ -89,6 +94,6 @@
<para>Following operating systems are to be considered as dependency:</para>
<para>
- $OS
- </para>
+ $OS
+ </para>
</sect1>
<sect1>
@@ -111,6 +116,7 @@
<title>Admin Interface</title>
<para>
-Using the following URL you can install, as well as update or uninstall (if necessary), the package via the Admin Interface (please check whether the user is a member of the Admin Group before starting.)
- </para>
+ Using the following URL you can install, as well as update or uninstall (if necessary), the package via
+ the Admin Interface (please check whether the user is a member of the Admin Group before starting.)
+ </para>
<para>
<ulink url="http://localhost/otrs/index.pl?Action=AdminPackageManager">http://localhost/otrs/index.pl?Action=AdminPackageManager</ulink>
@@ -120,10 +126,11 @@
<title>Command line</title>
<para>
-Whenever you cannot use the Admin Interface for whatever reason, you may use the following command line tool ("bin/opm.pl") instead.
- </para>
+ Whenever you cannot use the Admin Interface for whatever reason, you may
+ use the following command line tool ("bin/opm.pl") instead.
+ </para>
<para>
<screen format="linespecific">
shell> bin/opm.pl -a install -p /path/to/$Name-$Version.opm
- </screen>
+ </screen>
</para>
</sect1>
@@ -131,13 +138,23 @@
<chapter>
<title>Configuration</title>
- <para>To allow flexible integration between OTRS and a System Monitoring Suite
- the following configuration options are available. The default values
- (as shown below) should be suitable for a standard Nagios installation.
- </para>
+ <para>
+ To allow flexible integration between OTRS and a System Monitoring Suite
+ the following configuration options are available. The default values
+ (as shown below) should be suitable for a standard Nagios installation.
+ </para>
+ <sect1>
+ <title>Creation of dynamic fields</title>
+ <para>
+ A requirement to get a working module is to create the dynamic fields
+ for the defined values of FreeTextHost, FreeTextService and FreeTextState.
+ </para>
+ </sect1>
<sect1>
<title>FromAddressRegExp</title>
- <para>Only mails matching this "From:" address will be considered for this
- filter. You need to adjust this setting to the from address your
- System Monitoring Suite uses for outgoing mails.</para>
+ <para>
+ Only mails matching this "From:" address will be considered for this
+ filter. You need to adjust this setting to the from address your
+ System Monitoring Suite uses for outgoing mails.
+ </para>
<para>Default: '[email protected]'</para>
</sect1>
@@ -154,25 +171,31 @@
<sect1>
<title>CloseTicketRegExp</title>
- <para>Regular expression for extracted "State" to trigger ticket
- transition to "CloseActionState".</para>
+ <para>
+ Regular expression for extracted "State" to trigger ticket
+ transition to "CloseActionState".
+ </para>
<para>Default: 'OK|UP'</para>
</sect1>
<sect1>
<title>CloseActionState</title>
- <para>New status for ticket when service recovers. This can be either
- "OLD" in which case the old status stays, or the name of the new
- status. Please note, that this state needs to be configured in your
- OTRS installation as valid state. If the state you set here does not
- exist, the ticket state will not be altered.</para>
+ <para>
+ New status for ticket when service recovers. This can be either
+ "OLD" in which case the old status stays, or the name of the new
+ status. Please note, that this state needs to be configured in your
+ OTRS installation as valid state. If the state you set here does not
+ exist, the ticket state will not be altered.
+ </para>
<para>Default: 'closed successful'</para>
</sect1>
<sect1>
<title>ClosePendingTime</title>
- <para>Pending time in seconds for 'Pending...' statuses. (Ignored for
- other status types). Please note that this setting will be ignored
- by OTRS versions older than 2.2. On these systems the pending time
- already associated with the ticket will be used, which may have in
- surprising effects. It's recommended not to use 'Pending...' states
- with OTRS prior to 2.2.</para>
+ <para>
+ Pending time in seconds for 'Pending...' statuses. (Ignored for
+ other status types). Please note that this setting will be ignored
+ by OTRS versions older than 2.2. On these systems the pending time
+ already associated with the ticket will be used, which may have in
+ surprising effects. It's recommended not to use 'Pending...' states
+ with OTRS prior to 2.2.
+ </para>
<para>Default: '60*60*24*2' (2 days)</para>
</sect1>
@@ -184,5 +207,9 @@
<sect1>
<title>FreeTextHost</title>
- <para>Free text field index to store the name of the affected host.</para>
+ <para>
+ A dynamic field (type ticket) to store the affected host.
+ The field name have to be named like free text fields (TicketFreeTextField[1..16]) because of downward compatibility.
+ For example: TicketFreeTextField1.
+ </para>
<para>Default: '1'</para>
</sect1>
@@ -194,11 +221,26 @@
<sect1>
<title>DefaultService</title>
- <para>Default for "Service"; used if no service can be extracted, i.e. if
- host goes DOWN/UP.</para>
+ <para>
+ Default for "Service"; used if no service can be extracted, i.e. if
+ host goes DOWN/UP.
+ </para>
<para>Default: 'Host'</para>
</sect1>
<sect1>
- <title>FreeTexyService</title>
- <para> Free text field index to store service.</para>
+ <title>FreeTextService</title>
+ <para>
+ A dynamic field (type ticket) to store the service.
+ The field name have to be named like free text fields (TicketFreeTextField[1..16]) because of downward compatibility.
+ For example: TicketFreeTextField2.
+ </para>
+ <para>Default: '2'</para>
+ </sect1>
+ <sect1>
+ <title>FreeTextState</title>
+ <para>
+ A dynamic field (type article) to store the state.
+ The field name have to be named like free text fields (ArticleFreeTextField[1..16]) because of downward compatibility.
+ For example: ArticleFreeTextField1.
+ </para>
<para>Default: '2'</para>
</sect1>
@@ -215,27 +257,29 @@
<sect1>
<title>Integration with OTRS Configuration Management</title>
- <para>If the OTRS::ITSM Configuration Management module is installed and
- the configuration option 'SystemMonitoring::SetIncidentState' is set
- to 'Yes', a CI with the given host name is searched in the CI database.
- If exactly one CI with this name was found, the current incident state is set
- automatically according to the incoming mail (Incident / Operational).
+ <para>
+ If the OTRS::ITSM Configuration Management module is installed and
+ the configuration option 'SystemMonitoring::SetIncidentState' is set
+ to 'Yes', a CI with the given host name is searched in the CI database.
+ If exactly one CI with this name was found, the current incident state is set
+ automatically according to the incoming mail (Incident / Operational).
- If the OTRS::ITSM Configuration Management module is installed and
- the configuration option 'SystemMonitoring::LinkTicketWithCI' is set
- to 'Yes', a CI is linked automatically with the system monitoring
- incident ticket. This is only possible if a subsequent system monitoring
- email arrives!
-</para></sect1>
+ If the OTRS::ITSM Configuration Management module is installed and
+ the configuration option 'SystemMonitoring::LinkTicketWithCI' is set
+ to 'Yes', a CI is linked automatically with the system monitoring
+ incident ticket. This is only possible if a subsequent system monitoring
+ email arrives!
+ </para>
+ </sect1>
</chapter>
<chapter>
<title>Contact</title>
<para>
-Please direct questions about the $Name Module to:
- </para>
+ Please direct questions about the $Name Module to:
+ </para>
<sect1>
<title>OTRS AG/OTRS Inc.</title>
<para>
- E-mail: [email protected]
- </para>
+ E-mail: [email protected]
+ </para>
</sect1>
</chapter>
@@ -243,6 +287,6 @@
<title>Change log</title>
<para>
- $ChangeLog
- </para>
+ $ChangeLog
+ </para>
</chapter>
</book>
---------------------------------------------------------------------
OTRS mailing list: cvs-log - Webpage: http://otrs.org/
Archive: http://lists.otrs.org/pipermail/cvs-log
To unsubscribe: http://lists.otrs.org/cgi-bin/listinfo/cvs-log