Documentation

NodePing Reporting

Information about the results of the monitoring are available in a variety of formats tailored to a variety use cases.

Check Results View

The main screen's list of checks displays whether that check is currently in a PASS or FAIL state. If you click on the words PASS or FAIL, you can see a chart and list of the most recent results for that check.

Notifications List

You can view all notifications that have been sent for each monitoring check by clicking on the "List Notifications." This shows what notifications have been sent, to whom, and what they said. Generally the last month or so of notifications are visible in this list.

Results Report

The results report shows the most recent results for the check, very similar to the results view discussed above.

Every check is assigned a UUID that is used in the URL's for the reports. The report URL also lets you easily set how many results you want to return by adding / and an integer after the UUID. See the examples below to see how that looks.

This report accepts URL parameters for start and end dates. In most cases, the end date is more useful than start, since the report returns a set number of records sorted by time backwards from that date (in database talk, sorted by date descending). The format for the date is fairly flexible, but we recommend using YYYY-MM-DD. See the URL examples below.

There are also three different ways to get the results of this report. The default is a standard HTML view, as shown in the screenshot. There are links to each format in the main status screen, but you can also change the URL's by hand to adjust the output. Adding a "format" parameter to the URL allows you to change the results to a JSON or CSV format. Changing to CSV causes the browser to treat the report as a download. To set the file name for the download, just append /filename to the URL, where filename is whatever you want to name the file (typically it should end in .csv).

URL examples:

Performance Summary Report

The performance summary report shows the minumum, maximum, and average response time over an hour. By default, it shows 31 days of data. Like results report, you can change the number of results shown by editing the number on the report's URL. You can also retrieve the data in JSON or CSV format by adding ?format=csv or ?format=json to the URL. For CSV output, you can add a file name to the URL as well for convenience (so the URL would end in /filename.csv?format=csv).

URL examples:

Uptime Report

The uptime report shows the amount of time that the check has been enabled, how much it has been down, and an uptime percentage. Uptime is calculated based on the time that the check is enabled, so if a check is disabled for a while it does not count against uptime.This report accepts parameters:

  • interval - "days" or "months", the default is "months".
  • start - a start date for the report.
  • end - an end date for the report.

As with the other reports, you can also retrieve the data in JSON or CSV format by adding ?format=csv or ?format=json to the URL. For CSV output, you can add a file name to the URL as well for convenience (so the URL would end in /filename.csv?format=csv). Unlike the other reports, this report does not accept a limit number. The start and end date serve a similar purpose.

URL examples:

Events Report

The Events report shows a runtime chart, uptime with date range picker, a list of past downtime events, and any notes created for those events.

If you're logged in and have at least 'Edit' permissions, you can create a comment by clicking on the callout with a plus sign in it and typing in the text field provided - text only. You can optionally set the author of the comment. If you'd like the comment to be visible in public reports, put a check in the box next to 'Public'. To save your comment or changes, click on the green diskette (cause we're all about that 1995 stuff).

"Public" Reports

Each check has a toggle in its configuration that allows you to turn on "public" reports for that check. Once public, the results, uptime, and summary reports can be accessed using the UUID without needing a login to the account. Note that the UUID is not easily guessable, and we do not publish them. Therefore, while the report is public in the sense that it does not require a login, it will not be readily accessible by anyone who doesn't know the UUID. The public toggle turns all of the reports for that check on or off. At present you can't just turn public access to the summary without turning it on for the results report as well.

Public Status Reports

In addition to the public reports that are available for each check, NodePing also provides two different kinds of public status reports where you can display check status, uptime, and optionally comments about recent downtimes for whatever checks you select - all on one report. You can create multiple public status reports to display your checks in a way that best suits your needs.

There are two different public status reports available: "Status" and "Status with events".

The "Status" report displays the status for some or all of your checks with uptime for each check over the last 30 days, as well as the uptime for each of the last seven days. You can see a sample of this report at https://status.nodeping.com.

The "Status with events" report displays the status and uptime for each check for the last 24 hours and 30 days. It shows any checks that are failing at the top of the report and provides a list of down events for all the checks listed in the report along with any notes created for those events. If you are logged in, you'll be able to see private as well as public notes. You can see a sample of this report at https://systemstatus.nodeping.com.

You can create as many public status reports as your NodePing plan allows. Create them by clicking on Account Settings -> Reporting. You can give each of them a custom domain. For example, we use https://status.nodeping.com and https://probestatus.nodeping.com.

Once created, a public status report has a generated URL at which it can be accessed, which is shown in the public status report list. Most people opt to use a custom domain, often something like "status.example.com". To use a custom domain, in addition to entering it in the report configuration, you'll also need to point the domain in your DNS to nodeping.com so people can reach the report in their browser. Usually a CNAME record is the best way to accomplish this. Business and Provider accounts have the option of using your own SSL Cert for the custom domain used for status reports. Contact support for more details about installing SSL certs.

Each report also allows you to set a report title. Since this field allows HTML, you can add styling to this to make it match your brand. In fact, it is possible to add an image tag (such as your logo) and a style tag to this field and use it to customize the look of the report as a whole. Not all tags are supported, but the custom title feature gives you a significant amount of control over the styling of the report.

You can set which of your enabled checks will appear on each public status report by clicking the checkbox under the "Include" column. If a check has its public reports enabled, the status page will automatically have a link from the check name on the status report to the check's specific reports.

The "Show Check Type" field allows you to toggle whether the report should include a column showing the check type.

Working with the Charts

The charts used throughout the site provide some features to understand and view the data better. If you move the mouse over the line in the chart, you'll see the time and result for that time for that point on the chart. This allows you to easily see the details of the results more clearly. You can also zoom in to see the data more closely by dragging either horizontally or vertically on the chart. Double clicking returns you to the default scale.

If you have any questions, get in touch at support@nodeping.com, or use our Contact form.