granicus.if.org Git - icinga2/blob - plugins/check_nscp_api.cpp

   1 /******************************************************************************
   2 * Icinga 2                                                                   *
   3 * Copyright (C) 2012-2017 Icinga Development Team (https://www.icinga.com/)  *
   4 *                                                                            *
   5 * This program is free software; you can redistribute it and/or              *
   6 * modify it under the terms of the GNU General Public License                *
   7 * as published by the Free Software Foundation; either version 2             *
   8 * of the License, or (at your option) any later version.                     *
   9 *                                                                            *
  10 * This program is distributed in the hope that it will be useful,            *
  11 * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
  12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
  13 * GNU General Public License for more details.                               *
  14 *                                                                            *
  15 * You should have received a copy of the GNU General Public License          *
  16 * along with this program; if not, write to the Free Software Foundation     *
  17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
  18 ******************************************************************************/
  19
  20 #define VERSION "1.0.0"
  21
  22 #include "remote/httpclientconnection.hpp"
  23 #include "remote/httprequest.hpp"
  24 #include "remote/url-characters.hpp"
  25 #include "base/application.hpp"
  26 #include "base/json.hpp"
  27 #include "base/string.hpp"
  28 #include "base/exception.hpp"
  29 #include <boost/program_options.hpp>
  30 #include <boost/algorithm/string/split.hpp>
  31 #include <iostream>
  32
  33 using namespace icinga;
  34 namespace po = boost::program_options;
  35
  36 bool l_Debug = false;
  37
  38 /*
  39  * This function is called by an 'HttpRequest' once the server answers. After doing a short check on the 'response' it
  40  * decodes it to a Dictionary and then tells 'QueryEndpoint()' that it's done
  41  */
  42 static void ResultHttpCompletionCallback(const HttpRequest& request, HttpResponse& response, bool& ready,
  43     boost::condition_variable& cv, boost::mutex& mtx, Dictionary::Ptr& result)
  44 {
  45         String body;
  46         char buffer[1024];
  47         size_t count;
  48
  49         while ((count = response.ReadBody(buffer, sizeof(buffer))) > 0)
  50                 body += String(buffer, buffer + count);
  51
  52         if (l_Debug) {
  53                 std::cout << "Received answer\n"
  54                     << "\tHTTP code: " << response.StatusCode << "\n"
  55                     << "\tHTTP message: '" << response.StatusMessage << "'\n"
  56                     << "\tHTTP body: '" << body << "'.\n";
  57         }
  58
  59         // Only try to decode the body if the 'HttpRequest' was successful
  60         if (response.StatusCode != 200)
  61                 result = Dictionary::Ptr();
  62         else
  63                 result = JsonDecode(body);
  64
  65         // Unlock our mutex, set ready and notify 'QueryEndpoint()'
  66         boost::mutex::scoped_lock lock(mtx);
  67         ready = true;
  68         cv.notify_all();
  69 }
  70
  71 /*
  72  * This function takes all the information required to query an nscp instance on
  73  * 'host':'port' with 'password'. The String 'endpoint' contains the specific
  74  * query name and all the arguments formatted as an URL.
  75  */
  76 static Dictionary::Ptr QueryEndpoint(const String& host, const String& port, const String& password,
  77     const String& endpoint)
  78 {
  79         HttpClientConnection::Ptr m_Connection = new HttpClientConnection(host, port, true);
  80
  81         try {
  82                 bool ready = false;
  83                 boost::condition_variable cv;
  84                 boost::mutex mtx;
  85                 Dictionary::Ptr result;
  86                 std::shared_ptr<HttpRequest> req = m_Connection->NewRequest();
  87                 req->RequestMethod = "GET";
  88
  89                 // Url() will call Utillity::UnescapeString() which will thrown an exception if it finds a lonely %
  90                 req->RequestUrl = new Url(endpoint);
  91                 req->AddHeader("password", password);
  92                 if (l_Debug)
  93                         std::cout << "Sending request to 'https://" << host << ":" << port << req->RequestUrl->Format() << "'\n";
  94
  95                 // Submits the request. The 'ResultHttpCompletionCallback' is called once the HttpRequest receives an answer,
  96                 // which then sets 'ready' to true
  97                 m_Connection->SubmitRequest(req, std::bind(ResultHttpCompletionCallback, _1, _2,
  98                         boost::ref(ready), boost::ref(cv), boost::ref(mtx), boost::ref(result)));
  99
 100                 // We need to spinlock here because our 'HttpRequest' works asynchronous
 101                 boost::mutex::scoped_lock lock(mtx);
 102                 while (!ready) {
 103                         cv.wait(lock);
 104                 }
 105
 106                 return result;
 107         }
 108         catch (const std::exception& ex) {
 109                 // Exceptions should only happen in extreme edge cases we can't recover from
 110                 std::cout << "Caught exception: " << DiagnosticInformation(ex, false) << '\n';
 111                 return Dictionary::Ptr();
 112         }
 113 }
 114
 115 /*
 116  * Takes a Dictionary 'result' and constructs an icinga compliant output string.
 117  * If 'result' is not in the expected format it returns 3 ("UNKNOWN") and prints an informative, icinga compliant,
 118  * output string.
 119  */
 120 static int FormatOutput(const Dictionary::Ptr& result)
 121 {
 122         if (!result) {
 123                 std::cout << "UNKNOWN: No data received.\n";
 124                 return 3;
 125         }
 126
 127         if (l_Debug)
 128                 std::cout << "\tJSON Body:\n" << result->ToString() << '\n';
 129
 130         Array::Ptr payloads = result->Get("payload");
 131         if (!payloads) {
 132                 std::cout << "UNKNOWN: Answer format error: Answer is missing 'payload'.\n";
 133                 return 3;
 134         }
 135
 136         if (payloads->GetLength() == 0) {
 137                 std::cout << "UNKNOWN: Answer format error: 'payload' was empty.\n";
 138                 return 3;
 139         }
 140
 141         if (payloads->GetLength() > 1) {
 142                 std::cout << "UNKNOWN: Answer format error: Multiple payloads are not supported.";
 143                 return 3;
 144         }
 145
 146         Dictionary::Ptr payload;
 147         try {
 148                 payload = payloads->Get(0);
 149         } catch (const std::exception&) {
 150                 std::cout << "UNKNOWN: Answer format error: 'payload' was not a Dictionary.\n";
 151                 return 3;
 152         }
 153
 154         Array::Ptr lines;
 155         try {
 156                 lines = payload->Get("lines");
 157         } catch (const std::exception&) {
 158                 std::cout << "UNKNOWN: Answer format error: 'payload' is missing 'lines'.\n";
 159                 return 3;
 160         }
 161
 162         if (!lines) {
 163                 std::cout << "UNKNOWN: Answer format error: 'lines' is Null.\n";
 164                 return 3;
 165         }
 166
 167         std::stringstream ssout;
 168         ObjectLock olock(lines);
 169
 170         for (const Value& vline : lines) {
 171                 Dictionary::Ptr line;
 172                 try {
 173                         line = vline;
 174                 } catch (const std::exception&) {
 175                         std::cout << "UNKNOWN: Answer format error: 'lines' entry was not a Dictionary.\n";
 176                         return 3;
 177                 }
 178                 if (!line) {
 179                         std::cout << "UNKNOWN: Answer format error: 'lines' entry was Null.\n";
 180                         return 3;
 181                 }
 182
 183                 ssout << payload->Get("command") << ' ' << line->Get("message") << " | ";
 184
 185                 if (!line->Contains("perf")) {
 186                         ssout << '\n';
 187                         break;
 188                 }
 189
 190                 Array::Ptr perfs = line->Get("perf");
 191                 ObjectLock olock(perfs);
 192
 193                 for (const Dictionary::Ptr& perf : perfs) {
 194                         ssout << "'" << perf->Get("alias") << "'=";
 195                         Dictionary::Ptr values = perf->Contains("int_value") ? perf->Get("int_value") : perf->Get("float_value");
 196                         ssout << values->Get("value") << values->Get("unit") << ';' << values->Get("warning") << ';' << values->Get("critical");
 197
 198                         if (values->Contains("minimum") || values->Contains("maximum")) {
 199                                 ssout << ';';
 200
 201                                 if (values->Contains("minimum"))
 202                                         ssout << values->Get("minimum");
 203
 204                                 if (values->Contains("maximum"))
 205                                         ssout << ';' << values->Get("maximum");
 206                         }
 207
 208                         ssout << ' ';
 209                 }
 210
 211                 ssout << '\n';
 212         }
 213
 214         //TODO: Fix
 215         String state = static_cast<String>(payload->Get("result")).ToUpper();
 216         int creturn = state == "OK" ? 0 :
 217                 state == "WARNING" ? 1 :
 218                 state == "CRITICAL" ? 2 :
 219                 state == "UNKNOWN" ? 3 : 4;
 220
 221         if (creturn == 4) {
 222                 std::cout << "check_nscp UNKNOWN Answer format error: 'result' was not a known state.\n";
 223                 return 3;
 224         }
 225
 226         std::cout << ssout.rdbuf();
 227         return creturn;
 228 }
 229
 230 /*
 231  *  Process arguments, initialize environment and shut down gracefully.
 232  */
 233 int main(int argc, char **argv)
 234 {
 235         po::variables_map vm;
 236         po::options_description desc("Options");
 237
 238         desc.add_options()
 239                 ("help,h", "Print usage message and exit")
 240                 ("version,V", "Print version and exit")
 241                 ("debug,d", "Verbose/Debug output")
 242                 ("host,H", po::value<std::string>()->required(), "REQUIRED: NSCP API Host")
 243                 ("port,P", po::value<std::string>()->default_value("8443"), "NSCP API Port (Default: 8443)")
 244                 ("password", po::value<std::string>()->required(), "REQUIRED: NSCP API Password")
 245                 ("query,q", po::value<std::string>()->required(), "REQUIRED: NSCP API Query endpoint")
 246                 ("arguments,a", po::value<std::vector<std::string>>()->multitoken(), "NSCP API Query arguments for the endpoint");
 247
 248         po::basic_command_line_parser<char> parser(argc, argv);
 249
 250         try {
 251                 po::store(
 252                         parser
 253                         .options(desc)
 254                         .style(
 255                                 po::command_line_style::unix_style |
 256                                 po::command_line_style::allow_long_disguise)
 257                         .run(),
 258                         vm);
 259
 260                 if (vm.count("version")) {
 261                         std::cout << "Version: " << VERSION << '\n';
 262                         Application::Exit(0);
 263                 }
 264
 265                 if (vm.count("help")) {
 266                         std::cout << argv[0] << " Help\n\tVersion: " << VERSION << '\n';
 267                         std::cout << "check_nscp_api is a program used to query the NSClient++ API.\n";
 268                         std::cout << desc;
 269                         std::cout << "For detailed information on possible queries and their arguments refer to the NSClient++ documentation.\n";
 270                         Application::Exit(0);
 271                 }
 272
 273                 vm.notify();
 274         } catch (std::exception& e) {
 275                 std::cout << e.what() << '\n' << desc << '\n';
 276                 Application::Exit(3);
 277         }
 278
 279         if (vm.count("debug")) {
 280                 l_Debug = true;
 281         }
 282
 283         // Create the URL string and escape certain characters since Url() follows RFC 3986
 284         String endpoint = "/query/" + vm["query"].as<std::string>();
 285         if (!vm.count("arguments"))
 286                 endpoint += '/';
 287         else {
 288                 endpoint += '?';
 289                 for (const String& argument : vm["arguments"].as<std::vector<std::string>>()) {
 290                         String::SizeType pos = argument.FindFirstOf("=");
 291                         if (pos == String::NPos)
 292                                 endpoint += Utility::EscapeString(argument, ACQUERY_ENCODE, false);
 293                         else {
 294                                 String key = argument.SubStr(0, pos);
 295                                 String val = argument.SubStr(pos + 1);
 296                                 endpoint += Utility::EscapeString(key, ACQUERY_ENCODE, false) + "=" + Utility::EscapeString(val, ACQUERY_ENCODE, false);
 297                         }
 298                         endpoint += '&';
 299                 }
 300         }
 301
 302         // This needs to happen for HttpRequest to work
 303         Application::InitializeBase();
 304
 305         Dictionary::Ptr result = QueryEndpoint(vm["host"].as<std::string>(), vm["port"].as<std::string>(),
 306             vm["password"].as<std::string>(), endpoint);
 307
 308         // Application::Exit() is the clean way to exit after calling InitializeBase()
 309         Application::Exit(FormatOutput(result));
 310         return 255;
 311 }