Class ProcessScalarQuery

Per-process metrics from Live Processes. Queries without aggregator fail. To scope to one process, set tag_filters to its identifying_tags from GET /api/v2/processes.

Hierarchy

  • ProcessScalarQuery

Constructors

constructor

Properties

additionalProperties? aggregator? crossOrgUuids? dataSource isNormalizedCpu? limit? metric name sort? tagFilters? textFilter?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional aggregator

aggregator?: MetricsAggregator

The type of aggregation that can be performed on metrics-based queries.

Optional crossOrgUuids

crossOrgUuids?: string[]

Organization UUIDs to query when using cross-organization visibility. Limited to one organization UUID.

dataSource

dataSource: ProcessDataSource

A data source for process-level infrastructure metrics.

Optional isNormalizedCpu

isNormalizedCpu?: boolean

Whether CPU metrics should be normalized by core count.

Optional limit

limit?: number

Maximum number of processes or groups to return. Large values can fail with an Unprocessable Content error. If so, retry with a smaller limit.

metric

metric: string

The process metric to query, such as process.stat.cpu.total_pct, process.stat.memory.rss, or process.stat.memory.vms.

name

name: string

The variable name for use in formulas.

Optional sort

sort?: v2.QuerySortOrder

Direction of sort.

Optional tagFilters

tagFilters?: string[]

Tags to narrow down processes. To scope to one process, use its identifying_tags from GET /api/v2/processes, for example host:web-01 and pid:1234.

Optional textFilter

textFilter?: string

A full-text search filter to match process names or commands.

Settings

Member Visibility

Theme

Generated using TypeDoc