@datadog/datadog-api-client
Advanced tools
@datadog/datadog-api-client is an official Node.js client library for interacting with the Datadog API. It allows developers to programmatically manage and interact with Datadog's monitoring, logging, and tracing services. This includes creating and managing dashboards, monitors, events, and more.
Create a Dashboard
This code sample demonstrates how to create a new dashboard in Datadog using the @datadog/datadog-api-client package.
const { v1: datadog } = require('@datadog/datadog-api-client');
const configuration = datadog.createConfiguration();
const apiInstance = new datadog.DashboardsApi(configuration);
const params = {
body: {
title: 'Example-Dashboard',
widgets: [],
layoutType: 'ordered',
description: 'A sample dashboard',
isReadOnly: false,
notifyList: []
}
};
apiInstance.createDashboard(params).then((data) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}).catch((error) => {
console.error(error);
});Create a Monitor
This code sample demonstrates how to create a new monitor in Datadog using the @datadog/datadog-api-client package.
const { v1: datadog } = require('@datadog/datadog-api-client');
const configuration = datadog.createConfiguration();
const apiInstance = new datadog.MonitorsApi(configuration);
const params = {
body: {
name: 'Example-Monitor',
type: 'metric alert',
query: 'avg(last_5m):avg:system.cpu.user{host:host0} > 75',
message: 'CPU usage is high on host0',
tags: ['env:production'],
options: {
thresholds: {
critical: 75
}
}
}
};
apiInstance.createMonitor(params).then((data) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}).catch((error) => {
console.error(error);
});Post an Event
This code sample demonstrates how to post a new event to Datadog using the @datadog/datadog-api-client package.
const { v1: datadog } = require('@datadog/datadog-api-client');
const configuration = datadog.createConfiguration();
const apiInstance = new datadog.EventsApi(configuration);
const params = {
body: {
title: 'Example-Event',
text: 'An example event for Datadog',
tags: ['env:production'],
alertType: 'info'
}
};
apiInstance.createEvent(params).then((data) => {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}).catch((error) => {
console.error(error);
});The 'newrelic' package is the official Node.js client for New Relic, a competitor to Datadog. It provides similar functionalities for monitoring and managing application performance, but is specific to New Relic's ecosystem.
The 'prom-client' package is a client for Prometheus, an open-source monitoring and alerting toolkit. While it doesn't offer the same breadth of features as Datadog, it is widely used for metrics collection and monitoring in cloud-native environments.
The 'elastic-apm-node' package is the official Node.js agent for Elastic APM, part of the Elastic Stack. It provides performance monitoring and error tracking for Node.js applications, similar to Datadog's APM features.
This repository contains a Node.js API client for the Datadog API. The code is generated using openapi-generator and apigentools.
The package is under @datadog/datadog-api-client and can be installed through NPM or Yarn:
# NPM
npm install @datadog/datadog-api-client
# Yarn
yarn add @datadog/datadog-api-client
Here's an example getting a monitor:
import { v1 } from '@datadog/datadog-api-client';
const configuration = v1.createConfiguration();
const apiInstance = new v1.MonitorsApi(configuration);
let params:v1.MonitorsApiGetMonitorRequest = {
// number | The ID of the monitor
monitorId: 1,
};
apiInstance.getMonitor(params).then((data:any) => {
console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));
When talking to a different server, like the eu instance, change the server variables:
import { v1 } from '@datadog/datadog-api-client';
const configuration = v1.createConfiguration();
v1.setServerVariables(configuration, {
site: "datadoghq.eu"
});
If you want to disable GZIP compressed responses, set the compress flag
on your configuration options:
import { v1 } from '@datadog/datadog-api-client';
const configurationOpts = {
httpConfig: {
compress: false
},
};
const configuration = v1.createConfiguration(configurationOpts);
Documentation for API endpoints can be found under the docs subdirectories, in v1 and v2.
As most of the code in this repository is generated, we will only accept PRs for files that are not modified by our code-generation machinery (changes to the generated files would get overwritten). We happily accept contributions to files that are not autogenerated, such as tests and development tooling.
1.0.0-beta.6 / 2021-11-03
available_values property to template variables schema. See #258.follow_redirects options to test request in Synthetics. See #267.servername property to SSL Synthetics tests request. See #305.renotify_occurrences and renotify_statuses monitor options. See #315.type and is_template properties to notebooks. See #317.metrics_collection_enabled, cspm_resource_collection_enabled and resource_collection_enabled to AWS integration request. See #319.apm_stats_query property to DistributionWidgetRequest. See #328.IncidentFieldAttributesMultipleValue can be nullable. See #304.FAQs
OpenAPI client for Datadog APIs
The npm package @datadog/datadog-api-client receives a total of 296,513 weekly downloads. As such, @datadog/datadog-api-client popularity was classified as popular.
We found that @datadog/datadog-api-client demonstrated a healthy version release cadence and project activity because the last version was released less than 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
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.