Monitors


Common

All monitors requires the following fields

Parameter Description
Name The display name.
Interval The interval in minutes. Default is 5.

AppVeyor Build

Parameter Description
Account Name AppVeyor account name. Tip: make sure it is exactly the same as the account name in AppVeyor project URL address.
API Token AppVeyor API token. The token can be found on API token page under your AppVeyor account.
Project Slug Project slug is the last part of AppVeyor project URL. For example: http://ci.appveyor.com/project/AccountName/Project-Slug
Color Description
Green Build Succeeded
Red Build Failed
Blue Build is Queued or Running

Batch File

The Batch File monitor expects the script to return exit code 0.

Parameter Description
File Name The batch file path.
Arguments The script arguments.
Timeout The script execution timeout in minutes. Default is 1.
Color Description
Green Exit code is 0
Red Exit code is not 0

GitHub Issue

Parameter Description
Issue Number GitHub issue number.
Owner Issue owner GitHub account name.
Repository GitHub repository name.
Color Description
Green Status is Open
Red Status is Closed

HTTP Status

Parameter Description
URL HTTP URL address.
HTTP Status Code Expected HTTP status code. Default is OK 200.
Ignore SSL Errors When checked, SSL errors such as expired or self-signed certificate errors are ignored. Default is False.
Color Description
Green Success
Red Failure

Jenkins Build

Parameter Description
URL The Jenkins build URL address. For example: https://ci.jenkins.io/job/Core/job/jenkins/job/master/
User Name Optional.
API Token Optional.
Ignore SSL Errors When checked, SSL errors such as expired or self-signed certificate errors are ignored. Default is False.
Color Description
Green Build Succeeded
Orange Build Partially Succeeded
Red Build Failed
Gray Build Canceled

Ping

Parameter Description
Host Target computer host name or IP address.
Color Description
Green The ping request succeeded
Red The ping request failed

PowerShell Script

The PowerShell Script monitor expects the script to return exit code 0.

Parameter Description
File Name The Powershell script file path.
Arguments The script arguments.
Timeout The script execution timeout in minutes. Default is 1.
Bypass Execution Policy Read-only. Default is True.
Color Description
Green Exit code is 0
Red Exit code is not 0

TCP/IP

Parameter Description
Host Target computer host name or IP address.
Port Port number.
Color Description
Green Port is open
Red Port is closed

TeamCity Build

Parameter Description
Url  
Build Type Id  
Use Guest User Default is False
User Name  
Password  
Ignore SSL Errors When checked, SSL errors such as expired or self-signed certificate errors are ignored. Default is False.
Color Description
Green Build Succeeded
Red Build Failed
Blue Build is Running
Gray Build status is unknown

TFS 2015 Build

Parameter Description
URL TFS URL address. For example: http://tfs:8080/tfs
Collection  
Team Project  
Build Definition  
User Name  
Password  
Color Description
Green Build Succeeded
Red Build Failed
Blue Build is Queued or In Progress
Orange Build partially succeeded
Gray Build Canceled

Windows Service

Parameter Description
Machine Name Leave empty for Local Computer. Default is Empty.
Service Name  
Status Default is Running
Color Description
Green  
Red