Ask the Community
Groups
Creating a custom Plugin Monitor - Connect IT Community | Kaseya
<main> <article class="userContent"> <h3 dir="auto" data-id="problem-how-do-i-create-a-plugin-monitor"> <strong>PROBLEM: </strong>How do I create a Plugin Monitor?</h3> <h3 data-id="solution"><strong>SOLUTION: </strong></h3> <p dir="auto">A <a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fhelp.kaseya.com%2Fwebhelp%2FEN%2Ftv%2F9050000%2Fdev%2F%2330289.htm" rel="noreferrer nofollow">Plugin script monitor</a> is the recommended way to monitor non-traverse logs or query devices directly.</p> <p dir="auto">Please see the following user guide articles on how to create your own script:<br>- <a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fhelp.kaseya.com%2Fwebhelp%2FEN%2Ftv%2F9050000%2Fdev%2F%2330290.htm" rel="noreferrer nofollow">Configuration File Format</a> - Creating the Plugin script XML file<br>- <a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fhelp.kaseya.com%2Fwebhelp%2FEN%2Ftv%2F9050000%2Fdev%2F%2330291.htm" rel="noreferrer nofollow">Writing The Plugin Script</a> - Creating the script itself. The script prints a particular integer which defines a particular state. (*Take note - Traverse only supports Integer values, not String values)</p> <p dir="auto">On the Monitoring DGE/DGEx -<br>- Place your script in <TRAVERSE_HOME>/plugin/monitors/<test_type> directory (where <test_type> is the type name specified in the configuration file).<br>- Place the XML test descriptor in <TRAVERSE_HOME>/plugin/monitors<br>- The web application and DGE components must be restarted before the new monitor is usable.<br>- To provision the test:</p> <pre dir="ltr" class="code codeBlock" spellcheck="false" tabindex="0">1) Log in as end user. 2) Click on Administration > Devices > Tests. 3) Click on Add New Standard Tests. 4) A new check box should be presented with the name of the 'monitor type' as you defined it in the XML - (i.e. <monitor type="atmosphere") 5) Enable the test, and make sure that the correct severity option is selected (i.e. Ascending, Descending, Discrete etc.) 6) Submit the form. </pre> <p dir="auto">Some good sample perl scripts to base your script on:<br><a href="/home/leaving?allowTrusted=1&target=http%3A%2F%2Fhelp.kaseya.com%2Fwebhelp%2FEN%2Ftv%2F9050000%2Fdev%2F%2330292.htm" rel="noreferrer nofollow">Sample Plugin Monitor with Discrete Thresholds</a><br><a href="https://kaseya.vanillacommunities.com/kb/articles/aliases/kaseya/hc/en-gb/articles/229042348" rel="noreferrer nofollow">How do I monitor the expiration of SSL certificates?</a> (See attached script in that KB)</p> <p dir="auto">If this is your first time developing a Plugin Monitor, it's advisable to use the scripts in the above articles as a starting point and modify them as appropriate:</p> <p dir="auto"> </p> <h3 dir="auto" data-id="applies-to"><strong>APPLIES TO: </strong></h3> <h3 dir="auto" data-id="all-versions-of-traverse">All versions of Traverse</h3> <p dir="auto"> </p> </article> </main>