Two Web Services let you integrate our tests into your IT infrastructure.
BatchTestUpLoad uploads lists of tests and runs them on demand or automatically.
MonitorTLS (described here) retrieves test results.
Both web services talk to your systems using simple XML.
MonitorTLS makes the results of a BatchTest available as a web service that your existing monitoring and notification system(s) can use. You provide it with your UserCode, Password, and a particular test serial number (TestId), and MonitorTLS returns an XML document showing when the test was last run, what the total score was, and optionally all the test results logs. The XML output from the web service looks like this:
<CheckTLS test="BatchTestThru"> <Description>Monitor CheckTLS</Description> <LastRun>2011-01-01 12:01:02</LastRun> <LastTotal>100.000000</LastTotal> </CheckTLS>
The LastTotal element in the XML is either the sum or average of all the tests in your BatchTest, so you control what the definition of success and failure is and how to check for it. The LastRun element lets you verify that our test systems are working; if it is too old, there's a problem on our end.
For example, we monitor our own CheckTLS email system. We setup a BatchTestThru test that tests CheckTLS.com's ability to send and receive TLS email. It is configured to average all the tests into a single "Total", and not send the results in email. We schedule this test to run every six hours: midnight, 6:00AM, noon, 6:00PM.
Our monitoring software (Nagios), like many others, has an option to monitor a web page. Because MonitorTLS outputs XML, it was very easy for Nagios to parse both LastRun and LastTotal. It then alerts us if the last test run is too old or if the score (average) goes below 100%.
While this test accepts any UserCode, Password, and TestId (just type anything or nothing in those fields), when you click "Return Result" you will run the real test and get back live results.
This is the WebService URL that your monitoring would use to access MonitorTLS "machine to machine". Click it to see the result, and then use your browser's URL field to change the parameter values to view different options and results.
Walk Thru Setup
See how easy it is to setup a new test and monitor it with this step-by-step walk through that includes screen shots.
The BatchTestThru XML config file for our monitoring looks like this:
<BatchTest TestType="thru"> <Target>firstname.lastname@example.org</Target> <Delivery> <To>file</To> <Format>text</Format> </Delivery> <Total Function="average"/> </BatchTest>