|
|
|
@ -455,6 +455,7 @@ dogapi.downtime.getAll(function(err, res){ |
|
|
|
<h2 class="bg-primary" style="text-indent:1rem">graph</h2></div> |
|
|
|
<ul class="nav nav-pills"> |
|
|
|
<li role"presentation"><a href="#graph-snapshot">snapshot</a></li> |
|
|
|
<li role"presentation"><a href="#graph-createEmbed">createEmbed</a></li> |
|
|
|
</ul> |
|
|
|
<div class="function row" id="graph-snapshot"> |
|
|
|
<h3 class="bg-info" style="text-indent:.5rem;padding:.5rem;margin-top:.5rem">snapshot(query, from, to, eventQuery, callback)</h3> |
|
|
|
@ -495,6 +496,66 @@ dogapi.graph.snapshot(query, from, to, function(err, res){ |
|
|
|
</code></pre> |
|
|
|
</div> |
|
|
|
</div> |
|
|
|
<div class="function row" id="graph-createEmbed"> |
|
|
|
<h3 class="bg-info" style="text-indent:.5rem;padding:.5rem;margin-top:.5rem">createEmbed(graph_json, options, options["timeframe"], options["size"], options["legend"], options["title"], callback)</h3> |
|
|
|
<div class="col-md-6"> |
|
|
|
<p>create an embed graph of a metric query</p> |
|
|
|
<h4>Parameters:</h4> |
|
|
|
<dl> |
|
|
|
<dt>graph_json</dt> |
|
|
|
<dd><p>The request array to pass create in the embed</p> |
|
|
|
</dd> |
|
|
|
<dt>options</dt> |
|
|
|
<dd><p><em>optional</em>, object of extra parameters to pass to the embed create (see options[*] params)</p> |
|
|
|
</dd> |
|
|
|
<dt>options["timeframe"]</dt> |
|
|
|
<dd><p><em>optional</em>, one of ("1_hour", "4_hours", "1_day", "2_days", and "1_week")</p> |
|
|
|
</dd> |
|
|
|
<dt>options["size"]</dt> |
|
|
|
<dd><p><em>optional</em>, one of ("small", "medium", "large", "xlarge")</p> |
|
|
|
</dd> |
|
|
|
<dt>options["legend"]</dt> |
|
|
|
<dd><p><em>optional</em>, "yes" or "no"</p> |
|
|
|
</dd> |
|
|
|
<dt>options["title"]</dt> |
|
|
|
<dd><p><em>optional</em>, the title of the embed</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("dogapi"); |
|
|
|
var options = { |
|
|
|
api_key: "api_key", |
|
|
|
app_key: "app_key" |
|
|
|
}; |
|
|
|
dogapi.initialize(options); |
|
|
|
var query = "system.cpu.idle{*}"; |
|
|
|
var graphJSON = { |
|
|
|
viz: "timeseries", |
|
|
|
requests: [ |
|
|
|
{ |
|
|
|
q: query, |
|
|
|
aggregator: "avg", |
|
|
|
conditional_formats: [], |
|
|
|
type: "area" |
|
|
|
} |
|
|
|
] |
|
|
|
} |
|
|
|
var options = { |
|
|
|
timeframe: "1_hour", |
|
|
|
size: "xlarge", |
|
|
|
legend: "yes", |
|
|
|
title: "my awesome embed" |
|
|
|
}; |
|
|
|
dogapi.graph.createEmbed(graphJSON, options, function(err, res){ |
|
|
|
console.dir(res); |
|
|
|
}); |
|
|
|
</code></pre> |
|
|
|
</div> |
|
|
|
</div> |
|
|
|
</section> |
|
|
|
<section id="host" class="col-sm-12"> |
|
|
|
<div class="row"> |
|
|
|
|