Skip to content

Commit 364c410

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add Network Path Monitors to API Docs (#2909)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent d982aea commit 364c410

4 files changed

Lines changed: 33 additions & 5 deletions

File tree

.generator/schemas/v1/openapi.yaml

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7993,6 +7993,7 @@ components:
79937993
- spans
79947994
- database_queries
79957995
- network
7996+
- network_path
79967997
example: rum
79977998
type: string
79987999
x-enum-varnames:
@@ -8005,6 +8006,7 @@ components:
80058006
- SPANS
80068007
- DATABASE_QUERIES
80078008
- NETWORK
8009+
- NETWORK_PATH
80088010
MonitorFormulaAndFunctionQueryDefinition:
80098011
description: A formula and function query.
80108012
oneOf:
@@ -8850,6 +8852,7 @@ components:
88508852
- network-performance alert
88518853
- cost alert
88528854
- data-quality alert
8855+
- network-path alert
88538856
example: query alert
88548857
type: string
88558858
x-enum-varnames:
@@ -8873,6 +8876,7 @@ components:
88738876
- NETWORK_PERFORMANCE_ALERT
88748877
- COST_ALERT
88758878
- DATA_QUALITY_ALERT
8879+
- NETWORK_PATH_ALERT
88768880
MonitorUpdateRequest:
88778881
description: Object describing a monitor update request.
88788882
properties:
@@ -31680,10 +31684,11 @@ paths:
3168031684
alert`\n- watchdog: `event-v2 alert`\n- event-v2: `event-v2 alert`\n- audit:
3168131685
`audit alert`\n- error-tracking: `error-tracking alert`\n- database-monitoring:
3168231686
`database-monitoring alert`\n- network-performance: `network-performance alert`\n-
31683-
cloud cost: `cost alert`\n\n**Notes**:\n- Synthetic monitors are created through
31684-
the Synthetics API. See the [Synthetics API](https://docs.datadoghq.com/api/latest/synthetics/)
31685-
documentation for more information.\n- Log monitors require an unscoped App
31686-
Key.\n\n#### Query Types\n\n##### Metric Alert Query\n\nExample: `time_aggr(time_window):space_aggr:metric{tags}
31687+
cloud cost: `cost alert`\n- network-path: `network-path alert`\n\n**Notes**:\n-
31688+
Synthetic monitors are created through the Synthetics API. See the [Synthetics
31689+
API](https://docs.datadoghq.com/api/latest/synthetics/) documentation for
31690+
more information.\n- Log monitors require an unscoped App Key.\n\n#### Query
31691+
Types\n\n##### Metric Alert Query\n\nExample: `time_aggr(time_window):space_aggr:metric{tags}
3168731692
[by {key}] operator #`\n\n- `time_aggr`: avg, sum, max, min, change, or pct_change\n-
3168831693
`time_window`: `last_#m` (with `#` between 1 and 10080 depending on the monitor
3168931694
type) or `last_#h`(with `#` between 1 and 168 depending on the monitor type)
@@ -31813,7 +31818,15 @@ paths:
3181331818
\ - for `threshold` supports `<`, `<=`, `>`, `>=`, `==`, or `!=`\n -
3181431819
for `change` supports `>`, `<`\n - for `anomaly` supports `>=`\n - for
3181531820
`forecast` supports `>`\n- `#` an integer or decimal number used to set the
31816-
threshold."
31821+
threshold.\n\n**Network Path Alert Query**\n\nExample: `network-path(query).index(index_name).rollup(rollup_method[,
31822+
measure]).last(time_window) operator #`\n\n- `query` The search query - following
31823+
the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).\n-
31824+
`index_name` The data type to monitor on - supports `netpath-path` and `netpath-hop`.\n-
31825+
`rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.\n-
31826+
`measure` For `avg` and cardinality `rollup_method` - specify the measure
31827+
or the facet name you want to use.\n- `time_window` #m (between 1 and 2880),
31828+
#h (between 1 and 48).\n- `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.\n-
31829+
`#` an integer or decimal number used to set the threshold."
3181731830
operationId: CreateMonitor
3181831831
requestBody:
3181931832
content:

lib/datadog_api_client/v1/api/monitors_api.rb

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ def create_monitor(body, opts = {})
127127
# - database-monitoring: `database-monitoring alert`
128128
# - network-performance: `network-performance alert`
129129
# - cloud cost: `cost alert`
130+
# - network-path: `network-path alert`
130131
#
131132
# **Notes**:
132133
# - Synthetic monitors are created through the Synthetics API. See the [Synthetics API](https://docs.datadoghq.com/api/latest/synthetics/) documentation for more information.
@@ -318,6 +319,18 @@ def create_monitor(body, opts = {})
318319
# - for `forecast` supports `>`
319320
# - `#` an integer or decimal number used to set the threshold.
320321
#
322+
# **Network Path Alert Query**
323+
#
324+
# Example: `network-path(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #`
325+
#
326+
# - `query` The search query - following the [Log search syntax](https://docs.datadoghq.com/logs/search_syntax/).
327+
# - `index_name` The data type to monitor on - supports `netpath-path` and `netpath-hop`.
328+
# - `rollup_method` The stats roll-up method - supports `count`, `avg`, and `cardinality`.
329+
# - `measure` For `avg` and cardinality `rollup_method` - specify the measure or the facet name you want to use.
330+
# - `time_window` #m (between 1 and 2880), #h (between 1 and 48).
331+
# - `operator` `<`, `<=`, `>`, `>=`, `==`, or `!=`.
332+
# - `#` an integer or decimal number used to set the threshold.
333+
#
321334
# @param body [Monitor] Create a monitor request body.
322335
# @param opts [Hash] the optional parameters
323336
# @return [Array<(Monitor, Integer, Hash)>] Monitor data, response status code and response headers

lib/datadog_api_client/v1/models/monitor_formula_and_function_events_data_source.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@ class MonitorFormulaAndFunctionEventsDataSource
3030
SPANS = "spans".freeze
3131
DATABASE_QUERIES = "database_queries".freeze
3232
NETWORK = "network".freeze
33+
NETWORK_PATH = "network_path".freeze
3334
end
3435
end

lib/datadog_api_client/v1/models/monitor_type.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@ class MonitorType
4141
NETWORK_PERFORMANCE_ALERT = "network-performance alert".freeze
4242
COST_ALERT = "cost alert".freeze
4343
DATA_QUALITY_ALERT = "data-quality alert".freeze
44+
NETWORK_PATH_ALERT = "network-path alert".freeze
4445
end
4546
end

0 commit comments

Comments
 (0)