datadog-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +391 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +4579 -0
- package/dist/index.js.map +1 -0
- package/package.json +74 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,391 @@
|
|
|
1
|
+
# Datadog MCP Server
|
|
2
|
+
|
|
3
|
+
[](https://github.com/tantiope/datadog-mcp-server/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/datadog-mcp)
|
|
5
|
+
[](https://opensource.org/licenses/Apache-2.0)
|
|
6
|
+
|
|
7
|
+
> **DISCLAIMER**: This is a community-maintained project and is not officially affiliated with, endorsed by, or supported by Datadog, Inc. This MCP server utilizes the Datadog API but is developed independently.
|
|
8
|
+
|
|
9
|
+
MCP server providing AI assistants with full Datadog observability access. Features grep-like log search, APM trace filtering with duration/status/error queries, smart sampling modes for token efficiency, and cross-correlation between logs, traces, and metrics.
|
|
10
|
+
|
|
11
|
+
## Configuration
|
|
12
|
+
|
|
13
|
+
### Required Environment Variables
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
DD_API_KEY=your-api-key
|
|
17
|
+
DD_APP_KEY=your-app-key
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### Optional Environment Variables
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
DD_SITE=datadoghq.com # Default. Use datadoghq.eu for EU, etc.
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### Optional Flags
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
--site=datadoghq.com # Datadog site (overrides DD_SITE)
|
|
30
|
+
--transport=stdio|http # Transport mode (default: stdio)
|
|
31
|
+
--port=3000 # HTTP port when using http transport
|
|
32
|
+
--host=0.0.0.0 # HTTP host when using http transport
|
|
33
|
+
--read-only # Block all write operations
|
|
34
|
+
--disable-tools=synthetics,rum,security # Comma-separated list of tools to disable
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Usage
|
|
38
|
+
|
|
39
|
+
### Claude Desktop / VS Code / Cursor
|
|
40
|
+
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"mcpServers": {
|
|
44
|
+
"datadog": {
|
|
45
|
+
"command": "npx",
|
|
46
|
+
"args": ["-y", "datadog-mcp"],
|
|
47
|
+
"env": {
|
|
48
|
+
"DD_API_KEY": "your-api-key",
|
|
49
|
+
"DD_APP_KEY": "your-app-key",
|
|
50
|
+
"DD_SITE": "datadoghq.com"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Docker
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"mcpServers": {
|
|
62
|
+
"datadog": {
|
|
63
|
+
"command": "docker",
|
|
64
|
+
"args": [
|
|
65
|
+
"run", "-i", "--rm",
|
|
66
|
+
"-e", "DD_API_KEY",
|
|
67
|
+
"-e", "DD_APP_KEY",
|
|
68
|
+
"-e", "DD_SITE",
|
|
69
|
+
"ghcr.io/tantiope/datadog-mcp"
|
|
70
|
+
],
|
|
71
|
+
"env": {
|
|
72
|
+
"DD_API_KEY": "your-api-key",
|
|
73
|
+
"DD_APP_KEY": "your-app-key",
|
|
74
|
+
"DD_SITE": "datadoghq.com"
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### HTTP Transport
|
|
82
|
+
|
|
83
|
+
When running with `--transport=http`:
|
|
84
|
+
|
|
85
|
+
- `POST /mcp` — MCP protocol endpoint
|
|
86
|
+
- `GET /mcp` — SSE stream for responses
|
|
87
|
+
- `DELETE /mcp` — Close session
|
|
88
|
+
- `GET /health` — Health check
|
|
89
|
+
|
|
90
|
+
## Tools
|
|
91
|
+
|
|
92
|
+
| Tool | Action | Category | Description | Required Scopes |
|
|
93
|
+
|------|--------|----------|-------------|-----------------|
|
|
94
|
+
| `monitors` | list | Alerting | List monitors with optional filters | `monitors_read` |
|
|
95
|
+
| `monitors` | get | Alerting | Get monitor by ID | `monitors_read` |
|
|
96
|
+
| `monitors` | search | Alerting | Search monitors by query | `monitors_read` |
|
|
97
|
+
| `monitors` | create | Alerting | Create a new monitor | `monitors_write` |
|
|
98
|
+
| `monitors` | update | Alerting | Update an existing monitor | `monitors_write` |
|
|
99
|
+
| `monitors` | delete | Alerting | Delete a monitor | `monitors_write` |
|
|
100
|
+
| `monitors` | mute | Alerting | Mute a monitor | `monitors_write` |
|
|
101
|
+
| `monitors` | unmute | Alerting | Unmute a monitor | `monitors_write` |
|
|
102
|
+
| `dashboards` | list | Visualization | List all dashboards | `dashboards_read` |
|
|
103
|
+
| `dashboards` | get | Visualization | Get dashboard by ID | `dashboards_read` |
|
|
104
|
+
| `dashboards` | create | Visualization | Create a new dashboard | `dashboards_write` |
|
|
105
|
+
| `dashboards` | update | Visualization | Update a dashboard | `dashboards_write` |
|
|
106
|
+
| `dashboards` | delete | Visualization | Delete a dashboard | `dashboards_write` |
|
|
107
|
+
| `logs` | search | Logs | Search logs with query syntax and filters | `logs_read_data`, `logs_read_index_data` |
|
|
108
|
+
| `logs` | aggregate | Logs | Aggregate log data with groupBy | `logs_read_data` |
|
|
109
|
+
| `metrics` | query | Metrics | Query timeseries data | `metrics_read`, `timeseries_query` |
|
|
110
|
+
| `metrics` | search | Metrics | Search for metrics by name | `metrics_read` |
|
|
111
|
+
| `metrics` | list | Metrics | List active metrics | `metrics_read` |
|
|
112
|
+
| `metrics` | metadata | Metrics | Get metric metadata | `metrics_read` |
|
|
113
|
+
| `traces` | search | APM | Search spans with filters | `apm_read` |
|
|
114
|
+
| `traces` | aggregate | APM | Aggregate trace data | `apm_read` |
|
|
115
|
+
| `traces` | services | APM | List APM services | `apm_service_catalog_read` |
|
|
116
|
+
| `events` | list | Events | List events | `events_read` |
|
|
117
|
+
| `events` | get | Events | Get event by ID | `events_read` |
|
|
118
|
+
| `events` | create | Events | Create an event | `events_read` |
|
|
119
|
+
| `events` | search | Events | Search events with v2 API and cursor pagination | `events_read` |
|
|
120
|
+
| `events` | aggregate | Events | Client-side aggregation by monitor_name, source, etc. | `events_read` |
|
|
121
|
+
| `events` | top | Events | Top N noisiest monitors (convenience wrapper) | `events_read` |
|
|
122
|
+
| `events` | timeseries | Events | Time-bucketed alert trends (hourly/daily counts) | `events_read` |
|
|
123
|
+
| `events` | incidents | Events | Deduplicate alerts into incidents with Trigger/Recover pairing | `events_read` |
|
|
124
|
+
| `incidents` | list | Incidents | List incidents | `incident_read` |
|
|
125
|
+
| `incidents` | get | Incidents | Get incident by ID | `incident_read` |
|
|
126
|
+
| `incidents` | search | Incidents | Search incidents | `incident_read` |
|
|
127
|
+
| `incidents` | create | Incidents | Create an incident | `incident_write` |
|
|
128
|
+
| `incidents` | update | Incidents | Update an incident | `incident_write` |
|
|
129
|
+
| `incidents` | delete | Incidents | Delete an incident | `incident_write` |
|
|
130
|
+
| `slos` | list | SLOs | List SLOs | `slos_read` |
|
|
131
|
+
| `slos` | get | SLOs | Get SLO by ID | `slos_read` |
|
|
132
|
+
| `slos` | create | SLOs | Create an SLO | `slos_write` |
|
|
133
|
+
| `slos` | update | SLOs | Update an SLO | `slos_write` |
|
|
134
|
+
| `slos` | delete | SLOs | Delete an SLO | `slos_write` |
|
|
135
|
+
| `slos` | history | SLOs | Get SLO history | `slos_read` |
|
|
136
|
+
| `synthetics` | list | Synthetics | List synthetic tests | `synthetics_read` |
|
|
137
|
+
| `synthetics` | get | Synthetics | Get test by public ID | `synthetics_read` |
|
|
138
|
+
| `synthetics` | create | Synthetics | Create a test | `synthetics_write` |
|
|
139
|
+
| `synthetics` | update | Synthetics | Update a test | `synthetics_write` |
|
|
140
|
+
| `synthetics` | delete | Synthetics | Delete a test | `synthetics_write` |
|
|
141
|
+
| `synthetics` | trigger | Synthetics | Trigger a test run | `synthetics_write` |
|
|
142
|
+
| `synthetics` | results | Synthetics | Get test results | `synthetics_read` |
|
|
143
|
+
| `downtimes` | list | Downtimes | List downtimes | `monitors_downtime` |
|
|
144
|
+
| `downtimes` | get | Downtimes | Get downtime by ID | `monitors_downtime` |
|
|
145
|
+
| `downtimes` | create | Downtimes | Create a downtime | `monitors_downtime` |
|
|
146
|
+
| `downtimes` | update | Downtimes | Update a downtime | `monitors_downtime` |
|
|
147
|
+
| `downtimes` | cancel | Downtimes | Cancel a downtime | `monitors_downtime` |
|
|
148
|
+
| `downtimes` | listByMonitor | Downtimes | List downtimes for a monitor | `monitors_downtime` |
|
|
149
|
+
| `hosts` | list | Infrastructure | List hosts | `hosts_read` |
|
|
150
|
+
| `hosts` | totals | Infrastructure | Get host totals | `hosts_read` |
|
|
151
|
+
| `hosts` | mute | Infrastructure | Mute a host | `hosts_read` |
|
|
152
|
+
| `hosts` | unmute | Infrastructure | Unmute a host | `hosts_read` |
|
|
153
|
+
| `rum` | applications | RUM | List RUM applications | `rum_read` |
|
|
154
|
+
| `rum` | events | RUM | Search RUM events | `rum_read` |
|
|
155
|
+
| `rum` | aggregate | RUM | Aggregate RUM data | `rum_read` |
|
|
156
|
+
| `rum` | performance | RUM | Get Core Web Vitals (LCP, FCP, CLS, FID, INP) | `rum_read` |
|
|
157
|
+
| `rum` | waterfall | RUM | Get session timeline with resources/actions/errors | `rum_read` |
|
|
158
|
+
| `security` | rules | Security | List security rules | `security_monitoring_rules_read` |
|
|
159
|
+
| `security` | signals | Security | Search security signals | `security_monitoring_signals_read` |
|
|
160
|
+
| `security` | findings | Security | List security findings | `security_monitoring_findings_read` |
|
|
161
|
+
| `notebooks` | list | Notebooks | List notebooks | `notebooks_read` |
|
|
162
|
+
| `notebooks` | get | Notebooks | Get notebook by ID | `notebooks_read` |
|
|
163
|
+
| `notebooks` | create | Notebooks | Create a notebook | `notebooks_write` |
|
|
164
|
+
| `notebooks` | update | Notebooks | Update a notebook | `notebooks_write` |
|
|
165
|
+
| `notebooks` | delete | Notebooks | Delete a notebook | `notebooks_write` |
|
|
166
|
+
| `users` | list | Admin | List users | `user_access_read` |
|
|
167
|
+
| `users` | get | Admin | Get user by ID | `user_access_read` |
|
|
168
|
+
| `teams` | list | Admin | List teams | `teams_read` |
|
|
169
|
+
| `teams` | get | Admin | Get team by ID | `teams_read` |
|
|
170
|
+
| `teams` | members | Admin | List team members | `teams_read` |
|
|
171
|
+
| `tags` | list | Infrastructure | List all tags | `hosts_read` |
|
|
172
|
+
| `tags` | get | Infrastructure | Get tags for a host | `hosts_read` |
|
|
173
|
+
| `tags` | add | Infrastructure | Add tags to a host | `hosts_read` |
|
|
174
|
+
| `tags` | update | Infrastructure | Update host tags | `hosts_read` |
|
|
175
|
+
| `tags` | delete | Infrastructure | Delete host tags | `hosts_read` |
|
|
176
|
+
| `usage` | summary | Billing | Usage summary | `usage_read` |
|
|
177
|
+
| `usage` | hosts | Billing | Host usage | `usage_read` |
|
|
178
|
+
| `usage` | logs | Billing | Log usage | `usage_read` |
|
|
179
|
+
| `usage` | custom_metrics | Billing | Custom metrics usage | `usage_read` |
|
|
180
|
+
| `usage` | indexed_spans | Billing | Indexed spans usage | `usage_read` |
|
|
181
|
+
| `usage` | ingested_spans | Billing | Ingested spans usage | `usage_read` |
|
|
182
|
+
| `auth` | validate | Auth | Test API and App key validity | — |
|
|
183
|
+
|
|
184
|
+
## Token Efficiency
|
|
185
|
+
|
|
186
|
+
### Compact Mode (Logs)
|
|
187
|
+
|
|
188
|
+
Use `compact: true` when searching logs to reduce payload size. Strips custom attributes and keeps only essential fields:
|
|
189
|
+
|
|
190
|
+
```
|
|
191
|
+
logs({ action: "search", status: "error", compact: true })
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
Returns: `id`, `timestamp`, `service`, `status`, `message` (truncated), `traceId`, `spanId`, `error`
|
|
195
|
+
|
|
196
|
+
### Sampling Modes (Logs)
|
|
197
|
+
|
|
198
|
+
Control how logs are sampled with the `sample` parameter:
|
|
199
|
+
|
|
200
|
+
| Mode | Description | Use Case |
|
|
201
|
+
|------|-------------|----------|
|
|
202
|
+
| `first` | Chronological order (default) | Timeline analysis, specific events |
|
|
203
|
+
| `spread` | Evenly distributed across time range | See patterns over time |
|
|
204
|
+
| `diverse` | Deduplicated by message pattern | Error investigation (distinct error types) |
|
|
205
|
+
|
|
206
|
+
Example - find distinct error patterns:
|
|
207
|
+
```
|
|
208
|
+
logs({ action: "search", status: "error", sample: "diverse", limit: 25 })
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
The `diverse` mode normalizes messages (strips UUIDs, timestamps, IPs, numbers) to identify unique error patterns instead of returning duplicates.
|
|
212
|
+
|
|
213
|
+
## Events Aggregation
|
|
214
|
+
|
|
215
|
+
Find the noisiest monitors with a single query:
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
events({ action: "top", from: "7d", limit: 10 })
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
Returns:
|
|
222
|
+
```json
|
|
223
|
+
{
|
|
224
|
+
"top": [
|
|
225
|
+
{ "rank": 1, "name": "Error budget (SLI)", "alertCount": 44, "lastAlert": "..." },
|
|
226
|
+
{ "rank": 2, "name": "High number of ready messages", "alertCount": 38, "lastAlert": "..." }
|
|
227
|
+
]
|
|
228
|
+
}
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
For more control, use `aggregate` with custom groupBy:
|
|
232
|
+
|
|
233
|
+
```
|
|
234
|
+
events({
|
|
235
|
+
action: "aggregate",
|
|
236
|
+
from: "7d",
|
|
237
|
+
tags: ["source:alert"],
|
|
238
|
+
groupBy: ["monitor_name", "priority"]
|
|
239
|
+
})
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
Supported groupBy fields: `monitor_name`, `priority`, `alert_type`, `source`, `status`, `host`
|
|
243
|
+
|
|
244
|
+
The aggregation uses v2 API with cursor pagination to stream through events efficiently (up to 10k events).
|
|
245
|
+
|
|
246
|
+
## Alert Trends (Timeseries)
|
|
247
|
+
|
|
248
|
+
Visualize alert patterns over time with time-bucketed aggregation:
|
|
249
|
+
|
|
250
|
+
```
|
|
251
|
+
events({ action: "timeseries", from: "7d", interval: "1d" })
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
Returns hourly/daily alert counts grouped by monitor:
|
|
255
|
+
```json
|
|
256
|
+
{
|
|
257
|
+
"timeseries": [
|
|
258
|
+
{ "timestamp": "2024-01-15T00:00:00Z", "counts": { "High CPU": 5, "Low Disk": 2 }, "total": 7 },
|
|
259
|
+
{ "timestamp": "2024-01-16T00:00:00Z", "counts": { "High CPU": 3 }, "total": 3 }
|
|
260
|
+
]
|
|
261
|
+
}
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
| Interval | Use Case |
|
|
265
|
+
|----------|----------|
|
|
266
|
+
| `1h` | Recent incident analysis (default) |
|
|
267
|
+
| `4h` | Daily patterns |
|
|
268
|
+
| `1d` | Weekly trends |
|
|
269
|
+
|
|
270
|
+
Combine with `groupBy` to see trends per monitor, source, or priority.
|
|
271
|
+
|
|
272
|
+
## Incident Deduplication
|
|
273
|
+
|
|
274
|
+
Consolidate noisy alert floods into logical incidents:
|
|
275
|
+
|
|
276
|
+
```
|
|
277
|
+
events({ action: "incidents", from: "24h", dedupeWindow: "5m" })
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
Groups repeated triggers within the dedupe window and pairs with recovery events:
|
|
281
|
+
```json
|
|
282
|
+
{
|
|
283
|
+
"incidents": [
|
|
284
|
+
{
|
|
285
|
+
"monitorName": "High CPU Usage",
|
|
286
|
+
"firstTrigger": "2024-01-15T10:00:00Z",
|
|
287
|
+
"lastTrigger": "2024-01-15T10:15:00Z",
|
|
288
|
+
"triggerCount": 4,
|
|
289
|
+
"recovered": true,
|
|
290
|
+
"recoveredAt": "2024-01-15T10:30:00Z",
|
|
291
|
+
"duration": "30m"
|
|
292
|
+
}
|
|
293
|
+
],
|
|
294
|
+
"meta": { "totalIncidents": 15, "recoveredCount": 12, "activeCount": 3 }
|
|
295
|
+
}
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
| Dedupe Window | Use Case |
|
|
299
|
+
|---------------|----------|
|
|
300
|
+
| `5m` | Flapping detection (default) |
|
|
301
|
+
| `15m` | Alert storm consolidation |
|
|
302
|
+
| `1h` | Incident grouping |
|
|
303
|
+
|
|
304
|
+
## Monitor Enrichment
|
|
305
|
+
|
|
306
|
+
Add monitor metadata to search results for deeper context:
|
|
307
|
+
|
|
308
|
+
```
|
|
309
|
+
events({ action: "search", tags: ["source:alert"], from: "1h", enrich: true })
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
Returns events with monitor details (type, thresholds, tags):
|
|
313
|
+
```json
|
|
314
|
+
{
|
|
315
|
+
"events": [{
|
|
316
|
+
"id": "...",
|
|
317
|
+
"title": "[Triggered on {host:prod-1}] High CPU Usage",
|
|
318
|
+
"monitorMetadata": {
|
|
319
|
+
"id": 12345,
|
|
320
|
+
"type": "metric alert",
|
|
321
|
+
"message": "CPU is above threshold",
|
|
322
|
+
"tags": ["team:platform", "env:prod"],
|
|
323
|
+
"options": { "thresholds": { "critical": 90 } }
|
|
324
|
+
}
|
|
325
|
+
}]
|
|
326
|
+
}
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
Note: Enrichment adds latency (fetches monitor list). Use for detailed investigation, not bulk analysis.
|
|
330
|
+
|
|
331
|
+
## Cross-Correlation
|
|
332
|
+
|
|
333
|
+
### Logs → Traces → Metrics
|
|
334
|
+
|
|
335
|
+
1. **Find errors in logs**: `logs({ action: "search", status: "error", sample: "diverse" })`
|
|
336
|
+
2. **Extract trace_id** from log attributes (`dd.trace_id`)
|
|
337
|
+
3. **Get full trace**: `traces({ action: "search", query: "trace_id:<id>" })`
|
|
338
|
+
4. **Query APM metrics**: `metrics({ action: "query", query: "avg:trace.<service>.request.duration{*}" })`
|
|
339
|
+
|
|
340
|
+
## Deep Links
|
|
341
|
+
|
|
342
|
+
All query responses include a `datadog_url` field that links directly to the Datadog UI, allowing AI assistants to provide evidence links back to the source data.
|
|
343
|
+
|
|
344
|
+
### Example Response
|
|
345
|
+
|
|
346
|
+
```json
|
|
347
|
+
{
|
|
348
|
+
"logs": [...],
|
|
349
|
+
"meta": {
|
|
350
|
+
"count": 25,
|
|
351
|
+
"query": "service:api status:error",
|
|
352
|
+
"from": "2024-01-15T10:00:00Z",
|
|
353
|
+
"to": "2024-01-15T11:00:00Z",
|
|
354
|
+
"datadog_url": "https://app.datadoghq.com/logs?query=service%3Aapi%20status%3Aerror&from_ts=1705312800000&to_ts=1705316400000"
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
### Supported Tools
|
|
360
|
+
|
|
361
|
+
| Tool | URL Type |
|
|
362
|
+
|------|----------|
|
|
363
|
+
| `logs` | Logs Explorer with query and time range |
|
|
364
|
+
| `metrics` | Metrics Explorer with query and time range |
|
|
365
|
+
| `traces` | APM Traces with query and time range |
|
|
366
|
+
| `events` | Event Explorer with query and time range |
|
|
367
|
+
| `monitors` | Monitor detail page (get) or Manage Monitors (list/search) |
|
|
368
|
+
| `rum` | RUM Explorer or Session Replay |
|
|
369
|
+
|
|
370
|
+
### Multi-Region Support
|
|
371
|
+
|
|
372
|
+
URLs are automatically generated for your configured Datadog site:
|
|
373
|
+
|
|
374
|
+
| Site | App URL |
|
|
375
|
+
|------|---------|
|
|
376
|
+
| `datadoghq.com` (default) | `https://app.datadoghq.com` |
|
|
377
|
+
| `datadoghq.eu` | `https://app.datadoghq.eu` |
|
|
378
|
+
| `us3.datadoghq.com` | `https://us3.datadoghq.com` |
|
|
379
|
+
| `us5.datadoghq.com` | `https://us5.datadoghq.com` |
|
|
380
|
+
| `ap1.datadoghq.com` | `https://ap1.datadoghq.com` |
|
|
381
|
+
| `ddog-gov.com` | `https://app.ddog-gov.com` |
|
|
382
|
+
|
|
383
|
+
Configure your site via the `DD_SITE` environment variable or `--site` flag.
|
|
384
|
+
|
|
385
|
+
## Contributing
|
|
386
|
+
|
|
387
|
+
Contributions are welcome! Feel free to open an issue or a pull request if you have any suggestions, bug reports, or improvements to propose.
|
|
388
|
+
|
|
389
|
+
## License
|
|
390
|
+
|
|
391
|
+
This project is licensed under the [Apache License, Version 2.0](LICENSE).
|
package/dist/index.d.ts
ADDED