dogapi
Advanced tools
Package description
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.
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);
});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.
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
Datadog API Node.JS Client.
Official Datadog API Documentation: http://docs.datadoghq.com/api/
dogapi API Docs: http://brettlangdon.github.io/node-dogapi/
note dogapi has been updated to v1.0.0 the api has changed quiet a
bit please be sure to review the new api before upgrading.
From NPM:
[sudo] npm install dogapi
From source:
git clone git://github.com/brettlangdon/node-dogapi.git
cd ./node-dogapi
npm install
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
var dogapi = require("dogapi");
var options = {
api_key: "YOUR_KEY_HERE",
app_key: "YOUR_KEY_HERE",
};
dogapi.initialize(options);
If you are behind a proxy you need to a proxy agent. You can use the https proxy agent from http://blog.vanamco.com/proxy-requests-in-node-js/ if you like. To configure dogapi with the agent just add it to the options.
var dogapi = require("dogapi");
//Code from http://blog.vanamco.com/proxy-requests-in-node-js/
var HttpsProxyAgent = require("./httpsproxyagent");
var agent = new HttpsProxyAgent({
proxyHost: "MY_PROXY_HOST",
proxyPort: 3128
});
var options = {
api_key: "YOUR_KEY_HERE",
app_key: "YOUR_KEY_HERE",
proxy_agent: agent
};
dogapi.initialize(options);
dogapi now ships with a command line interface dogapi. To use it you
will need a .dogapirc file which meets the standards of
https://github.com/dominictarr/rc
The config file must contain both api_key and app_key keys (you can find
your datadog api and app keys here
https://app.datadoghq.com/account/settings#api)
Example:
{
"api_key": "<API_KEY>",
"app_key": "<APP_KEY>"
}
Please run dogapi --help to see current usage documentation for the tool.
Every api method available in dogapi is exposed via the cli tool.
The MIT License (MIT) Copyright (c) 2013 Brett Langdon brett@blangdon.com
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.
FAQs
Unknown package
The npm package dogapi receives a total of 844,367 weekly downloads. As such, dogapi popularity was classified as popular.
We found that dogapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cyber insurance rates are dropping as the market matures, according to a new report projecting global premiums to reach $43 billion by 2030, driven by international market uptake and growth in the SME sector.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.