@@ -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
0 commit comments