Skip to content

Commit

Permalink
add timeframe_type param for cost monitors (#2386)
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 Jan 31, 2025
1 parent a4bc820 commit 85bfe0b
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 17 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": "2025-01-29 14:55:52.778358",
"spec_repo_commit": "14f5d952"
"regenerated": "2025-01-30 13:13:54.596747",
"spec_repo_commit": "833109b8"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-01-29 14:55:52.793962",
"spec_repo_commit": "14f5d952"
"regenerated": "2025-01-30 13:13:54.612098",
"spec_repo_commit": "833109b8"
}
}
}
27 changes: 15 additions & 12 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29252,19 +29252,22 @@ paths:
or the facet name you want to use.\n- `time_window` #m (between 1 and 2880),
#h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n-
`#` an integer or decimal number used to set the threshold.\n\n**Cost Alert
Query**\n\nExample: `formula(query).last(time_window).function(parameter)
Query**\n\nExample: `formula(query).timeframe_type(time_window).function(parameter)
operator #`\n\n- `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n-
`time_window` - supports daily roll-up e.g. `7d`\n- `function` - [optional,
defaults to `threshold` monitor if omitted] supports `change`, `anomaly`,
`forecast`\n- `parameter` Specify the parameter of the type\n - for `change`:\n
\ - supports `relative`, `absolute`\n - [optional] supports `#`,
where `#` is an integer or decimal number used to set the threshold\n -
for `anomaly`:\n - supports `direction=both`, `direction=above`, `direction=below`\n
\ - [optional] supports `threshold=#`, where `#` is an integer or decimal
number used to set the threshold\n- `operator`\n - for `threshold` supports
`<`, `<=`, `>`, `>=`, `==`, or `!=`\n - for `change` supports `>`, `<`\n
\ - for `anomaly` supports `>=`\n - for `forecast` supports `>`\n- `#`
an integer or decimal number used to set the threshold."
`timeframe_type` The timeframe type to evaluate the cost\n - for `forecast`
supports `current`\n - for `change`, `anomaly`, `threshold` supports
`last`\n- `time_window` - supports daily roll-up e.g. `7d`\n- `function` -
[optional, defaults to `threshold` monitor if omitted] supports `change`,
`anomaly`, `forecast`\n- `parameter` Specify the parameter of the type\n -
for `change`:\n - supports `relative`, `absolute`\n - [optional]
supports `#`, where `#` is an integer or decimal number used to set the threshold\n
\ - for `anomaly`:\n - supports `direction=both`, `direction=above`,
`direction=below`\n - [optional] supports `threshold=#`, where `#`
is an integer or decimal number used to set the threshold\n- `operator`\n
\ - for `threshold` supports `<`, `<=`, `>`, `>=`, `==`, or `!=`\n -
for `change` supports `>`, `<`\n - for `anomaly` supports `>=`\n - for
`forecast` supports `>`\n- `#` an integer or decimal number used to set the
threshold."
operationId: CreateMonitor
requestBody:
content:
Expand Down
8 changes: 7 additions & 1 deletion src/datadog_api_client/v1/api/monitors_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -567,9 +567,15 @@ def create_monitor(
**Cost Alert Query**
Example: ``formula(query).last(time_window).function(parameter) operator #``
Example: ``formula(query).timeframe_type(time_window).function(parameter) operator #``
* ``query`` The search query - following the `Log search syntax <https://docs.datadoghq.com/logs/search_syntax/>`_.
* ``timeframe_type`` The timeframe type to evaluate the cost
.. code-block::
- for `forecast` supports `current`
- for `change`, `anomaly`, `threshold` supports `last`
* ``time_window`` - supports daily roll-up e.g. ``7d``
* ``function`` - [optional, defaults to ``threshold`` monitor if omitted] supports ``change`` , ``anomaly`` , ``forecast``
* ``parameter`` Specify the parameter of the type
Expand Down

0 comments on commit 85bfe0b

Please sign in to comment.