You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
2.9 KiB
88 lines
2.9 KiB
module.exports = function(client) {
|
|
/* section: serviceCheck
|
|
*comment: |
|
|
* post an update to a service check
|
|
*params:
|
|
* check: the check name (e.g. "app.ok")
|
|
* hostName: the name of the host submitting the check
|
|
* status: one of `dogapi.OK`, `dogapi.WARNING`, `dogapi.CRITICAL` or `dogapi.UNKNOWN`
|
|
* parameters: |
|
|
* optional, an object containing any of the following
|
|
* * timestamp: POSIX timestamp for when the check happened
|
|
* * message: string message to accompany the check
|
|
* * tags: an array of "tag:value"'s associated with the check
|
|
* callback: function(err, res)
|
|
*example: |
|
|
* ```javascript
|
|
* const dogapi = require("dogapi");
|
|
* const options = {
|
|
* api_key: "api_key",
|
|
* app_key: "app_key"
|
|
* };
|
|
* dogapi.initialize(options);
|
|
* const check = "app.ok";
|
|
* const hostName = "some.machine";
|
|
* dogapi.serviceCheck.check(
|
|
* check, hostName, dogapi.WARNING, function(err, res){
|
|
* console.dir(res);
|
|
* });
|
|
* ```
|
|
*/
|
|
function check(checkName, hostName, status, parameters, callback) {
|
|
if (arguments.length < 5 && typeof arguments[3] === 'function') {
|
|
callback = parameters;
|
|
parameters = {};
|
|
}
|
|
|
|
if (typeof parameters !== 'object') {
|
|
parameters = {};
|
|
}
|
|
|
|
parameters.check = checkName;
|
|
parameters.host_name = hostName;
|
|
parameters.status = status;
|
|
|
|
const params = {
|
|
body: parameters
|
|
};
|
|
client.request('POST', '/check_run', params, callback);
|
|
}
|
|
|
|
return {
|
|
check,
|
|
getUsage() {
|
|
return [
|
|
' dogapi servicecheck check <check> <host> <status> [--time <timestamp>] [--message <message>] [--tags <tags>]'
|
|
];
|
|
},
|
|
getHelp() {
|
|
return [
|
|
'Service Check:',
|
|
' Subcommands:',
|
|
' check <check> <host> <status> add a new service check for <check> and <host> at level <status> (0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN)',
|
|
'',
|
|
' Options:',
|
|
' --time <timestamp> the POSIX timestamp to use for the check',
|
|
' --message <message> an optional message to accompany the check',
|
|
' --tags <tags> a comma separated list of "tag:value"\'s for the check'
|
|
];
|
|
},
|
|
handleCli(subcommand, args, callback) {
|
|
if (args._.length > 6) {
|
|
const parameters = {};
|
|
if (args.time) {
|
|
parameters.time = parseInt(args.time);
|
|
}
|
|
if (args.message) {
|
|
parameters.message = args.message;
|
|
}
|
|
if (args.tags) {
|
|
parameters.tags = args.tags.split(',');
|
|
}
|
|
check(args._[4], args._[5], parseInt(args._[6]), parameters, callback);
|
|
} else {
|
|
return callback('not enough arguments try `dogapi servicecheck --help` for help', false);
|
|
}
|
|
}
|
|
};
|
|
};
|