Skip to content

runnerty/executor-check-online-service

Repository files navigation

Smart Processes Management

NPM version Downloads Dependency Status code style: prettier

Check Online Service executor for Runnerty:

Installation:

Through NPM

npm i @runnerty/executor-check-online-service

You can also add modules to your project with runnerty

npx runnerty add @runnerty/executor-check-online-service

This command installs the module in your project, adds example configuration in your config.json and creates an example plan of use.

If you have installed runnerty globally you can include the module with this command:

runnerty add @runnerty/executor-check-online-service

Configuration sample:

Add in config.json:

{
  "id": "check_online_service_default",
  "type": "@runnerty-executor-check-online-service"
}

Plan sample:

Add in plan.json:

{
  "id":"check_online_service_default",
  "hostname": "http://www.google.com/en",
  "check_contains": "I'm Feeling Lucky"
}

Plan advanced:

Add in plan.json:

{
  "id":"check_online_service_default",
  "hostname": "http://www.google.com/en",
  "check_contains": "I'm Feeling Lucky",
  "method": "GET",
  "auth":{
    "user": "user",
    "pass": "password",
  }
}
{
  "id":"check_online_service_default",
  "hostname": "http://www.myservice.com/api/health",
  "headers": { "User-Agent": "runnerty", "Content-Type": "application/json" }
}
{
  "id":"check_online_service_default",
  "hostname": "http://www.myservice.com/api/health",
  "timeout": "5s"
}