Merge pull request #25 from brettlangdon/dev/search.api

Add support for the /search endpoint

index.html

@@ -34,6 +34,8 @@ document.addEventListener("DOMContentLoaded", function(){hljs.initHighlightingOn
 </li>
 <li role=""><a href="#screenboard">screenboard</a>
 </li>
+<li role=""><a href="#search">search</a>
+</li>
 <li role=""><a href="#serviceCheck">serviceCheck</a>
 </li>
 <li role=""><a href="#tag">tag</a>
@@ -1217,6 +1219,41 @@ dogapi.screenboard.share(1234, function(err, res){
 </div>
 </div>
 </section>
+<section id="search" class="col-sm-12">
+<div class="row">
+<h2 class="bg-primary" style="text-indent:1rem">search</h2></div>
+<ul class="nav nav-pills">
+<li role"presentation"><a href="#search-query">query</a></li>
+</ul>
+<div class="function row" id="search-query">
+<h3 class="bg-info" style="text-indent:.5rem;padding:.5rem;margin-top:.5rem">query(query, callback)</h3>
+<div class="col-md-6">
+<p>search for metrics and hosts from the past 24 hours</p>
+<h4>Parameters:</h4>
+<dl>
+<dt>query</dt>
+<dd><p>the seach query to perform (e.g. &quot;app1&quot; or &quot;hosts:app1&quot; or &quot;metrics:response&quot;)</p>
+</dd>
+<dt>callback</dt>
+<dd><p>function(err, res)</p>
+</dd>
+</dl>
+</div>
+<div class="col-md-6">
+<pre><code class="lang-javascript">var dogapi = require(&quot;dogapi&quot;);
+var options = {
+  api_key: &quot;api_key&quot;,
+  app_key: &quot;app_key&quot;
+};
+dogapi.initialize(options);
+var query = &quot;app&quot;;
+dogapi.search.query(query, function(err, res){
+  console.dir(res);
+});
+</code></pre>
+</div>
+</div>
+</section>
 <section id="serviceCheck" class="col-sm-12">
 <div class="row">
 <h2 class="bg-primary" style="text-indent:1rem">serviceCheck</h2></div>

lib/api/index.js

@@ -8,6 +8,7 @@ var api = {
     metric: require("./metric"),
     monitor: require("./monitor"),
     screenboard: require("./screenboard"),
+    search: require("./search"),
     serviceCheck: require("./serviceCheck"),
     tag: require("./tag"),
     timeboard: require("./timeboard"),

lib/api/search.js

@@ -0,0 +1,53 @@
+var client = require("../client");
+
+/*section: search
+ *comment: |
+ *  search for metrics and hosts from the past 24 hours
+ *params:
+ *  query: the seach query to perform (e.g. "app1" or "hosts:app1" or "metrics:response")
+ *  callback: function(err, res)
+ *example: |
+ *  ```javascript
+ *  var dogapi = require("dogapi");
+ *  var options = {
+ *    api_key: "api_key",
+ *    app_key: "app_key"
+ *  };
+ *  dogapi.initialize(options);
+ *  var query = "app";
+ *  dogapi.search.query(query, function(err, res){
+ *    console.dir(res);
+ *  });
+ *  ```
+ */
+function query(query, callback){
+    var params = {
+        query: {
+            q: query
+        }
+    };
+    client.request("GET", "/search", params, callback);
+}
+
+module.exports = {
+    query: query,
+    getUsage: function(){
+        return [
+            "  dogapi search query <query>"
+        ];
+    },
+    getHelp: function(){
+        return [
+            "Search:",
+            "  Subcommands:",
+            "    query <query>    search for hosts and metrics from the last 24 hours"
+        ];
+    },
+    handleCli: function(subcommand, args, callback){
+        if(subcommand === "query" && args._.length > 4){
+            query(args._[4], callback);
+        } else {
+            callback("unknown subcommand or arguments try `dogapi search --help` for help", false);
+        }
+    }
+};