Add shields for Uptime Robot #947

crazy-max · 2017-04-18T15:55:04Z

Linked to issue #824

paulmelnikow · 2017-04-18T20:36:41Z

Thanks for opening this! I'm excited.

paulmelnikow · 2017-04-18T20:31:42Z

server.js

+    try {
+      var percent = parseFloat(buffer.monitors[0].custom_uptime_ratio);
+      badgeData.text[1] = percent + "%";
+      badgeData.colorscheme = floorCountColor(percent, 25, 50, 75);


Just a thought, these could be a bit higher. e.g. 90, 99, 99.9

The best practice for a color level indicator with 4 color schemes seems to be :

10%, 30%, 50%, 70%

So maybe i can put these values instead :

//badgeData.colorscheme = floorCountColor(percent, 10, 30, 50); if (percent <= 10) { badgeData.colorscheme = 'red'; } else if (percent <= 30) { badgeData.colorscheme = 'yellow'; } else if (percent <= 50) { badgeData.colorscheme = 'yellowgreen'; } else if (percent <= 70) { badgeData.colorscheme = 'green'; } else { badgeData.colorscheme = 'brightgreen'; }

paulmelnikow · 2017-04-18T20:33:50Z

server.js

+      "api_key": monitorApiKey,
+      "format": "json"
+    },
+    uri: 'https://api.uptimerobot.com/v2/getMonitors'


Could you include a link to the API docs?

Of course (https://uptimerobot.com/api)

paulmelnikow · 2017-04-18T20:35:49Z

server.js

+      badgeData.text[1] = 'inaccessible';
+      sendBadge(format, badgeData);
+      return;
+    }


Could you add a "monitor not found" branch?

If an incorrect api key is entered for a monitor the following json is returned :

{ "stat": "fail", "error": { "type": "invalid_parameter", "parameter_name": "api_key", "passed_value": "u956-afus321g565fghr519", "message": "api_key not found." } }

I can add this case if this is what you want with something like that :

