Skip to content

Commit 59da9df

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update API docs for Error Tracking monitors (#2557)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 35b3378 commit 59da9df

File tree

3 files changed

+25
-14
lines changed

3 files changed

+25
-14
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-11-05 22:28:25.634841",
8-
"spec_repo_commit": "2db17c21"
7+
"regenerated": "2024-11-06 20:54:41.829245",
8+
"spec_repo_commit": "0f558cbc"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-11-05 22:28:25.653962",
13-
"spec_repo_commit": "2db17c21"
12+
"regenerated": "2024-11-06 20:54:41.847845",
13+
"spec_repo_commit": "0f558cbc"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28985,21 +28985,27 @@ paths:
2898528985
##### Error Tracking Alert Query
2898628986

2898728987

28988-
Example(RUM): `error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window)
28989-
operator #`
28988+
"New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[,
28989+
measure]).by(group_by).last(time_window) operator #`
2899028990

28991-
Example(APM Traces): `error-tracking-traces(query).rollup(rollup_method[,
28992-
measure]).last(time_window) operator #`
28991+
"High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[,
28992+
measure]).by(group_by).last(time_window) operator #`
2899328993

2899428994

2899528995
- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
2899628996

28997+
- `issue_source` The issue source - supports `all`, `browser`, `mobile` and
28998+
`backend` and defaults to `all` if omitted.
28999+
2899729000
- `rollup_method` The stats roll-up method - supports `count`, `avg`, and
28998-
`cardinality`.
29001+
`cardinality` and defaults to `count` if omitted.
2899929002

2900029003
- `measure` For `avg` and cardinality `rollup_method` - specify the measure
2900129004
or the facet name you want to use.
2900229005

29006+
- `group by` Comma-separated list of attributes to group by - should contain
29007+
at least `issue.id`.
29008+
2900329009
- `time_window` #m (between 1 and 2880), #h (between 1 and 48).
2900429010

2900529011
- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.

src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -464,19 +464,24 @@ public CompletableFuture<Monitor> createMonitorAsync(Monitor body) {
464464
*
465465
* <h4>Error Tracking Alert Query</h4>
466466
*
467-
* <p>Example(RUM): <code>
468-
* error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window) operator #</code>
469-
* Example(APM Traces): <code>
470-
* error-tracking-traces(query).rollup(rollup_method[, measure]).last(time_window) operator #
467+
* <p>"New issue" example: <code>
468+
* error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #
469+
* </code> "High impact issue" example: <code>
470+
* error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #
471471
* </code>
472472
*
473473
* <ul>
474474
* <li><code>query</code> The search query - following the <a
475475
* href="https://docs.datadoghq.com/logs/search_syntax/">Log search syntax</a>.
476+
* <li><code>issue_source</code> The issue source - supports <code>all</code>, <code>browser
477+
* </code>, <code>mobile</code> and <code>backend</code> and defaults to <code>all</code> if
478+
* omitted.
476479
* <li><code>rollup_method</code> The stats roll-up method - supports <code>count</code>, <code>
477-
* avg</code>, and <code>cardinality</code>.
480+
* avg</code>, and <code>cardinality</code> and defaults to <code>count</code> if omitted.
478481
* <li><code>measure</code> For <code>avg</code> and cardinality <code>rollup_method</code> -
479482
* specify the measure or the facet name you want to use.
483+
* <li><code>group by</code> Comma-separated list of attributes to group by - should contain at
484+
* least <code>issue.id</code>.
480485
* <li><code>time_window</code> #m (between 1 and 2880), #h (between 1 and 48).
481486
* <li><code>operator</code> <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>
482487
* &gt;=</code>, <code>==</code>, or <code>!=</code>.

0 commit comments

Comments
 (0)