Skip to content

Commit 3200c0f

Browse files
dd-octo-sts[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 5e7a63b of spec repo (#4505)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent c8ace5c commit 3200c0f

4 files changed

Lines changed: 93 additions & 36 deletions

File tree

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 45 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -96597,7 +96597,9 @@ components:
9659796597
x-enum-varnames:
9659896598
- PROCESS
9659996599
ProcessScalarQuery:
96600-
description: A query for host-level process metrics such as CPU and memory usage.
96600+
description: |-
96601+
Per-process metrics from Live Processes. Queries without `aggregator` fail. To scope to one process,
96602+
set `tag_filters` to its `identifying_tags` from `GET /api/v2/processes`.
9660196603
properties:
9660296604
aggregator:
9660396605
$ref: "#/components/schemas/MetricsAggregator"
@@ -96609,11 +96611,15 @@ components:
9660996611
description: Whether CPU metrics should be normalized by core count.
9661096612
type: boolean
9661196613
limit:
96612-
description: Maximum number of results to return.
96614+
description: |-
96615+
Maximum number of processes or groups to return. Large values can fail with an `Unprocessable
96616+
Content` error. If so, retry with a smaller limit.
9661396617
format: int64
9661496618
type: integer
9661596619
metric:
96616-
description: The process metric to query.
96620+
description: |-
96621+
The process metric to query, such as `process.stat.cpu.total_pct`, `process.stat.memory.rss`, or
96622+
`process.stat.memory.vms`.
9661796623
example: process.stat.cpu.total_pct
9661896624
type: string
9661996625
name:
@@ -96623,7 +96629,9 @@ components:
9662396629
sort:
9662496630
$ref: "#/components/schemas/QuerySortOrder"
9662596631
tag_filters:
96626-
description: Tag filters to narrow down processes.
96632+
description: |-
96633+
Tags to narrow down processes. To scope to one process, use its `identifying_tags` from
96634+
`GET /api/v2/processes`, for example `host:web-01` and `pid:1234`.
9662796635
items:
9662896636
description: A tag filter value.
9662996637
example: "env:prod"
@@ -96735,7 +96743,9 @@ components:
9673596743
x-enum-varnames:
9673696744
- PROCESS
9673796745
ProcessTimeseriesQuery:
96738-
description: A query for host-level process metrics such as CPU and memory usage.
96746+
description: |-
96747+
Per-process metrics from Live Processes over time, such as CPU and memory usage. To scope to one
96748+
process, set `tag_filters` to its `identifying_tags` from `GET /api/v2/processes`.
9673996749
properties:
9674096750
cross_org_uuids:
9674196751
$ref: "#/components/schemas/CrossOrgUuids"
@@ -96745,11 +96755,15 @@ components:
9674596755
description: Whether CPU metrics should be normalized by core count.
9674696756
type: boolean
9674796757
limit:
96748-
description: Maximum number of results to return.
96758+
description: |-
96759+
Maximum number of processes or groups to return. Large values can fail with an `Unprocessable
96760+
Content` error. If so, retry with a smaller limit.
9674996761
format: int64
9675096762
type: integer
9675196763
metric:
96752-
description: The process metric to query.
96764+
description: |-
96765+
The process metric to query, such as `process.stat.cpu.total_pct`, `process.stat.memory.rss`, or
96766+
`process.stat.memory.vms`.
9675396767
example: process.stat.cpu.total_pct
9675496768
type: string
9675596769
name:
@@ -96759,7 +96773,9 @@ components:
9675996773
sort:
9676096774
$ref: "#/components/schemas/QuerySortOrder"
9676196775
tag_filters:
96762-
description: Tag filters to narrow down processes.
96776+
description: |-
96777+
Tags to narrow down processes. To scope to one process, use its `identifying_tags` from
96778+
`GET /api/v2/processes`, for example `host:web-01` and `pid:1234`.
9676396779
items:
9676496780
description: A tag filter value.
9676596781
example: "env:prod"
@@ -210946,36 +210962,48 @@ paths:
210946210962
- dashboards_write
210947210963
/api/v2/processes:
210948210964
get:
210949-
description: Get all processes for your organization.
210965+
description: |-
210966+
Get processes collected by Live Processes for your organization. One request covers a window of
210967+
at most 1 hour that starts within the past 36 hours. To cover a longer period, make one request
210968+
per hour. Older data is not available from this endpoint.
210969+
210970+
When a process includes `identifying_tags`, pass them as `tag_filters` in a `process` data source
210971+
query to `/api/v2/query/scalar` or `/api/v2/query/timeseries` to get CPU or memory metrics for that
210972+
one process. If absent, don't substitute an empty filter, which would query all processes.
210950210973
operationId: ListProcesses
210951210974
parameters:
210952-
- description: String to search processes by.
210975+
- description: |-
210976+
Free-text search over process fields such as the executable and user. When it contains several
210977+
words, a process must match all of them. Use `tags` for exact values such as host.
210953210978
in: query
210954210979
name: search
210955210980
required: false
210956210981
schema:
210957210982
type: string
210958-
- description: Comma-separated list of tags to filter processes by.
210983+
- description: |-
210984+
Comma-separated `key:value` tags. A process must match every tag. Wildcards, negation
210985+
(`-key:value`), spaces, and `IN (...)` are not supported. To cover several hosts, make one
210986+
request per host.
210959210987
example: account:prod,user:admin
210960210988
in: query
210961210989
name: tags
210962210990
required: false
210963210991
schema:
210964210992
type: string
210965210993
- description: |-
210966-
Unix timestamp (number of seconds since epoch) of the start of the query window.
210967-
If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither
210968-
`from` nor `to` are provided, the query window will be `[now - 15m, now]`.
210994+
Start of the query window, in Unix seconds. Must be within the past 36 hours and at most 1 hour
210995+
before `to`. If not provided, the start of the query window is 15 minutes before the `to` timestamp.
210996+
If neither `from` nor `to` is provided, the query window is `[now - 15m, now]`.
210969210997
in: query
210970210998
name: from
210971210999
required: false
210972211000
schema:
210973211001
format: int64
210974211002
type: integer
210975211003
- description: |-
210976-
Unix timestamp (number of seconds since epoch) of the end of the query window.
210977-
If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither
210978-
`from` nor `to` are provided, the query window will be `[now - 15m, now]`.
211004+
End of the query window, in Unix seconds. Must be at most 1 hour after `from`. If not provided, the
211005+
end of the query window is 15 minutes after the `from` timestamp. If neither `from` nor `to` is
211006+
provided, the query window is `[now - 15m, now]`.
210979211007
in: query
210980211008
name: to
210981211009
required: false

‎src/main/java/com/datadog/api/client/v2/api/ProcessesApi.java‎

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ public static class ListProcessesOptionalParameters {
5959
/**
6060
* Set search.
6161
*
62-
* @param search String to search processes by. (optional)
62+
* @param search Free-text search over process fields such as the executable and user. When it
63+
* contains several words, a process must match all of them. Use <code>tags</code> for exact
64+
* values such as host. (optional)
6365
* @return ListProcessesOptionalParameters
6466
*/
6567
public ListProcessesOptionalParameters search(String search) {
@@ -70,7 +72,9 @@ public ListProcessesOptionalParameters search(String search) {
7072
/**
7173
* Set tags.
7274
*
73-
* @param tags Comma-separated list of tags to filter processes by. (optional)
75+
* @param tags Comma-separated <code>key:value</code> tags. A process must match every tag.
76+
* Wildcards, negation (<code>-key:value</code>), spaces, and <code>IN (...)</code> are not
77+
* supported. To cover several hosts, make one request per host. (optional)
7478
* @return ListProcessesOptionalParameters
7579
*/
7680
public ListProcessesOptionalParameters tags(String tags) {
@@ -81,10 +85,10 @@ public ListProcessesOptionalParameters tags(String tags) {
8185
/**
8286
* Set from.
8387
*
84-
* @param from Unix timestamp (number of seconds since epoch) of the start of the query window.
85-
* If not provided, the start of the query window will be 15 minutes before the <code>to
86-
* </code> timestamp. If neither <code>from</code> nor <code>to</code> are provided, the
87-
* query window will be <code>[now - 15m, now]</code>. (optional)
88+
* @param from Start of the query window, in Unix seconds. Must be within the past 36 hours and
89+
* at most 1 hour before <code>to</code>. If not provided, the start of the query window is
90+
* 15 minutes before the <code>to</code> timestamp. If neither <code>from</code> nor <code>
91+
* to</code> is provided, the query window is <code>[now - 15m, now]</code>. (optional)
8892
* @return ListProcessesOptionalParameters
8993
*/
9094
public ListProcessesOptionalParameters from(Long from) {
@@ -95,10 +99,10 @@ public ListProcessesOptionalParameters from(Long from) {
9599
/**
96100
* Set to.
97101
*
98-
* @param to Unix timestamp (number of seconds since epoch) of the end of the query window. If
99-
* not provided, the end of the query window will be 15 minutes after the <code>from</code>
100-
* timestamp. If neither <code>from</code> nor <code>to</code> are provided, the query
101-
* window will be <code>[now - 15m, now]</code>. (optional)
102+
* @param to End of the query window, in Unix seconds. Must be at most 1 hour after <code>from
103+
* </code>. If not provided, the end of the query window is 15 minutes after the <code>from
104+
* </code> timestamp. If neither <code>from</code> nor <code>to</code> is provided, the
105+
* query window is <code>[now - 15m, now]</code>. (optional)
102106
* @return ListProcessesOptionalParameters
103107
*/
104108
public ListProcessesOptionalParameters to(Long to) {
@@ -243,7 +247,14 @@ public PaginationIterable<ProcessSummary> listProcessesWithPagination(
243247
}
244248

245249
/**
246-
* Get all processes for your organization.
250+
* Get processes collected by Live Processes for your organization. One request covers a window of
251+
* at most 1 hour that starts within the past 36 hours. To cover a longer period, make one request
252+
* per hour. Older data is not available from this endpoint.
253+
*
254+
* <p>When a process includes <code>identifying_tags</code>, pass them as <code>tag_filters</code>
255+
* in a <code>process</code> data source query to <code>/api/v2/query/scalar</code> or <code>
256+
* /api/v2/query/timeseries</code> to get CPU or memory metrics for that one process. If absent,
257+
* don't substitute an empty filter, which would query all processes.
247258
*
248259
* @param parameters Optional parameters for the request.
249260
* @return ApiResponse&lt;ProcessSummariesResponse&gt;

‎src/main/java/com/datadog/api/client/v2/model/ProcessScalarQuery.java‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@
1919
import java.util.Map;
2020
import java.util.Objects;
2121

22-
/** A query for host-level process metrics such as CPU and memory usage. */
22+
/**
23+
* Per-process metrics from Live Processes. Queries without <code>aggregator</code> fail. To scope
24+
* to one process, set <code>tag_filters</code> to its <code>identifying_tags</code> from <code>
25+
* GET /api/v2/processes</code>.
26+
*/
2327
@JsonPropertyOrder({
2428
ProcessScalarQuery.JSON_PROPERTY_AGGREGATOR,
2529
ProcessScalarQuery.JSON_PROPERTY_CROSS_ORG_UUIDS,
@@ -187,7 +191,9 @@ public ProcessScalarQuery limit(Long limit) {
187191
}
188192

189193
/**
190-
* Maximum number of results to return.
194+
* Maximum number of processes or groups to return. Large values can fail with an <code>
195+
* Unprocessable
196+
* Content</code> error. If so, retry with a smaller limit.
191197
*
192198
* @return limit
193199
*/
@@ -208,7 +214,8 @@ public ProcessScalarQuery metric(String metric) {
208214
}
209215

210216
/**
211-
* The process metric to query.
217+
* The process metric to query, such as <code>process.stat.cpu.total_pct</code>, <code>
218+
* process.stat.memory.rss</code>, or <code>process.stat.memory.vms</code>.
212219
*
213220
* @return metric
214221
*/
@@ -281,7 +288,9 @@ public ProcessScalarQuery addTagFiltersItem(String tagFiltersItem) {
281288
}
282289

283290
/**
284-
* Tag filters to narrow down processes.
291+
* Tags to narrow down processes. To scope to one process, use its <code>identifying_tags</code>
292+
* from <code>GET /api/v2/processes</code>, for example <code>host:web-01</code> and <code>
293+
* pid:1234</code>.
285294
*
286295
* @return tagFilters
287296
*/

‎src/main/java/com/datadog/api/client/v2/model/ProcessTimeseriesQuery.java‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@
1919
import java.util.Map;
2020
import java.util.Objects;
2121

22-
/** A query for host-level process metrics such as CPU and memory usage. */
22+
/**
23+
* Per-process metrics from Live Processes over time, such as CPU and memory usage. To scope to one
24+
* process, set <code>tag_filters</code> to its <code>identifying_tags</code> from <code>
25+
* GET /api/v2/processes</code>.
26+
*/
2327
@JsonPropertyOrder({
2428
ProcessTimeseriesQuery.JSON_PROPERTY_CROSS_ORG_UUIDS,
2529
ProcessTimeseriesQuery.JSON_PROPERTY_DATA_SOURCE,
@@ -158,7 +162,9 @@ public ProcessTimeseriesQuery limit(Long limit) {
158162
}
159163

160164
/**
161-
* Maximum number of results to return.
165+
* Maximum number of processes or groups to return. Large values can fail with an <code>
166+
* Unprocessable
167+
* Content</code> error. If so, retry with a smaller limit.
162168
*
163169
* @return limit
164170
*/
@@ -179,7 +185,8 @@ public ProcessTimeseriesQuery metric(String metric) {
179185
}
180186

181187
/**
182-
* The process metric to query.
188+
* The process metric to query, such as <code>process.stat.cpu.total_pct</code>, <code>
189+
* process.stat.memory.rss</code>, or <code>process.stat.memory.vms</code>.
183190
*
184191
* @return metric
185192
*/
@@ -252,7 +259,9 @@ public ProcessTimeseriesQuery addTagFiltersItem(String tagFiltersItem) {
252259
}
253260

254261
/**
255-
* Tag filters to narrow down processes.
262+
* Tags to narrow down processes. To scope to one process, use its <code>identifying_tags</code>
263+
* from <code>GET /api/v2/processes</code>, for example <code>host:web-01</code> and <code>
264+
* pid:1234</code>.
256265
*
257266
* @return tagFilters
258267
*/

0 commit comments

Comments
 (0)