... if (json.stat === 'fail') { badgeData.text[1] = 'unknown error'; if (json.error) { badgeData.text[1] = json.error.message; } badgeData.colorscheme = 'lightgrey'; sendBadge(format, badgeData); return; } var status = json.monitors[0].status; if (status === 0) {

Thanks for adding that. Looks great. Though, I think it would be better to check that json.error.message is a string. Otherwise if error is an empty object you could end up with undefined on the badge.

if (json.error && typeof json.error.message === 'string') { badgeData.text[1] = json.error.message; } else { badgeData.text[1] = 'vendor error'; }

Done 91f69ae

crazy-max · 2017-04-19T00:42:43Z

Just made a new commit about your review

Daniel15 · 2017-04-19T03:26:46Z

index.html

@@ -931,6 +931,14 @@ <h3 id="miscellaneous"> Miscellaneous </h3>
    <td><img src='https://img.shields.io/swagger/valid/2.0/https/bitbucket.org/api/swagger.json.svg?maxAge=2592000' alt=''/></td>
    <td><code>https://img.shields.io/swagger/valid/2.0/https/bitbucket.org/api/swagger.json.svg</code></td>
  </tr>
+  <tr><th> Uptime Robot status: </th>
+    <td><img src='https://img.shields.io/uptimerobot/status/u956-afus321g565fghr519.svg?maxAge=2592000' alt=''/></td>


This example looks like the format used for Uptime Robot "full API keys". You should instead use a "monitor-specific API key" that looks like m775661887-da53aab04d8b7fe0ed74e653 (mxxxxx rather than uxxxxx at the start) as monitor-specific API keys only allow read-only access.

Agreed. Let's go a step further and reject the user keys, to reduce the chance that people share them by accident.

Yes indeed on the API documentation they don't provide a monitor api key example.
Btw i asked a question about the API rate limit and they said :

We don't apply a hard limit but monitor "bad usage" and warn if that happens. That almost never happened and no worries for that for such a legitimate usage.

So i will include an example with one of my monitor

…process the request

paulmelnikow · 2017-04-19T12:55:09Z

server.js

@@ -6108,6 +6114,12 @@ cache(function(data, match, sendBadge, request) {
    },
    uri: 'https://api.uptimerobot.com/v2/getMonitors'
  };
+  // A monitor API key must start with "m"
+  if (monitorApiKey.substring(0, "m".length) !== "m") {
+    badgeData.text[1] = 'api_key invalid';


Thanks for this change.

Would 'must use a monitor key' be more helpful?

Done a0e1afb

paulmelnikow · 2017-04-19T13:12:24Z

server.js

+
+// Uptime Robot ratio integration.
+// API documentation : https://uptimerobot.com/api
+camp.route(/^\/uptimerobot\/ratio\/(.*)\/(.*)\.(svg|png|gif|jpg|json)$/,


In testing this out, I found it was easy to miss the numberOfDays parameter. What do you think about moving it before the key, so it's less easily missed, and making it optional?

http://img.shields.io/uptimerobot/ratio/m778918918-3e92c097147760ee39d02d36.svg http://img.shields.io/uptimerobot/ratio/30/m778918918-3e92c097147760ee39d02d36.svg

Yes you're right 1bd8766

It's still required.

Oups forgot the optional part...

Done 3ed5543

paulmelnikow · 2017-04-19T15:11:08Z

server.js

@@ -6034,7 +6034,7 @@ cache(function(data, match, sendBadge, request) {
 // API documentation : https://uptimerobot.com/api
 camp.route(/^\/uptimerobot\/status\/(.*)\.(svg|png|gif|jpg|json)$/,
 cache(function(data, match, sendBadge, request) {
-  var monitorApiKey = match[1];  // eg, u956-afus321g565fghr519
+  var monitorApiKey = match[1];  // eg, m778918918-3e92c097147760ee39d02d36


paulmelnikow · 2017-04-20T13:30:08Z

This is great! Thanks for all the tweaks!

crazy-max · 2017-04-20T17:38:23Z

Great! Do you have a roadmap for a release date on production ?

paulmelnikow · 2017-04-20T18:24:03Z

It'll happen when @espadrine deploys. One of us can ping this thread when it does.

paulmelnikow · 2017-04-28T05:55:52Z

This has been deployed. 🚀

Add shields for Uptime Robot (Issue #824)

e55ceff

crazy-max mentioned this pull request Apr 18, 2017

UptimeRobot Shield #824

Closed

paulmelnikow reviewed Apr 18, 2017

View reviewed changes

paulmelnikow added the service-badge New or updated service badge label Apr 18, 2017

Update shields for Uptime Robot (Issue #824)

ce56400

Daniel15 reviewed Apr 19, 2017

View reviewed changes

Update examples with a real monitor api key and check api key before …

204b290

…process the request

paulmelnikow reviewed Apr 19, 2017

View reviewed changes

crazy-max added 3 commits April 19, 2017 14:58

Update label if not a monitor key

a0e1afb

Update gitignore for Jetbrains

7a3c558

Check typeof json.error for Uptime Robot

91f69ae

paulmelnikow reviewed Apr 19, 2017

View reviewed changes

Switch monitorApiKey and numberOfDays for Uptime Robot

1bd8766

paulmelnikow reviewed Apr 19, 2017

View reviewed changes

numberOfDays optional (default 30) for Uptime Robot ratio

3ed5543

paulmelnikow merged commit a079b68 into badges:master Apr 20, 2017

paulmelnikow added the pending-deploy label Apr 20, 2017

paulmelnikow added this to the Next Deploy milestone Apr 26, 2017

crazy-max mentioned this pull request Jun 13, 2017

StatusCake badges #864

Closed

denis-yuen mentioned this pull request May 8, 2018

Link to https://status.dockstore.org/ dockstore/dockstore#1287

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add shields for Uptime Robot #947

Add shields for Uptime Robot #947

crazy-max commented Apr 18, 2017

paulmelnikow commented Apr 18, 2017

paulmelnikow Apr 18, 2017

crazy-max Apr 19, 2017

paulmelnikow Apr 18, 2017

crazy-max Apr 19, 2017

paulmelnikow Apr 18, 2017

crazy-max Apr 19, 2017

paulmelnikow Apr 19, 2017

crazy-max Apr 19, 2017

crazy-max commented Apr 19, 2017

Daniel15 Apr 19, 2017

paulmelnikow Apr 19, 2017

crazy-max Apr 19, 2017 •

edited

Loading

paulmelnikow Apr 19, 2017

crazy-max Apr 19, 2017

paulmelnikow Apr 19, 2017

crazy-max Apr 19, 2017

paulmelnikow Apr 19, 2017

crazy-max Apr 19, 2017 •

edited

Loading

crazy-max Apr 20, 2017

paulmelnikow Apr 19, 2017

paulmelnikow commented Apr 20, 2017

crazy-max commented Apr 20, 2017

paulmelnikow commented Apr 20, 2017

paulmelnikow commented Apr 28, 2017

Add shields for Uptime Robot #947

Add shields for Uptime Robot #947

Conversation

crazy-max commented Apr 18, 2017

paulmelnikow commented Apr 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crazy-max commented Apr 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crazy-max Apr 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crazy-max Apr 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulmelnikow commented Apr 20, 2017

crazy-max commented Apr 20, 2017

paulmelnikow commented Apr 20, 2017

paulmelnikow commented Apr 28, 2017

crazy-max Apr 19, 2017 •

edited

Loading

crazy-max Apr 19, 2017 •

edited

Loading