Add new config option to specify which cronitor region should be used for telemetry (#43)

Author: shaneharter

README.md

@@ -227,17 +227,18 @@ monitor.delete() // destroy the monitor
 
 ## Package Configuration
 
-The package needs to be configured with your account's `API key`, which is available on the [account settings](https://cronitor.io/settings) page. You can also optionally specify an `api_version`, an `environment`, and a request `timeout`.
+The package needs to be configured with your account's `API key`, which is available on the [account settings](https://cronitor.io/settings) page. You can also optionally specify an `api_version`, an `environment`, a request `timeout`, and a cronitor `region`.
 
-These can also be supplied using the environment variables `CRONITOR_API_KEY`, `CRONITOR_API_VERSION`, `CRONITOR_ENVIRONMENT`, `CRONITOR_TIMEOUT`.
+These can also be supplied using the environment variables `CRONITOR_API_KEY`, `CRONITOR_API_VERSION`, `CRONITOR_ENVIRONMENT`, `CRONITOR_TIMEOUT`, `CRONITOR_REGION`.
 
 ```javascript
 const cronitor = require('cronitor')(
     'cronitor_api_key',
     {
         apiVersion: '2020-10-01',
         environment: 'staging',
-        timeout: 5000
+        timeout: 5000,
+        region: 'eu'
     });
 ```
 

lib/cronitor.js

@@ -18,6 +18,7 @@ function Cronitor(apiKey, config = {}) {
     const version = config.apiVersion || process.env.CRONITOR_API_VERSION || null;
     const timeout = config.timeout || process.env.CRONITOR_TIMEOUT || 10000;
     const env = config.environment || config.env || process.env.CRONITOR_ENVIRONMENT || process.env.CRONITOR_ENV || null;
+    const region = config.region || process.env.CRONITOR_REGION || null;
     const headers = {
         'User-Agent': 'cronitor-js',
         'Authorization': 'Basic ' + new Buffer.from(apiKey + ':').toString('base64'),
@@ -26,11 +27,14 @@ function Cronitor(apiKey, config = {}) {
     if (path) this.path = path;
     if (version) headers['Cronitor-Version'] = version;
 
+    let subdomain = ""
+    if (region === "eu") subdomain = "eu."
+
     this._api = {
         key: apiKey,
         version,
         env: env,
-        pingUrl: (key) => `https://cronitor.link/ping/${apiKey}/${key}`,
+        pingUrl: (key) => `https://${subdomain}cronitor.link/ping/${apiKey}/${key}`,
         monitorUrl: (key) => `https://cronitor.io/api/monitors${key ? '/' + key : ''}`,
         axios: axios.create({
             baseURL: '',

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cronitor",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "A simple library for reliably monitoring cron jobs, control-loops, or other important system events with Cronitor.",
   "main": "lib/cronitor.js",
   "repository": {

package.json

@@ -192,6 +192,15 @@ describe('Monitor', () => {
         expect(stub).to.be.calledWith(`${monitor._api.pingUrl(monitor.key)}`);
         done();
     });
+
+    it('should use eu subdomain when region is set to eu', function(done) {
+        const euCronitor = require('../lib/cronitor')('apiKey123', { region: 'eu' });
+        const monitor = new euCronitor.Monitor('a-key');
+        const stub = sinon.stub(monitor._api.axios, 'get');
+        monitor.ok();
+        expect(stub).to.be.calledWith('https://eu.cronitor.link/ping/apiKey123/a-key');
+        done();
+    });
 });
 
 describe('Event', () => {