Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update API docs for Error Tracking monitors #2249

Merged
merged 2 commits into from
Nov 6, 2024
+20 −12
Merged

Update API docs for Error Tracking monitors #2249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14d67e1
Regenerate client from commit 0f558cbc of spec repo
Nov 6, 2024
ae608bd
pre-commit fixes
Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
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:18.913806",
"spec_repo_commit": "2db17c21"
"regenerated": "2024-11-06 20:54:42.265722",
"spec_repo_commit": "0f558cbc"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-11-05 22:28:18.931370",
"spec_repo_commit": "2db17c21"
"regenerated": "2024-11-06 20:54:42.283556",
"spec_repo_commit": "0f558cbc"
}
}
}
16 changes: 11 additions & 5 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
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 src/datadog_api_client/v1/api/monitors_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,12 +531,14 @@ def create_monitor(
**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
Loading