1: 2: /* ------------------------------------------------------------- 3: This file is part of FreeNATS 4: 5: FreeNATS is (C) Copyright 2008 PurplePixie Systems 6: 7: FreeNATS is free software: you can redistribute it and/or modify 8: it under the terms of the GNU General Public License as published by 9: the Free Software Foundation, either version 3 of the License, or 10: (at your option) any later version. 11: 12: FreeNATS is distributed in the hope that it will be useful, 13: but WITHOUT ANY WARRANTY; without even the implied warranty of 14: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15: GNU General Public License for more details. 16: 17: You should have received a copy of the GNU General Public License 18: along with FreeNATS. If not, see www.gnu.org/licenses 19: 20: For more information see www.purplepixie.org/freenats 21: -------------------------------------------------------------- */ 22: 23: $NATS_Help=array(); 24: 25: function ha($id,$text) 26: { 27: global $NATS_Help; 28: $NATS_Help[strtoupper($id)]=$text; 29: } 30: 31: ha("FreeNATS","FreeNATS is a network monitoring package"); 32: 33: ha("Node","A node is a system or device which you are monitoring. Note that nodes can have tests pointing to different physical devices and vice-versa"); 34: ha("Node:Create","Create a new {node} with this {node:id|NodeID}"); 35: ha("Node:ID","The NodeID is a unique text name for a {node}. Maximum length 60 chars and only normal characters allowed."); 36: ha("Node:Enabled","The node is enabled for tests to be performed (and displayed in all applicable views)"); 37: ha("Node:AlertActive","Alerts will be generated for this node and alert actions performed if selected"); 38: ha("Node:PingTest","Do a ping (ICMP) test first before other tests - will always record results if enabled"); 39: ha("Node:RequirePing","Require the ping to pass for other tests to even be tried - will always fail if {Node:PingTest|ping test} is disabled"); 40: ha("Node:Master","Master Node to be Tested First"); 41: ha("MasterNode:Ping","Tests required to pass on the {Node:Master|master node} for this node to be tested"); 42: ha("Node:TestInterval","Interval (minutes) between tests on this node being carried out"); 43: ha("Nodeside","Enable support for node-side scripts to gather data from this node"); 44: ha("Node:CheckASAP","Schedule node for immediate text in next test cycle"); 45: 46: ha("Nodeside:Key","Key used to authenticate nodeside testing"); 47: ha("Nodeside:PullEnabled","Enable nodeside collection via http 'pull' from the node"); 48: ha("Nodeside:URL","URL to 'pull' nodeside data from on the node"); 49: ha("Nodeside:Interval","Interval between 'pulling' (polling) data from the node"); 50: ha("Nodeside:PushEnabled","Allow node to 'push' (post) data"); 51: ha("Nodeside:PushIP","Limit node 'push' to this specific IP address for security"); 52: 53: ha("Group","A group is a collection of one or more {node|nodes}. Note that nodes can be members of more than one group."); 54: ha("Group:Create","Create a new {group} with this name"); 55: 56: ha("Test:Name","A custom name can be assigned to the test for use in displays and alerts. If blank an automated name will be generated."); 57: ha("Test:Attempts","Number of times to attempt a test (will always try once). Defaults to 1 if zero or unset."); 58: ha("Test:Timeout","Timeout value for the test - alters the defaults or system-wide variable settings for the relevant test (seconds)"); 59: ha("Test:SimpleEvaluation","Use simple pass/fail evaluation (i.e. if a web test returns any data it passes else it fails)"); 60: ha("Test:Recorded","Record the results of this test for historic reports"); 61: ha("Test:Enabled","Perform the test or not (will update nothing if disabled)"); 62: ha("Test:Interval","Interval (minutes) between this test being performed. Will only ever be tested as quickly as the {Node:TestInterval|node interval} is set to"); 63: ha("Test:TestAlerts","Test will generate an alert on failure"); 64: 65: ha("History:Should","A rough calculation based on configured polling times (i.e. test interval or node interval) from the start to finish (or now if sooner)"); 66: 67: ha("View","A view is a custom set of nodes/groups/tests which can be used in a variety of ways"); 68: ha("View:Create","Creates a {view} of the specified name"); 69: ha("View:Public","The view can be seen by people not logged into FreeNATS"); 70: ha("View:Colons","If text status is selected for a view item a colon will be displayed before it"); 71: ha("View:Dashes","Display a dash before a test last run time where applicable"); 72: ha("View:TimeAgo","Use XX:XX ago or normal datetime for test details"); 73: ha("View:Columns","Display list-type elements in this number of columns (0 for off)"); 74: ha("View:Refresh","Send a http-equv to refresh the page after this many seconds (0 for off)"); 75: ha("View:UseColour","Use colour for status display as in normal FreeNATS display"); 76: ha("View:ShowDetail","Show details of the test/object(s) such as node tests"); 77: ha("View:TextStatus","Textual status such as passed, failed etc"); 78: 79: ha("Report","Reports show the %age of service availability in a specified period"); 80: 81: ha("Backup:Truncate","Clears tables first when restored back (recommended) otherwise duplicates may fail"); 82: 83: ha("Schedule","A schedule controls what times a node is tested and are managed through the admin page"); 84: ha("Schedule:DefaultAction","What will happen if no exceptions are matched (the opposite will happen if one is matched)"); 85: 86: ha("AlertAction","An alert action is performed when a node fails a test, they are configured through the admin page"); 87: ha("AAction:Warnings","The action is triggered for warning level events as well as failures (including downgrading from failure to warning if {AAction:Decreases|decreases} is set)"); 88: ha("AAction:Decreases","The action is triggered when the level goes down to closed (or {AAction:Warnings|warnings} if set)"); 89: ha("AAction:Limit","Max times this action can run in any one day (0 = unlimited) to avoid flooding"); 90: ha("AAction:Counter","Number of times this action has run in the day shown - you can manually reset this here"); 91: 92: ha("Variable","System variables are used to control the system environment. To delete a variable just save it with a blank name."); 93: ha("Var:log.level","The system log level - 10 is everything, 0 is fatal only. 5-6-ish is probably a good balance."); 94: 95: ha("Var:api.public","The API interface is available to public users if 1 (also see {Var:api.key|api.key})"); 96: ha("Var:api.key","Require this key from public users as apikey when accessing the API ({Var:api.public|api.public} must be set)"); 97: 98: ha("Var:alert.body.footer","Footer to go at the end of system generated alerts"); 99: ha("Var:alert.body.header","Header to go at the start of system generated alerts"); 100: ha("Var:alert.subject.long","Subject for email alerts of long format"); 101: ha("Var:alert.subject.short","Subject for email alerts of short format"); 102: ha("Var:freenats.firstrun","System variable to indicate first use of FreeNATS"); 103: ha("Var:site.enable.tests","Enable testing"); 104: ha("Var:site.enable.web","Enable web interface"); 105: 106: ha("Var:site.graph.public","Graphs are available to public users for views etc if 1 (also see {Var:site.graph.key|site.graph.key})"); 107: ha("Var:site.graph.key","Require this key from public users as graphkey ({Var:site.graph.public|site.graph.public} must be set)"); 108: 109: ha("Var:site.enable.interactive","Must be set (1) to allow interactive web sessions (like this one)"); 110: ha("Var:site.popupmessage","If set (1) will show a popup message when saving changes etc"); 111: ha("Var:site.dtformat","Site-wide custom date time format (in PHP format) i.e. Y-m-d H:i:s"); 112: 113: ha("Var:site.text.failed","Text to show for a failed status (defaults to Failed if unset)"); 114: ha("Var:site.text.passed","Text to show for a passed status (defaults to Passed if unset)"); 115: ha("Var:site.text.untested","Text to show for untested items (defaults to Untested if unset)"); 116: ha("Var:site.text.warning","Text to show for a warning status (defaults to Warning if unset)"); 117: ha("Var:site.text.closed","Text to indicate alert closed (defaults to Alert Closed if unset)"); 118: ha("Var:site.include.events","Include *.php in the server/site/events directory if 1"); 119: ha("Var:site.include.tests","Include *.php in the server/site/tests directory if 1"); 120: ha("Var:site.enable.adminsql","Enables the admin SQL console if 1"); 121: 122: ha("Var:mail.fromname","Textual from name to be used in SMTP mail (defaults to FreeNATS if unset)"); 123: ha("Var:mail.smtpserver","SMTP server to relay mail through (can be ; seperated list) uses internal mail() if unset or blank"); 124: ha("Var:mail.smtpusername","Username for SMTP AUTH (AUTH only used if username is set or provided)"); 125: ha("Var:mail.smtppassword","Password for SMTP AUTH"); 126: ha("Var:mail.smtphostname","Hostname for HELO in SMTP transactions (may be required for strict mail servers)"); 127: 128: ha("Var:test.icmp.timeout","Timeout in seconds to wait for an ICMP response before declaring a failure in seconds (default 10)"); 129: ha("Var:test.icmp.trytwice","Depreciated - replaced with {Var:test.icmp.attempts|test.icmp.attempts}"); 130: ha("Var:test.icmp.attempts","Number of times the main "require ping" test will attempt before failing (default 2)"); 131: ha("Var:test.icmp.returnms","If set (1) returns ping results in MilliSeconds (ms) (default 0)"); 132: ha("Var:test.http.timeout","Default timeout for HTTP/s streams used in web tests (uses system default if unset or <1)"); 133: ha("Var:test.imap.timeout","Default timeout for IMAP tests in seconds (uses environment default if unset or 0)"); 134: ha("Var:test.smtp.timeout","Default timeout for SMTP tests in seconds (uses 20 seconds if 0 or unset)"); 135: ha("Var:test.mysql.timeout","Default timeout for MySQL tests in seconds (uses environmental default if unset or 0)"); 136: ha("Var:test.spawndelay","Delay in seconds between node test threads being spawned by test-threaded.sh (no delay if 0 or unset), can be a decimal"); 137: ha("Var:test.interval","Delay in seconds between tests on a node (no delay if 0 or unset), can be a decimal"); 138: ha("Var:test.tcp.timeout","Default timeout for TCP tests (system default if 0 or unset) (seconds)"); 139: ha("Var:test.udp.timeout","Default timeout for UDP tests (system default if 0 or unset) (seconds)"); 140: 141: ha("Var:retain.alert","Days to retain alert records for (default 356 if 0 or unset). Retain forever with value -1."); 142: ha("Var:retain.record","Days to retain test result records for use in history and graphs (default 356 if 0 or unsert). Retain forever with value -1."); 143: ha("Var:retain.testrun","Days to retain test run records for (default 30 if 0 or unset). Retain forever with value -1."); 144: ha("Var:retain.syslog","Days to retain log entries for (default 30 if 0 or unset). Retain forever with value -1."); 145: 146: ha("Var:freenats.tracker","Participate in the automated feedback process - 1 for yes low level, 2 for detailed, 0 for disabled (default 0)"); 147: ha("Var:freenats.tracker.usid","Unique Site ID for FreeNATS tracker to anonymise data capture (only if {Var:freenats.tracker|freenats.tracker} set to 1"); 148: function hdisp($id,$html=true) 149: { 150: global $NATS_Help; 151: if (!isset($NATS_Help[strtoupper($id)])) return ""; 152: $t=$NATS_Help[strtoupper($id)]; 153: $o=""; 154: $mode="text"; 155: $linktext=false; 156: for ($a=0; $a
![](\"images/info".$size.".gif\" "\\"\".hdisp($id,false).\"\\"")
";
199:
200: return "![](\"images/info".$size."g.gif\" "\\"Sorry,")
";
201: }
202:
203: function ph($id,$size=16)
204: {
205: echo hlink($id,$size);
206: }
207: ?>