Skip to content

Commit c165084

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

File tree

3 files changed

+25
-15
lines changed

3 files changed

+25
-15
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:16.921323",
8-
"spec_repo_commit": "2db17c21"
7+
"regenerated": "2024-11-06 20:54:46.694370",
8+
"spec_repo_commit": "0f558cbc"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-11-05 22:28:16.941353",
13-
"spec_repo_commit": "2db17c21"
12+
"regenerated": "2024-11-06 20:54:46.713356",
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/datadogV1/api/api_monitors.rs

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -669,12 +669,14 @@ impl MonitorsAPI {
669669
///
670670
/// ##### Error Tracking Alert Query
671671
///
672-
/// Example(RUM): `error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window) operator #`
673-
/// Example(APM Traces): `error-tracking-traces(query).rollup(rollup_method[, measure]).last(time_window) operator #`
672+
/// "New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #`
673+
/// "High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #`
674674
///
675675
/// - `query` The search query - following the [Log search syntax](<https://docs.datadoghq.com/logs/search_syntax/>).
676-
/// - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.
676+
/// - `issue_source` The issue source - supports `all`, `browser`, `mobile` and `backend` and defaults to `all` if omitted.
677+
/// - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality` and defaults to `count` if omitted.
677678
/// - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.
679+
/// - `group by` Comma-separated list of attributes to group by - should contain at least `issue.id`.
678680
/// - `time_window` #m (between 1 and 2880), #h (between 1 and 48).
679681
/// - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
680682
/// - `#` an integer or decimal number used to set the threshold.
@@ -879,12 +881,14 @@ impl MonitorsAPI {
879881
///
880882
/// ##### Error Tracking Alert Query
881883
///
882-
/// Example(RUM): `error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window) operator #`
883-
/// Example(APM Traces): `error-tracking-traces(query).rollup(rollup_method[, measure]).last(time_window) operator #`
884+
/// "New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #`
885+
/// "High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #`
884886
///
885887
/// - `query` The search query - following the [Log search syntax](<https://docs.datadoghq.com/logs/search_syntax/>).
886-
/// - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.
888+
/// - `issue_source` The issue source - supports `all`, `browser`, `mobile` and `backend` and defaults to `all` if omitted.
889+
/// - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality` and defaults to `count` if omitted.
887890
/// - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.
891+
/// - `group by` Comma-separated list of attributes to group by - should contain at least `issue.id`.
888892
/// - `time_window` #m (between 1 and 2880), #h (between 1 and 48).
889893
/// - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
890894
/// - `#` an integer or decimal number used to set the threshold.

0 commit comments

Comments
 (0)