Skip to content

Commit

Permalink
Update API docs for Error Tracking monitors (#2764)
Browse files Browse the repository at this point in the history
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec authored Nov 6, 2024
1 parent 65eb36d commit 641c6a5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-11-05 22:28:17.079382",
"spec_repo_commit": "2db17c21"
"regenerated": "2024-11-06 20:54:48.659232",
"spec_repo_commit": "0f558cbc"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-11-05 22:28:17.098505",
"spec_repo_commit": "2db17c21"
"regenerated": "2024-11-06 20:54:48.678103",
"spec_repo_commit": "0f558cbc"
}
}
}
16 changes: 11 additions & 5 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28985,21 +28985,27 @@ paths:
##### Error Tracking Alert Query


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

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


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

- `issue_source` The issue source - supports `all`, `browser`, `mobile` and
`backend` and defaults to `all` if omitted.

- `rollup_method` The stats roll-up method - supports `count`, `avg`, and
`cardinality`.
`cardinality` and defaults to `count` if omitted.

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

- `group by` Comma-separated list of attributes to group by - should contain
at least `issue.id`.

- `time_window` #m (between 1 and 2880), #h (between 1 and 48).

- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
Expand Down
8 changes: 5 additions & 3 deletions api/datadogV1/api_monitors.go
Original file line number Diff line number Diff line change
Expand Up @@ -258,12 +258,14 @@ func (a *MonitorsApi) CheckCanDeleteMonitor(ctx _context.Context, monitorIds []i
//
// ##### Error Tracking Alert Query
//
// Example(RUM): `error-tracking-rum(query).rollup(rollup_method[, measure]).last(time_window) operator #`
// Example(APM Traces): `error-tracking-traces(query).rollup(rollup_method[, measure]).last(time_window) operator #`
// "New issue" example: `error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #`
// "High impact issue" example: `error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #`
//
// - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
// - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.
// - `issue_source` The issue source - supports `all`, `browser`, `mobile` and `backend` and defaults to `all` if omitted.
// - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality` and defaults to `count` if omitted.
// - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.
// - `group by` Comma-separated list of attributes to group by - should contain at least `issue.id`.
// - `time_window` #m (between 1 and 2880), #h (between 1 and 48).
// - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
// - `#` an integer or decimal number used to set the threshold.
Expand Down

0 comments on commit 641c6a5

Please sign in to comment.