doc/developer-guidelines.sgml

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" >
   2 <book>
   3   <title>Nagios Plug-in Developer Guidelines</title>
   4
   5   <bookinfo>
   6     <authorgroup>
   7       <author>
   8         <firstname>Karl</firstname>
   9         <surname>DeBisschop</surname>
  10         <affiliation>
  11           <address><email>karl@debisschop.net</email></address>
  12         </affiliation>
  13       </author>
  14
  15       <author>
  16         <firstname>Ethan</firstname>
  17         <surname>Galstad</surname>
  18         <authorblurb>
  19           <para>Author of Nagios</para>
  20           <para><ulink url="http://www.nagios.org"></ulink></para>
  21         </authorblurb>
  22         <affiliation>
  23           <address><email>netsaint@linuxbox.com</email></address>
  24         </affiliation>
  25       </author>
  26
  27       <author>
  28         <firstname>Hugo</firstname>
  29         <surname>Gayosso</surname>
  30         <affiliation>
  31           <address><email>hgayosso@gnu.org</email></address>
  32         </affiliation>
  33       </author>
  34
  35
  36         <author>
  37         <firstname>Subhendu</firstname>
  38         <surname>Ghosh</surname>
  39         <affiliation>
  40                 <address><email>sghosh@sourceforge.net</email></address>
  41         </affiliation>
  42         </author>
  43
  44         <author>
  45         <firstname>Stanley</firstname>
  46         <surname>Hopcroft</surname>
  47         <affiliation>
  48                 <address><email>stanleyhopcroft@sourceforge.net</email></address>
  49         </affiliation>
  50         </author>
  51
  52     </authorgroup>
  53
  54     <pubdate>2002</pubdate>
  55     <title>Nagios plug-in development guidelines</title>
  56
  57     <revhistory>
  58        <revision>
  59           <revnumber>0.4</revnumber>
  60           <date>2 May 2002</date>
  61        </revision>
  62     </revhistory>
  63
  64         <copyright>
  65                 <year>2000 2001 2002</year>
  66                 <holder>Karl DeBisschop, Ethan Galstad,
  67                 Hugo Gayosso, Stanley Hopcroft, Subhendu Ghosh</holder>
  68         </copyright>
  69
  70 </bookinfo>
  71
  72
  73 <preface id="preface"><title>Preface</title>
  74     <para>The purpose of this guidelines is to provide a reference for
  75     the plug-in developers and encourage the standarization of the
  76     different kind of plug-ins: C, shell, perl, python, etc.</para>
  77
  78         <para>Nagios Plug-in Development Guidelines Copyright (C) 2000-2003
  79         (Karl DeBisschop, Ethan Galstad, Stanley Hopcroft, Subhendu Ghosh, Ton Voon, Jeremy T. Bouse)</para>
  80
  81         <para>Permission is granted to make and distribute verbatim
  82         copies of this manual provided the copyright notice and this
  83         permission notice are preserved on all copies.</para>
  84
  85         <para>The plugins themselves are copyrighted by their respective
  86         authors.</para>
  87 </preface>
  88
  89 <article>
  90 <section id="DevRequirements"><title>Development platform requirements</title>
  91         <para>
  92         Nagios plugins are developed to the GNU standard, so any OS which is supported by GNU
  93         should run the plugins. While the requirements for compiling the Nagios plugins release
  94         is very small, to develop from CVS needs additional software to be installed. These are the
  95         minimum levels of software required:
  96
  97         <literallayout>
  98         gnu make 3.79
  99         automake 1.6
 100         autoconf 2.54
 101         gettext 0.11.5
 102         </literallayout>
 103
 104         To compile from CVS, after you have checked out the code, run:
 105         <literallayout>
 106         tools/setup
 107         ./configure
 108         make
 109         make install
 110         </literallayout>
 111         </para>
 112 </section>
 113
 114 <section id="PlugOutput"><title>Plugin Output for Nagios</title>
 115
 116                 <para>You should always print something to STDOUT that tells if the
 117                 service is working or why it is failing. Try to keep the output short -
 118                 probably less that 80 characters. Remember that you ideally would like
 119                 the entire output to appear in a pager message, which will get chopped
 120                 off after a certain length.</para>
 121
 122                 <section><title>Print only one line of text</title>
 123                 <para>Nagios will only grab the first line of text from STDOUT
 124                 when it notifies contacts about potential problems. If you print
 125                 multiple lines, you're out of luck. Remember, keep it short and
 126                 to the point.</para>
 127
 128                 <para>Output should be in the format:</para>
 129                 <literallayout>
 130                 METRIC STATUS: Information text
 131                 </literallayout>
 132                 <para>However, note that this is not a requirement of the API, so you cannot depend on this
 133                 being an accurate reflection of the status of the service - the status should always
 134                 be determined by the return code.</para>
 135                 </section>
 136
 137                 <section><title>Verbose output</title>
 138                 <para>Use the -v flag for verbose output. You should allow multiple
 139                 -v options for additional verbosity, up to a maximum of 3. The standard
 140                 type of output should be:</para>
 141
 142                 <table id="verbose_levels"><title>Verbose output levels</title>
 143                         <tgroup cols="2">
 144                                 <thead>
 145                                         <row>
 146                                                 <entry><para>Verbosity level</para></entry>
 147                                                 <entry><para>Type of output</para></entry>
 148                                         </row>
 149                                 </thead>
 150                                 <tbody>
 151                                         <row>
 152                                                 <entry align="center"><para>0</para></entry>
 153                                                 <entry><para>Single line, minimal output. Summary</para></entry>
 154                                         </row>
 155                                         <row>
 156                                                 <entry align="center"><para>1</para></entry>
 157                                                 <entry><para>Single line, additional information (eg list processes that fail)</para></entry>
 158                                         </row>
 159                                         <row>
 160                                                 <entry align="center"><para>2</para></entry>
 161                                                 <entry><para>Multi line, configuration debug output (eg ps command used)</para></entry>
 162                                         </row>
 163                                         <row>
 164                                                 <entry align="center"><para>3</para></entry>
 165                                                 <entry><para>Lots of detail for plugin problem diagnosis</para></entry>
 166                                         </row>
 167                                 </tbody>
 168                         </tgroup>
 169                 </table>
 170                 </section>
 171
 172                 <section><title>Screen Output</title>
 173                 <para>The plug-in should print the diagnostic and just the
 174                 synopsis part of the help message.  A well written plugin would
 175                 then have --help as a way to get the verbose help.</para>
 176                 <para>Code and output should try to respect the 80x25 size of a
 177                 crt (remember when fixing stuff in the server room!)</para>
 178                 </section>
 179
 180             <section><title>Return the proper status code</title>
 181                 <para>See <xref linkend="ReturnCodes"> below
 182                 for the numeric values of status codes and their
 183                 description. Remember to return an UNKNOWN state if bogus or
 184                 invalid command line arguments are supplied or it you are unable
 185                 to check the service.</para>
 186                 </section>
 187
 188                 <section><title>Plugin Return Codes</title>
 189                 <para>The return codes below are based on the POSIX spec of returning
 190                 a positive value.  Netsaint prior to v0.0.7 supported non-POSIX
 191                 compliant return code of "-1" for unknown.  Nagios supports POSIX return
 192                 codes by default.</para>
 193
 194                 <para>Note: Some plugins will on occasion print on STDOUT that an error
 195                 occurred and error code is 138 or 255 or some such number.  These
 196                 are usually caused by plugins using system commands and having not
 197                 enough checks to catch unexpected output.  Developers should include a
 198                 default catch-all for system command output that returns an UNKNOWN
 199                 return code.</para>
 200
 201                 <table id="ReturnCodes"><title>Plugin Return Codes</title>
 202                         <tgroup cols="3">
 203                                 <thead>
 204                                         <row>
 205                                                 <entry><para>Numeric Value</para></entry>
 206                                                 <entry><para>Service Status</para></entry>
 207                                                 <entry><para>Status Description</para></entry>
 208                                         </row>
 209                                 </thead>
 210                                 <tbody>
 211                                         <row>
 212                                                 <entry align="center"><para>0</para></entry>
 213                                                 <entry valign="middle"><para>OK</para></entry>
 214                                                 <entry><para>The plugin was able to check the service and it
 215                                                 appeared to be functioning properly</para></entry>
 216                                         </row>
 217                                         <row>
 218                                                 <entry align="center"><para>1</para></entry>
 219                                                 <entry valign="middle"><para>Warning</para></entry>
 220                                                 <entry><para>The plugin was able to check the service, but it
 221                                                 appeared to be above some "warning" threshold or did not appear
 222                                                 to be working properly</para></entry>
 223                                         </row>
 224                                         <row>
 225                                                 <entry align="center"><para>2</para></entry>
 226                                                 <entry valign="middle"><para>Critical</para></entry>
 227                                                 <entry><para>The plugin detected that either the service was not
 228                                                 running or it was above some "critical" threshold</para></entry>
 229                                         </row>
 230                                         <row>
 231                                                 <entry align="center"><para>3</para></entry>
 232                                                 <entry valign="middle"><para>Unknown</para></entry>
 233                                                 <entry><para>Invalid command line arguments were supplied to the
 234                                                 plugin or the plugin was unable to check the status of the given
 235                                                 hosts/service</para></entry>
 236                                         </row>
 237                                 </tbody>
 238                         </tgroup>
 239                 </table>
 240
 241
 242                 </section>
 243
 244                 <section id="thresholdformat"><title>Threshold range format</title>
 245                 <para>Thresholds ranges define the warning and critical levels for plugins to
 246                 alert on. The theory is that the plugin will do some sort of check which returns
 247                 back a numerical value, or metric, which is then compared to the warning and
 248                 critical thresholds.
 249                 This is the generalised format for threshold ranges:</para>
 250
 251                 <literallayout>
 252                 [@]start:end
 253                 </literallayout>
 254
 255                 <para>Notes:</para>
 256                 <orderedlist>
 257                 <listitem><para>start &gt; end></para>
 258                         </listitem>
 259                 <listitem><para>start and ":" is not required if start=0</para>
 260                         </listitem>
 261                 <listitem><para>if range is of format "start:" and end is not specified,
 262                         assume end is infinity</para>
 263                         </listitem>
 264                 <listitem><para>to specify negative infinity, use "~"</para>
 265                         </listitem>
 266                 <listitem><para>alert is raised if metric is outside start and end range
 267                         (inclusive of endpoints)</para>
 268                         </listitem>
 269                 <listitem><para>if range starts with "@", then alert if inside this range
 270                         (inclusive of endpoints)</para>
 271                         </listitem>
 272                 </orderedlist>
 273
 274                 <para>Note: Not all plugins are coded to expect ranges in this format. It is
 275                 planned for a future release to
 276                 provide standard libraries to parse and compare metrics against ranges. There
 277                 will also be some work in providing multiple metrics.</para>
 278                 </section>
 279
 280                 <section><title>Performance data</title>
 281                 <para>Performance data is defined by Nagios as "everything after the | of the plugin output" -
 282                 please refer to Nagios documentation for information on capturing this data to logfiles.
 283                 However, it is the responsibility of the plugin writer to ensure the
 284                 performance data is in a "Nagios plugins" format.
 285                 This is the expected format:</para>
 286
 287                 <literallayout>
 288                 'label'=value[UOM];[warn];[crit];[min];[max]
 289                 </literallayout>
 290
 291                 <para>Notes:</para>
 292                 <orderedlist>
 293                 <listitem><para>space separated list of label/value pairs</para>
 294                         </listitem>
 295                 <listitem><para>label can contain any characters</para>
 296                         </listitem>
 297                 <listitem><para>the single quotes for the label are optional. Required if
 298                         spaces, = or ' are in the label</para>
 299                         </listitem>
 300                 <listitem><para>label length is arbitrary, but ideally the first 19 characters
 301                         are unique (due to a limitation in RRD). Be aware of a limitation in the
 302                         amount of data that NRPE returns to Nagios</para>
 303                         </listitem>
 304                 <listitem><para>to specify a quote character, use two single quotes</para>
 305                         </listitem>
 306                 <listitem><para>warn, crit, min or max may be null (for example, if the threshold is
 307                         not defined or min and max do not apply). Trailing unfilled semicolons can be
 308                         dropped</para>
 309                         </listitem>
 310                 <listitem><para>min and max are not required if UOM=%</para>
 311                         </listitem>
 312                 <listitem><para>value, min and max in class [-0-9.]. Must all be the
 313                         same UOM</para>
 314                         </listitem>
 315                 <listitem><para>warn and crit are in the range format (see
 316                         <xref linkend="thresholdformat">)</para>
 317                         </listitem>
 318                 <listitem><para>UOM (unit of measurement) is one of:</para>
 319                         <orderedlist>
 320                         <listitem><para>no unit specified - assume a number (int or float)
 321                                 of things (eg, users, processes, load averages)</para>
 322                                 </listitem>
 323                         <listitem><para>s - seconds (also us, ms)</para></listitem>
 324                         <listitem><para>% - percentage</para></listitem>
 325                         <listitem><para>B - bytes (also KB, MB, TB)</para></listitem>
 326                         <listitem><para>c - a continous counter (such as bytes
 327                                 transmitted on an interface)</para></listitem>
 328                         </orderedlist>
 329                         </listitem>
 330                 </orderedlist>
 331
 332                 <para>It is up to third party programs to convert the Nagios plugins
 333                 performance data into graphs.</para>
 334                 </section>
 335 </section>
 336
 337 <section id="SysCmdAuxFiles"><title>System Commands and Auxiliary Files</title>
 338
 339                 <section><title>Don't execute system commands without specifying their
 340                 full path</title>
 341                 <para>Don't use exec(), popen(), etc. to execute external
 342                 commands without explicity using the full path of the external
 343                 program.</para>
 344
 345                 <para>Doing otherwise makes the plugin vulnerable to hijacking
 346                 by a trojan horse earlier in the search path. See the main
 347                 plugin distribution for examples on how this is done.</para>
 348                 </section>
 349
 350                 <section><title>Use spopen() if external commands must be executed</title>
 351
 352             <para>If you have to execute external commands from within your
 353         plugin and you're writing it in C, use the spopen() function
 354                 that Karl DeBisschop has written.</para>
 355
 356                 <para>The code for spopen() and spclose() is included with the
 357                 core plugin distribution.</para>
 358                 </section>
 359
 360                 <section><title>Don't make temp files unless absolutely required</title>
 361
 362                 <para>If temp files are needed, make sure that the plugin will
 363                 fail cleanly if the file can't be written (e.g., too few file
 364                 handles, out of disk space, incorrect permissions, etc.) and
 365                 delete the temp file when processing is complete.</para>
 366                 </section>
 367
 368         <section><title>Don't be tricked into following symlinks</title>
 369
 370                 <para>If your plugin opens any files, take steps to ensure that
 371                 you are not following a symlink to another location on the
 372                 system.</para>
 373                 </section>
 374
 375                 <section><title>Validate all input</title>
 376
 377                 <para>use routines in utils.c or utils.pm and write more as needed</para>
 378                 </section>
 379
 380 </section>
 381
 382
 383
 384
 385 <section id="PerlPlugin"><title>Perl Plugins</title>
 386
 387                 <para>Perl plugins are coded a little more defensively than other
 388                 plugins because of embedded Perl.  When configured as such, embedded
 389                 Perl Nagios (ePN) requires stricter use of the some of Perl's features.
 390                 This section outlines some of the steps needed to use ePN
 391                 effectively.</para>
 392
 393                 <orderedlist>
 394
 395                         <listitem><para> Do not use BEGIN and END blocks since they will be called
 396                         the first time and when Nagios shuts down with Embedded Perl (ePN).  In
 397                         particular, do not use BEGIN blocks to initialize variables.</para>
 398                         </listitem>
 399
 400                         <listitem><para>To use utils.pm, you need to provide a full path to the
 401                         module in order for it to work with ePN.</para>
 402
 403           <literallayout>
 404           e.g.
 405                 use lib "/usr/local/nagios/libexec";
 406                 use utils qw(...);
 407           </literallayout>
 408                         </listitem>
 409
 410                         <listitem><para>Perl scripts should be called with "-w"</para>
 411                         </listitem>
 412
 413                         <listitem><para>All Perl plugins must compile cleanly under "use strict" - i.e. at
 414                         least explicitly package names as in "$main::x" or predeclare every
 415                         variable. </para>
 416
 417
 418                         <para>Explicitly initialize each varialable in use.  Otherwise with
 419                         caching enabled, the plugin will not be recompilied each time, and
 420                         therefore Perl will not reinitialize all the variables.  All old
 421                         variable values will still be in effect.</para>
 422                         </listitem>
 423
 424                         <listitem><para>Do not use &gt; DATA &lt; (these simply do not compile under ePN).</para>
 425                         </listitem>
 426
 427                         <listitem><para>Do not use named subroutines</para>
 428                         </listitem>
 429
 430                         <listitem><para>If writing to a file (perhaps recording
 431                         performance data) explicitly close close it.  The plugin never
 432                         calls <emphasis role="strong">exit</emphasis>; that is caught by
 433                         p1.pl, so output streams are never closed.</para>
 434                         </listitem>
 435
 436                         <listitem><para>As in <xref linkend="runtime"> all plugins need
 437                         to monitor their runtime, specially if they are using network
 438                         resources.  Use of the <emphasis>alarm</emphasis> is recommended.
 439                         Plugins may import a default time out ($TIMEOUT) from utils.pm.
 440                         </para>
 441                         </listitem>
 442
 443                         <listitem><para>Perl plugins should import %ERRORS from utils.pm
 444                         and then "exit $ERRORS{'OK'}" rather than "exit 0"
 445                         </para>
 446                         </listitem>
 447
 448                 </orderedlist>
 449
 450 </section>
 451
 452 <section id="runtime"><title>Runtime Timeouts</title>
 453
 454                 <para>Plugins have a very limited runtime - typically 10 sec.
 455                 As a result, it is very important for plugins to maintain internal
 456                 code to exit if runtime exceeds a threshold. </para>
 457
 458                 <para>All plugins should timeout gracefully, not just networking
 459                 plugins. For instance, df may lock if you have automounted
 460                 drives and your network fails - but on first glance, who'd think
 461                 df could lock up like that.  Plus, it should just be more error
 462                 resistant to be able to time out rather than consume
 463                 resources.</para>
 464
 465                 <section><title>Use DEFAULT_SOCKET_TIMEOUT</title>
 466
 467                 <para>All network plugins should use DEFAULT_SOCKET_TIMEOUT to timeout</para>
 468
 469                 </section>
 470
 471
 472                 <section><title>Add alarms to network plugins</title>
 473
 474                 <para>If you write a plugin which communicates with another
 475                 networked host, you should make sure to set an alarm() in your
 476                 code that prevents the plugin from hanging due to abnormal
 477                 socket closures, etc. Nagios takes steps to protect itself
 478                 against unruly plugins that timeout, but any plugins you create
 479                 should be well behaved on their own.</para>
 480
 481                 </section>
 482
 483
 484
 485 </section>
 486
 487 <section id="PlugOptions"><title>Plugin Options</title>
 488
 489                 <para>A well written plugin should have --help as a way to get
 490                 verbose help. Code and output should try to respect the 80x25 size of a
 491                 crt (remember when fixing stuff in the server room!)</para>
 492
 493                 <section><title>Option Processing</title>
 494
 495                 <para>For plugins written in C, we recommend the C standard
 496                 getopt library for short options. Getopt_long is always available.
 497                 </para>
 498
 499                 <para>For plugins written in Perl, we recommend Getopt::Long module.</para>
 500
 501                 <para>Positional arguments are strongly discouraged.</para>
 502
 503                 <para>There are a few reserved options that should not be used
 504                 for other purposes:</para>
 505
 506                 <literallayout>
 507           -V version (--version)
 508           -h help (--help)
 509           -t timeout (--timeout)
 510           -w warning threshold (--warning)
 511           -c critical threshold (--critical)
 512           -H hostname (--hostname)
 513           -v verbose (--verbose)
 514                 </literallayout>
 515
 516                 <para>In addition to the reserved options above, some other standard options are:</para>
 517
 518                 <literallayout>
 519           -C SNMP community (--community)
 520           -a authentication password (--authentication)
 521           -l login name (--logname)
 522           -p port or password (--port or --passwd/--password)monitors operational
 523           -u url or username (--url or --username)
 524                 </literallayout>
 525
 526                 <para>Look at check_pgsql and check_procs to see how I currently
 527                 think this can work.  Standard options are:</para>
 528
 529
 530                 <para>The option -V or --version should be present in all
 531                 plugins. For C plugins it should result in a call to print_revision, a
 532                 function in utils.c which takes two character arguments, the
 533                 command name and the plugin revision.</para>
 534
 535                 <para>The -? option, or any other unparsable set of options,
 536                 should print out a short usage statement. Character width should
 537                 be 80 and less and no more that 23 lines should be printed (it
 538                 should display cleanly on a dumb terminal in a server
 539                 room).</para>
 540
 541                 <para>The option -h or --help should be present in all plugins.
 542                 In C plugins, it should result in a call to print_help (or
 543                 equivalent).  The function print_help should call print_revision,
 544                 then print_usage, then should provide detailed
 545                 help. Help text should fit on an 80-character width display, but
 546                 may run as many lines as needed.</para>
 547
 548                 <para>The option -v or --verbose should be present in all plugins.
 549                 The user should be allowed to specify -v multiple times to increase
 550                 the verbosity level, as described in <xref linkend="verbose_levels">.</para>
 551     </section>
 552
 553     <section>
 554       <title>Plugins with more than one type of threshold, or with
 555       threshold ranges</title>
 556
 557       <para>Old style was to do things like -ct for critical time and
 558       -cv for critical value. That goes out the window with POSIX
 559       getopt. The allowable alternatives are:</para>
 560
 561       <orderedlist>
 562         <listitem>
 563           <para>long options like -critical-time (or -ct and -cv, I
 564           suppose).</para>
 565         </listitem>
 566
 567         <listitem>
 568           <para>repeated options like `check_load -w 10 -w 6 -w 4 -c
 569           16 -c 10 -c 10`</para>
 570         </listitem>
 571
 572         <listitem>
 573           <para>for brevity, the above can be expressed as `check_load
 574           -w 10,6,4 -c 16,10,10`</para>
 575         </listitem>
 576
 577         <listitem>
 578           <para>ranges are expressed with colons as in `check_procs -C
 579           httpd -w 1:20 -c 1:30` which will warn above 20 instances,
 580           and critical at 0 and above 30</para>
 581         </listitem>
 582
 583         <listitem>
 584           <para>lists are expressed with commas, so Jacob's check_nmap
 585           uses constructs like '-p 1000,1010,1050:1060,2000'</para>
 586         </listitem>
 587
 588         <listitem>
 589           <para>If possible when writing lists, use tokens to make the
 590           list easy to remember and non-order dependent - so
 591           check_disk uses '-c 10000,10%' so that it is clear which is
 592           the precentage and which is the KB values (note that due to
 593           my own lack of foresight, that used to be '-c 10000:10%' but
 594           such constructs should all be changed for consistency,
 595           though providing reverse compatibility is fairly
 596           easy).</para>
 597         </listitem>
 598
 599       </orderedlist>
 600
 601       <para>As always, comments are welcome - making this consistent
 602       without a host of long options was quite a hassle, and I would
 603       suspect that there are flaws in this strategy.
 604       </para>
 605     </section>
 606 </section>
 607
 608 <section id="CodingGuidelines"><title>Coding guidelines</title>
 609         <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU
 610         Coding standards</ulink> for general guidelines.</para>
 611         <section><title>Comments</title>
 612         <para>You should use /* */ for comments and not // as some compilers
 613         do not handle the latter form.</para>
 614         <para>There should not be any named credits in the source code - contributors
 615         should be added
 616         into the AUTHORS file instead. The only exception to this is if a routine
 617         has been copied from another source.</para>
 618         </section>
 619
 620         <section><title>CVS comments</title>
 621         <para>When adding CVS comments at commit time, you can use the following prefixes:
 622         <variablelist>
 623           <varlistentry><term>- comment</term>
 624           <listitem>
 625             <para>for a comment that can be removed from the Changelog</para>
 626           </listitem>
 627           </varlistentry>
 628           <varlistentry><term>* comment</term>
 629           <listitem>
 630             <para>for an important amendment to be included into a features list</para>
 631           </listitem>
 632           </varlistentry>
 633         </variablelist>
 634         </para>
 635         <para>If the change is due to a contribution, please quote the contributor's name
 636         and, if applicable, add the SourceForge Tracker number. Don't forget to
 637 update the AUTHORS file.</para>
 638         </section>
 639 </section>
 640
 641 <section id="SubmittingChanges"><title>Submission of new plugins and patches</title>
 642
 643         <section id="Patches"><title>Patches</title>
 644         <para>If you have a bug patch, please supply a unified or context diff against the
 645         version you are using. For new features, please supply a diff against
 646         the CVS HEAD version.</para>
 647
 648         <para>Patches should be submitted via
 649         <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=397599">SourceForge's
 650         tracker system for Nagiosplug patches</ulink>
 651         and be announced to the nagiosplug-devel mailing list.</para>
 652
 653         <para>Submission of a patch implies that the submmitter acknowledges that they
 654         are the author of the code (or have permission from the author to release the code)
 655         and agree that the code can be released under the GPL. The copyright for the changes will
 656         then revert to the Nagios Plugin Development Team - this is required so that any copyright
 657         infringements can be investigated quickly without contacting a huge list of copyright holders.
 658         Credit will always be given for any patches through a THANKS file in the distribution.</para>
 659         </section>
 660
 661         <section id="New_plugins"><title>New plugins</title>
 662         <para>If you would like others to use your plugins and have it included in
 663         the standard distribution, please include patches for the relevant
 664         configuration files, in particular "configure.in". Otherwise submitted
 665         plugins will be included in the contrib directory.</para>
 666
 667         <para>Plugins in the contrib directory are going to be migrated to the
 668         standard plugins/plugin-scripts directory as time permits and per user
 669         requests. The minimum requirements are:</para>
 670
 671       <orderedlist>
 672         <listitem>
 673           <para>The standard command options are supported (--help, --version,
 674           --timeout, --warning, --critical)</para>
 675         </listitem>
 676         <listitem>
 677           <para>It is determined to be not redundant (for instance, we would not
 678                 add a new version of check_disk just because someone had provide
 679                 a plugin that had perf checking - we would incorporate the features
 680                 into an exisiting plugin)</para>
 681         </listitem>
 682         <listitem>
 683           <para>One of the developers has had the time to audit the code and declare
 684                 it ready for core</para>
 685         </listitem>
 686         <listitem>
 687           <para>It should also follow code format guidelines, and use functions from
 688 utils (perl or c or sh) rather than cooking it's own</para>
 689         </listitem>
 690       </orderedlist>
 691
 692         <para>New plugins should be submitted via
 693         <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=541465">SourceForge's
 694         tracker system for Nagiosplug new plugins</ulink>
 695         and be announced to the nagiosplug-devel mailing list.</para>
 696
 697         <para>For new plugins, provide a diff to add to the EXTRAS list (configure.in)
 698         unless you are fairly sure that the plugin will work for all platforms with
 699         no non-standard software added.</para>
 700
 701         <para>If possible please submit a test harness. Documentation on sample
 702         tests coming soon.</para>
 703         </section>
 704
 705 </section>
 706
 707 </article>
 708
 709 </book>