Add shields for Uptime Robot #947
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6030,6 +6030,121 @@ cache(function(data, match, sendBadge, request) { | |
| }); | ||
| })); | ||
|
|
||
| // Uptime Robot status integration. | ||
| // 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 format = match[2]; | ||
| var badgeData = getBadgeData('status', data); | ||
| var options = { | ||
| method: 'POST', | ||
| json: true, | ||
| body: { | ||
| "api_key": monitorApiKey, | ||
| "format": "json" | ||
| }, | ||
| uri: 'https://api.uptimerobot.com/v2/getMonitors' | ||
|
There was a problem hiding this comment. Could you include a link to the API docs? There was a problem hiding this comment. Of course (https://uptimerobot.com/api) |
||
| }; | ||
| request(options, function(err, res, json) { | ||
| if (err !== null || res.statusCode >= 500 || typeof json !== 'object') { | ||
| badgeData.text[1] = 'inaccessible'; | ||
| sendBadge(format, badgeData); | ||
| return; | ||
| } | ||
|
There was a problem hiding this comment. Could you add a "monitor not found" branch? There was a problem hiding this comment. 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) {There was a problem hiding this comment. Thanks for adding that. Looks great. Though, I think it would be better to check that |
||
| try { | ||
| 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) { | ||
| badgeData.text[1] = 'paused'; | ||
| badgeData.colorscheme = 'yellow'; | ||
| } else if (status === 1) { | ||
| badgeData.text[1] = 'not checked yet'; | ||
| badgeData.colorscheme = 'yellowgreen'; | ||
| } else if (status === 2) { | ||
| badgeData.text[1] = 'up'; | ||
| badgeData.colorscheme = 'brightgreen'; | ||
| } else if (status === 8) { | ||
| badgeData.text[1] = 'seems down'; | ||
| badgeData.colorscheme = 'orange'; | ||
| } else if (status === 9) { | ||
| badgeData.text[1] = 'down'; | ||
| badgeData.colorscheme = 'red'; | ||
| } else { | ||
| badgeData.text[1] = 'invalid'; | ||
| badgeData.colorscheme = 'lightgrey'; | ||
| } | ||
| sendBadge(format, badgeData); | ||
| } catch(e) { | ||
| badgeData.text[1] = 'invalid'; | ||
| sendBadge(format, badgeData); | ||
| } | ||
| }); | ||
| })); | ||
|
|
||
| // Uptime Robot ratio integration. | ||
| // API documentation : https://uptimerobot.com/api | ||
| camp.route(/^\/uptimerobot\/ratio\/(.*)\/(.*)\.(svg|png|gif|jpg|json)$/, | ||
|
There was a problem hiding this comment. In testing this out, I found it was easy to miss the There was a problem hiding this comment. Yes you're right 1bd8766 There was a problem hiding this comment. Oups forgot the optional part... |
||
| cache(function(data, match, sendBadge, request) { | ||
| var monitorApiKey = match[1]; // eg, u956-afus321g565fghr519 | ||
| var numberOfDays = match[2]; // eg, 30 | ||
| var format = match[3]; | ||
| var badgeData = getBadgeData('uptime', data); | ||
| var options = { | ||
| method: 'POST', | ||
| json: true, | ||
| body: { | ||
| "api_key": monitorApiKey, | ||
| "custom_uptime_ratios": numberOfDays, | ||
| "format": "json" | ||
| }, | ||
| uri: 'https://api.uptimerobot.com/v2/getMonitors' | ||
| }; | ||
| request(options, function(err, res, json) { | ||
| if (err !== null) { | ||
| badgeData.text[1] = 'inaccessible'; | ||
| sendBadge(format, badgeData); | ||
| return; | ||
| } | ||
| try { | ||
| 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 percent = parseFloat(json.monitors[0].custom_uptime_ratio); | ||
| badgeData.text[1] = percent + '%'; | ||
| 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'; | ||
| } | ||
| sendBadge(format, badgeData); | ||
| } catch (e) { | ||
| badgeData.text[1] = 'invalid'; | ||
| sendBadge(format, badgeData); | ||
| } | ||
| }); | ||
| })); | ||
|
|
||
| // Any badge. | ||
| camp.route(/^\/(:|badge\/)(([^-]|--)*?)-(([^-]|--)*)-(([^-]|--)+)\.(svg|png|gif|jpg)$/, | ||
| function(data, match, end, ask) { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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(mxxxxxrather thanuxxxxxat the start) as monitor-specific API keys only allow read-only access.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. Let's go a step further and reject the user keys, to reduce the chance that people share them by accident.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 :
So i will include an example with one of my monitor