@ -20,6 +20,8 @@ document.addEventListener("DOMContentLoaded", function(){hljs.initHighlightingOn
< / li > < / li >
< li role = "" > < a href = "#downtime" > downtime< / a > < li role = "" > < a href = "#downtime" > downtime< / a >
< / li > < / li >
< li role = "" > < a href = "#embed" > embed< / a >
< / li >
< li role = "" > < a href = "#event" > event< / a > < li role = "" > < a href = "#event" > event< / a >
< / li > < / li >
< li role = "" > < a href = "#graph" > graph< / a > < li role = "" > < a href = "#graph" > graph< / a >
@ -317,6 +319,138 @@ dogapi.downtime.getAll(function(err, res){
< / div > < / div >
< / div > < / div >
< / section > < / section >
< section id = "embed" class = "col-sm-12" >
< div class = "row" >
< h2 class = "bg-primary" style = "text-indent:1rem" > embed< / h2 > < / div >
< ul class = "nav nav-pills" >
< li role " presentation " > < a href = "#embed-create" > create< / a > < / li >
< li role " presentation " > < a href = "#embed-revoke" > revoke< / a > < / li >
< li role " presentation " > < a href = "#embed-getAll" > getAll< / a > < / li >
< li role " presentation " > < a href = "#embed-get" > get< / a > < / li >
< / ul >
< div class = "function row" id = "embed-create" >
< h3 class = "bg-info" style = "text-indent:.5rem;padding:.5rem;margin-top:.5rem" > create(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.embed.create(graphJSON, options, function(err, res){
console.dir(res);
});
< / code > < / pre >
< / div >
< / div >
< div class = "function row" id = "embed-revoke" >
< h3 class = "bg-info" style = "text-indent:.5rem;padding:.5rem;margin-top:.5rem" > revoke(embedId, callback)< / h3 >
< div class = "col-md-6" >
< p > delete an embed with a specific id< / p >
< h4 > Parameters:< / h4 >
< dl >
< dt > embedId< / dt >
< dd > < p > the id of the embed to delete< / 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 embedid = " foo" ;
dogapi.embed.revoke(embedid, function(err, res){
console.dir(res);
});
< / code > < / pre >
< / div >
< / div >
< div class = "function row" id = "embed-getAll" >
< h3 class = "bg-info" style = "text-indent:.5rem;padding:.5rem;margin-top:.5rem" > getAll(callback)< / h3 >
< div class = "col-md-6" >
< p > get all embeds from datadog< / p >
< h4 > Parameters:< / h4 >
< dl >
< dt > callback< / dt >
< dd > < p > function(err, res)< / p >
< / dd >
< / dl >
< / div >
< div class = "col-md-6" >
< pre > < code class = "lang-javascript" > dogapi.embed.getAll(function(err, res){
console.dir(res);
});
< / code > < / pre >
< / div >
< / div >
< div class = "function row" id = "embed-get" >
< h3 class = "bg-info" style = "text-indent:.5rem;padding:.5rem;margin-top:.5rem" > get(embedId, callback)< / h3 >
< div class = "col-md-6" >
< p > get a single embed< / p >
< h4 > Parameters:< / h4 >
< dl >
< dt > embedId< / dt >
< dd > < p > the id of the embed to get< / 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 embedId = " foo" ;
dogapi.embed.get(embedId, function(err, res){
console.dir(res);
});
< / code > < / pre >
< / div >
< / div >
< / section >
< section id = "event" class = "col-sm-12" > < section id = "event" class = "col-sm-12" >
< div class = "row" > < div class = "row" >
< h2 class = "bg-primary" style = "text-indent:1rem" > event< / h2 > < / div > < h2 class = "bg-primary" style = "text-indent:1rem" > event< / h2 > < / div >
@ -455,7 +589,6 @@ dogapi.downtime.getAll(function(err, res){
< h2 class = "bg-primary" style = "text-indent:1rem" > graph< / h2 > < / div > < h2 class = "bg-primary" style = "text-indent:1rem" > graph< / h2 > < / div >
< ul class = "nav nav-pills" > < ul class = "nav nav-pills" >
< li role " presentation " > < a href = "#graph-snapshot" > snapshot< / a > < / li > < li role " presentation " > < a href = "#graph-snapshot" > snapshot< / a > < / li >
< li role " presentation " > < a href = "#graph-createEmbed" > createEmbed< / a > < / li >
< / ul > < / ul >
< div class = "function row" id = "graph-snapshot" > < 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 > < h3 class = "bg-info" style = "text-indent:.5rem;padding:.5rem;margin-top:.5rem" > snapshot(query, from, to, eventQuery, callback)< / h3 >
@ -496,66 +629,6 @@ dogapi.graph.snapshot(query, from, to, function(err, res){
< / code > < / pre > < / code > < / pre >
< / div > < / div >
< / 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 >
< section id = "host" class = "col-sm-12" > < section id = "host" class = "col-sm-12" >
< div class = "row" > < div class = "row" >
@ -687,7 +760,7 @@ or an array of <code>[timestamp, value]</code> elements (e.g. <code>[[now, 50],
< ul > < ul >
< li > host: the host source of the metric< / li > < li > host: the host source of the metric< / li >
< li > tags: array of " tag:value" ' s to use for the metric< / li > < li > tags: array of " tag:value" ' s to use for the metric< / li >
< li > metric_type|type: which metric type to use (" gauge" or " counter " ) [default: gauge]< / li >
< li > metric_type|type: which metric type to use (" gauge" or " count" ) [default: gauge]< / li >
< / ul > < / ul >
< / dd > < / dd >
< dt > callback< / dt > < dt > callback< / dt >
@ -712,7 +785,7 @@ var now = parseInt(new Date().getTime() / 1000);
dogapi.metric.send(" my.metric" , [[now, 1000]], function(err, results){ dogapi.metric.send(" my.metric" , [[now, 1000]], function(err, results){
console.dir(results); console.dir(results);
}); });
dogapi.metric.send(" my.counter" , 5, {type: " counter " }, function(err, results){
dogapi.metric.send(" my.counter" , 5, {type: " count" }, function(err, results){
console.dir(results); console.dir(results);
}); });
< / code > < / pre > < / code > < / pre >
@ -731,7 +804,7 @@ dogapi.metric.send("my.counter", 5, {type: "counter"}, funct
< li > points: a single data point (e.g. < code > 50< / code > ), an array of data points (e.g. < code > [50, 100]< / code > ) or an array of < code > [timestamp, value]< / code > elements (e.g. < code > [[now, 50], [now, 100]]< / code > )< / li > < li > points: a single data point (e.g. < code > 50< / code > ), an array of data points (e.g. < code > [50, 100]< / code > ) or an array of < code > [timestamp, value]< / code > elements (e.g. < code > [[now, 50], [now, 100]]< / code > )< / li >
< li > tags: an array of " tag:value" ' s< / li > < li > tags: an array of " tag:value" ' s< / li >
< li > host: the source hostname to use for the metrics< / li > < li > host: the source hostname to use for the metrics< / li >
< li > metric_type|type: the type of metric to use (" gauge" or " counter " ) [default: gauge]< / li >
< li > metric_type|type: the type of metric to use (" gauge" or " count" ) [default: gauge]< / li >
< / ul > < / ul >
< / dd > < / dd >
< dt > callback< / dt > < dt > callback< / dt >
