You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/developers/authorization/oauth2_in_datadog.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ This page provides a step-by-step overview on how to implement the OAuth protoco
49
49
50
50
If the `API_KEYS_WRITE` scope has not been added to your client, this step fails. This endpoint generates an API Key that is only shown once, and cannot be re-generated unless the user deletes it within their Datadog account. **Store this value in a secure database or location**.
51
51
52
-
For more information about OAuth client creation, testing and publishing, see [OAuth for Datadog Integrations][5].
52
+
For more information about OAuth client creation, testing and publishing, see [Create an API-based integration][5].
53
53
54
54
### Initiate authorization from a third-party location
55
55
@@ -101,7 +101,7 @@ The [PKCE protocol][11] integrates with the authorization code grant flow by com
text: Learn how to sell an integration on the Datadog Marketplace
17
-
- link: /developers/
18
-
tag: Documentation
19
-
text: Learn how to develop on the Datadog platform
20
-
title: Build an Integration
15
+
text: Create an offering on the Datadog Marketplace
16
+
title: Datadog Integrations
17
+
type: documentation
21
18
---
22
19
## Overview
23
20
24
-
This page walks you through how Technology Partners can [build an integration](#create-a-datadog-integration) using the [Datadog Agent][11] or the [Datadog API][12], and list their offering on the **Integrations** or **Marketplace** page.
21
+
This page outlines what an integration is, and the general process of building an integration at Datadog using the Integration Developer Platform.
25
22
26
-
{{< tabs >}}
27
-
{{% tab "Integrations" %}}
23
+
## What are integrations?
28
24
29
-
The [Integrations page][101] includes integrations built by both Datadog and our Technology Partners, available at _no cost_ to Datadog customers.
25
+
Integrations enable third parties to send observability data—such as metrics, logs, traces, or events—into Datadog. Integrations include out-of-the-box (OOTB) dashboards, monitors, and other content to help users visualize and analyze their data.
The [Marketplace page][101] is a commercial platform for Technology Partners to _sell_ a variety of offerings, including integrations, software licenses, and professional services to Datadog customers.
By creating an integration, you can achieve the following benefits:
50
30
@@ -55,13 +35,33 @@ Decrease mean-time-to-resolution (MTTR) for customers
55
35
: When a customer's account is enriched with data from an integration, they are able to see a broader view of their entire stack, allowing them to debug and remediate issues more quickly.
56
36
57
37
Increase adoption and visibility
58
-
: Ensuring native functionality for Datadog reduces friction to adoption, and displaying a tile on the [Integrations page][10] or the [Marketplace page][17] provides key visibility to all of Datadog's customers.
38
+
: Ensuring native functionality for Datadog reduces friction to adoption, and displaying a tile on the [Integrations page][2] or the [Marketplace page][3] provides key visibility to all of Datadog's customers.
59
39
60
-
## Get started
40
+
## What is an integration tile?
61
41
62
-
### Join the Datadog partner network
42
+
An integration tile acts as a discovery and installation point for customers. It includes:
43
+
* Information about your offering
44
+
* Setup instructions
45
+
* Installation or purchase options
46
+
* Out-of-the-box dashboards and additional content
47
+
48
+
Integration tiles are a component of integrations at Datadog.
49
+
50
+
## Requirements of an official integration
51
+
52
+
All official integrations must include the following:
53
+
* Telemetry sent to Datadog
54
+
* An out-of-the-box integration dashboard
55
+
* Images on your tile
56
+
* OAuth (for API integrations only)
57
+
* A log pipeline (for log integrations only)
58
+
* Recommended Monitor (for integrations that sends in metrics)
63
59
64
-
Before listing an integration on Datadog, first apply to the [Datadog Partner Network's][5]**Technology Partner** track. Once your application has been approved, you can begin developing your integration.
60
+
## Getting started
61
+
62
+
### Join the Datadog Partner Network
63
+
64
+
Before listing an integration on Datadog, first apply to the [Datadog Partner Network's][1]**Technology Partner** track. Once your application has been approved, you can begin developing your integration.
65
65
66
66
### Request a sandbox account
67
67
@@ -71,66 +71,88 @@ All Technology Partners can request a dedicated Datadog sandbox account to help
71
71
72
72
To request a sandbox account:
73
73
74
-
1. Login to the [Datadog Partner Portal][5].
74
+
1. Login to the [Datadog Partner Portal][1].
75
75
2. On your personal homepage, click on the **Learn More** button under **Sandbox Access**.
76
76
3. Select **Request Sandbox Upgrade**.
77
77
78
-
Creating a developer sandbox may take up to one or two business days. Once your sandbox is created, you can [invite new members from your organization][6] to collaborate with.
78
+
Creating a developer sandbox may take up to one or two business days. Once your sandbox is created, you can [invite new members from your organization][7] to collaborate with.
79
+
80
+
### Building an integration overview
81
+
82
+
Follow these steps to create a new integration with Datadog.
79
83
80
-
### Explore learning resources
84
+
1.**Apply to the Datadog Partner Network.** Once accepted, a member of the Datadog Technology Partner team will reach out to schedule an introductory call.
85
+
2.**Request a Datadog sandbox account** for development via the Datadog Partner Network portal.
86
+
3.**Start developing your integration** using the Integration Developer Platform:
81
87
82
-
Once you've joined the **Technology Partner** track and requested a sandbox account, you can learn more about developing an offering by:
88
+
a. Define the basic details about your integration.
83
89
84
-
* Completing the on-demand [**Introduction to Datadog Integrations**][7] course on the [Datadog Learning Center][8].
85
-
* Reading the documentation about creating [API-based integrations][1] and setting up an [OAuth 2.0 client for API-based integrations][9].
86
-
* Reading the documentation about creating [Agent-based integrations][2].
90
+
b. Define and write your integration code by following the instructions to create one of the following integration types:
91
+
-[Agent-based integration][5]
92
+
-[API-based integration][6]
87
93
88
-
For more information about selling a Datadog integration or other type of offering, see [Build a Marketplace Offering][4].
94
+
c. Specify what type of data your integration queries or submits.
89
95
90
-
## Create a Datadog integration
96
+
d. Create a dashboard, and optionally create monitors or security rules.
97
+
98
+
e. Fill in the remaining fields: setup and uninstallation instructions, images, support details, and other key details that help describe the value of your integration.
99
+
100
+
4.**Test your integration** in your Datadog sandbox account.
101
+
5.**Submit your integration for review.**
102
+
6.**Once approved, your integration is published.**
91
103
92
104
### Responsibilities
93
105
94
-
As the author of the integration, you are responsible for maintaining the code and ensuring the integration functions properly across all [Datadog sites][15]. If you encounter any setup issues, [contact Support][16].
106
+
As the author of the integration, you are responsible for maintaining the code and ensuring the integration functions properly across all [Datadog sites][8]. If you encounter any setup issues, [contact Support][9].
95
107
96
-
### Agent-based integrations
108
+
##Out-of-the-box Integrations vs. Marketplace Offerings
97
109
98
-
Agent-based integrations use the [Datadog Agent][11] to submit data through checks written by Technology Partners. The implementation code for these integrations is hosted by Datadog.
110
+
{{< tabs >}}
111
+
{{% tab "Integrations" %}}
99
112
100
-
Agent integrations are best suited for collecting data from systems or applications that live in a local area network (LAN) or virtual private cloud (VPC). [Creating an Agent integration][2] requires you to publish and deploy your solution as a Python wheel (`.whl`).
113
+
The [Integrations page][101] includes integrations built by both Datadog and our Technology Partners, available at _no cost_ to Datadog customers.
API-based integrations can submit telemetry—such as metrics, traces, logs, and more—from external platforms using the [Datadog API][12]. Customers can then visualize and correlate this data alongside data from the rest of their stack, allowing them to quickly analyze and remediate issues. API-based integrations may also read data out of Datadog once customers [authorize access using OAuth][13].
117
+
[101]: https://app.datadoghq.com/integrations
105
118
106
-
Technology Partners write and host the implementation code that makes up the integration. [Creating an API integration][1] works well for Technology Partners building a connector between Datadog and another SaaS platform.
119
+
{{% /tab %}}
120
+
{{% tab "Marketplace" %}}
107
121
108
-
## Requirements
109
-
All integrations must include the following:
110
-
* An out-of-the-box integration dashboard
111
-
* 3 or more images for your tile
112
-
* OAuth (for API integrations only)
113
-
* A log pipeline (for log integrations only)
114
-
* Recommended Monitor (for integrations that sends in metrics)
122
+
The [Marketplace page][101] is a commercial platform for Technology Partners to _sell_ a variety of offerings, including integrations, software licenses, and professional services to Datadog customers.
|**Purpose**| Provide a way to connect and transfer data between Datadog and partner platforms | Enhance the Datadog experience, including extended capabilities, partner services, and legacy tech coverage |
138
+
|**Availability**| Included on the Integrations Page | Paid, available on the Marketplace |
0 commit comments