plugin.json

{
  "name" : "TrueSight Pulse Http Check Plugin",
  "version" : "0.10.0",
  "meterVersionRequired" : "4.2.0-612",
  "unsupportedPlatforms" : [ ],
  "tags" : "http",
  "description" : "Polls a set of URLs and reports back the response time",
  "icon" : "icon.png",
  "command" : "node index.js",
  "postExtract" : "npm install",
  "command_lua" : "boundary-meter init.lua",
  "postExtract_lua" : "",
  "ignore" : "node_modules",
  "secure": true,
  "metrics" : [ "HTTP_RESPONSETIME" ],

  "dashboards" : [
     {
     "name" : "HTTP Check",
     "layout" : "d-w=1&d-h=1&d-pad=5&d-bg=none&d-g-HTTP_RESPONSETIME=0-0-1-1"
     }
  ],

  "paramArray" : { "itemTitle" : ["source", "url"], "schemaTitle" : "Endpoint"},
  "paramSchema" : [
    {
      "title" : "Source",
      "name" : "source",
      "description" : "The source to display in the legend for the endpoint. Ex. www.google.com",
      "type" : "string",
      "required" : true
    },
    {
      "title" : "Poll Interval (sec)",
      "name" : "pollInterval",
      "description" : "The Poll Interval (in seconds) to call your endpoint. Ex. 5",
      "type" : "integer",
      "default" : 5,
      "required" : true
    },
    {
      "title": "Method",
      "name": "method",
      "description": "The Method of the endpoint",
      "type" : { "enum" : [["GET", "GET"], ["POST", "POST"], ["PUT", "PUT"], ["DEL", "DEL"]] },
      "required": true
    },
    {
      "title": "Protocol",
      "name": "protocol",
      "description": "The protocol of the endpoint",
      "type" : { "enum" : [["HTTP", "http"], ["HTTPS", "https"]]},
      "required": true
    },
    {
      "title": "URL",
      "name": "url",
      "description": "The URL of the endpoint.  For example, www.graphdat.com or www.graphdat.com:8080/some-random-page",
      "type": "string",
      "required": true
    },
    {
      "title": "Ignore Status Code",
      "name": "ignoreStatusCode",
      "description": "If any response from the server is considered valid, even an error, enable this.",
      "type": "boolean",
      "default": false
    },
   {
      "title": "Username",
      "name": "username",
      "description": "(optional) The username required to access the endpoint",
      "type": "string",
      "required": false
    },
    {
      "title": "Password",
      "name": "password",
      "description": "(optional) The password required to access the endpoint",
      "type": "password",
      "required": false
    },
    {
      "title": "POST data",
      "name": "postdata",
      "description": "(optional) Additional information to pass along to the endpoint. Key Values pairs, \"key=value\" one per line",
      "type": "array",
      "items" : { "type" : "string" },
      "required": false
    },
    {
      "title": "Follow Redirects",
      "name": "follow_redirects",
      "description": "Follow redirections on 3xx responses.",
      "type": "boolean",
      "default" : true,
      "required": true
    },
    {
      "title": "Max Redirects",
      "name": "max_redirects",
      "description": "Max redirections allowed.",
      "type": "integer",
      "default" : 5,
      "required": false
    },
    {
      "title": "Debug Level",
      "name": "debug_level",
      "description": "If you are having issues with the plugin, you can enable additional debugging output to be shown in the relay console",
      "type": { "enum" : [["CRITICAL", "critical"], ["ERROR", "error"], ["WARNING", "warning"], ["INFO", "info"], ["DEBUG", "debug"], ["OFF", "notset"]] },
      "default": "notset",
      "required" : true
    }
  ]
}