dogapi

What is dogapi?

The dogapi npm package is a client library for interacting with the Datadog API. It allows developers to programmatically manage Datadog resources such as events, metrics, tags, and more.

What are dogapi's main functionalities?

Send Metrics

This feature allows you to send custom metrics to Datadog. The code sample demonstrates how to initialize the dogapi client and send a metric named 'test.metric' with a value of 100 and a tag 'environment:test'.

const dogapi = require('dogapi');
const options = { api_key: 'YOUR_API_KEY', app_key: 'YOUR_APP_KEY' };
dogapi.initialize(options);
dogapi.metric.send('test.metric', 100, { tags: ['environment:test'] }, function(err, results) {
  if (err) console.error(err);
  else console.log(results);
});

Post Events

This feature allows you to post events to Datadog. The code sample shows how to create an event with a title 'Event Title' and text 'Event Text', along with a tag 'environment:test'.

const dogapi = require('dogapi');
const options = { api_key: 'YOUR_API_KEY', app_key: 'YOUR_APP_KEY' };
dogapi.initialize(options);
dogapi.event.create('Event Title', 'Event Text', { tags: ['environment:test'] }, function(err, results) {
  if (err) console.error(err);
  else console.log(results);
});

Manage Tags

This feature allows you to manage tags for your Datadog resources. The code sample demonstrates how to add tags 'tag1' and 'tag2' to a host named 'myhost'.

const dogapi = require('dogapi');
const options = { api_key: 'YOUR_API_KEY', app_key: 'YOUR_APP_KEY' };
dogapi.initialize(options);
dogapi.tag.create('host:myhost', ['tag1', 'tag2'], function(err, results) {
  if (err) console.error(err);
  else console.log(results);
});

Other packages similar to dogapi

datadog-metrics

The datadog-metrics package is another client library for sending metrics to Datadog. It is simpler and more focused on metrics compared to dogapi, which offers a broader range of functionalities including events and tags management.

node-dogstatsd

The node-dogstatsd package is a client for DogStatsD, which is Datadog's implementation of the StatsD protocol. It is used for sending metrics and events to Datadog, similar to dogapi, but it is more specialized for DogStatsD.

README

node-dogapi

Datadog API Node.JS Client modeled after Datadog/dogapi python client.

Official API Documentation: http://docs.datadoghq.com/api/

Installation

From NPM:

[sudo] npm install dogapi

From source:

git clone git://github.com/brettlangdon/node-dogapi.git
cd ./node-dogapi
npm install

Configuration

You will need your Datadog api key as well as an application key to use dogapi.

Keys can be found at: https://app.datadoghq.com/account/settings#api

The keys can be provided either as constructor parameters when creating an instance of dogapi as api_key and app_key or as the environment variables DD_API_KEY and DD_APP_KEY.

Constructor parameters:

var dogapi = require('dogapi');

var options = {
 api_key: 'YOUR_KEY_HERE',
 app_key: 'YOUR_KEY_HERE',
};

var app = new dogapi(options);

Environment Variables:

DD_API_KEY=YOUR_KEY_HERE DD_APP_KEY=YOUR_KEY_HERE node app.js

API

dogapi implements all available functions in the official datadog api, http://docs.datadoghq.com/api/.

• dogapi.stream(start, end, [[filter], callback])
  • function used to retrieve all events that have occured between
• dogapi.polling_stream(interval, [[filter], callback])
  • function used to continuously call stream for new events
• dogapi.get_event(event_id, callback)
  • method used to retrieve a single event's data
• dogapi.add_event(event, callback)
  • method used to add a new event to datadog
• dogapi.add_comment(comment, [callback])
  • method used to add a new comment to datadog
• dogapi.update_comment(comment_id, comment, callback)
  • method used to update a comment that already exists in datadog
• dogapi.delete_comment(comment_id, callback)
  • method used to remove a comment from datadog
• dogapi.add_alert(alert, [callback])
  • add a new alert to datadog
• dogapi.update_alert(alert_id, alert, [callback])
  • update an existing alert
• dogapi.get_alert(alert_id, [callback])
  • get the details of an alert from the given id
• dogapi.delete_alert(alert_id, [callback])
  • delete the given alert from datadog
• dogapi.get_all_alerts([callback])
  • get the details of all alerts in datadog
• dogapi.mute_alerts([callback])
  • mute all alerts
• dogapi.unmute_alerts([callback])
  • unmute all alerts
• dogapi.get_dashboard(dash_id, [callback])
  • method to get a single dashboard information
• dogapi.get_all_dashboards([callback])
  • method to retrieve all dashboards in datadog
• dogapi.create_dashboard(dashboard, [callback])
  • method used to create a new dashboard in datadog
• dogapi.update_dashboard(dash_id, dashboard, [callback])
  • method used to update the dashboard with the provided dash_id
• dogapi.delete_dashboard(dash_id, [callback])
  • method to remove a dashboard from datadog
• dogapi.get_screenboard(screen_id, [callback])
  • method to get a single screenboard information
• dogapi.get_all_screenboards([callback])
  • method to retrieve all screenboards in datadog
• dogapi.create_screenboard(screenboard, [callback])
  • method used to create a new screenboard in datadog
• dogapi.update_screenboard(screen_id, screenboard, [callback])
  • method used to update the screenboard with the provided screen_id
• dogapi.delete_screenboard(screen_id, [callback])
  • method to remove a screenboard from datadog
• dogapi.search(query, [callback])
  • method used to query the api for metrics or hosts
• dogapi.add_metric(metric, [callback])
  • method used to add a single metric to datadog
• dogapi.add_metrics(metrics, [callback])
  • method used to add multiple metrics to datadog
• dogapi.all_tags([[source], callback])
  • method to get all the tags in datadog
• dogapi.host_tags(host, [[source], callback])
  • method to get the tags associated with a given host
• dogapi.host_tags_by_source(host, [[source], callback])
  • method to return the tags associated with a host, arranged by source
• dogapi.add_tags(host, tags, [[source], callback])
  • add new tags to given host
• dogapi.update_tags(host, tags, [[source], callback])
  • update the tags associated with the given host
• dogapi.detach_tags(host, [[source], callback])
  • method to remove tags for a given host
• dogapi.add_snapshot(snapshot, [callback])
  • method used to take a snapshot of a datadog graph

Sample Usage:

Example: get all events since this time yesterday:

var dogapi = require('dogapi');

var options = {
  api_key: 'YOUR_KEY_HERE',
  app_key: 'YOUR KEY_HERE',
};

var api = new dogapi(options);

var end = parseInt(new Date().getTime() / 1000);
var start = end - 86400;

api.stream(start, end, function(error, result, status_code){
  if(error){
    console.log('Error: ', error);
    console.log('Status Code: ', status_code);
    return;
  }

  result['events'].forEach(function(event){
    console.log(event['id'] + ': ' + event['title']);
  });
});

License

The MIT License (MIT) Copyright (c) 2013 Brett Langdon [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.