Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
280 changes: 279 additions & 1 deletion .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4581,13 +4581,58 @@ components:
- requests
type: object
HostMapWidgetDefinitionRequests:
description: List of definitions.
description: >-
Query definition for the host map widget. Supports two mutually exclusive formats distinguished by the presence of `request_type`: the legacy metric-based format (`fill`/`size`) and the infrastructure-backed format (`request_type`, `node_type`, `enrichments`).
example: {}
properties:
child:
$ref: "#/components/schemas/HostMapWidgetInfrastructureRequest"
conditional_formats:
description: List of conditional formatting rules applied to fill values.
items:
$ref: "#/components/schemas/WidgetConditionalFormat"
type: array
enrichments:
description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
example:
- formulas:
- dimension: fill
formula: "query1"
queries:
- data_source: metrics
name: "query1"
query: "avg:system.cpu.user{*} by {host}"
response_format: scalar
items:
$ref: "#/components/schemas/HostMapWidgetScalarRequest"
type: array
fill:
$ref: "#/components/schemas/HostMapRequest"
filter:
description: Filter string for the entity set in tag format (for example, `env:prod`).
example: "env:prod"
type: string
group_by:
description: |-
Defines how entities are grouped into tiles. The ordering of entries implies
the grouping hierarchy.
items:
$ref: "#/components/schemas/HostMapWidgetGroupBy"
type: array
no_group_hosts:
description: Whether to hide entities that have no group assignment.
type: boolean
no_metric_hosts:
description: Whether to hide entities that have no enrichment data.
type: boolean
node_type:
$ref: "#/components/schemas/HostMapWidgetNodeType"
request_type:
$ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType"
size:
$ref: "#/components/schemas/HostMapRequest"
style:
$ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
type: object
HostMapWidgetDefinitionStyle:
description: The style to apply to the widget.
Expand All @@ -4614,6 +4659,239 @@ components:
type: string
x-enum-varnames:
- HOSTMAP
HostMapWidgetDimension:
description: Visual dimension driven by a formula in the infrastructure host map widget.
enum:
- node
- fill
- size
example: node
type: string
x-enum-varnames:
- NODE
- FILL
- SIZE
HostMapWidgetFormula:
description: |-
Formula for the infrastructure host map widget that specifies both the expression
and the visual dimension it populates.
properties:
alias:
description: Expression alias.
example: "my-metric"
type: string
dimension:
$ref: "#/components/schemas/HostMapWidgetDimension"
formula:
description: String expression built from queries, formulas, and functions.
example: "query1"
type: string
number_format:
$ref: "#/components/schemas/WidgetNumberFormat"
required:
- formula
- dimension
type: object
HostMapWidgetGroupBy:
description: Defines a grouping dimension for the infrastructure host map.
properties:
column:
description: Column name from the entity table (for example, `cloud_provider`, `tags`, `labels`).
example: tags
type: string
key:
description: Key within the column for nested attribute types (for example, `service` within `tags`).
example: service
type: string
required:
- column
type: object
HostMapWidgetInfrastructureRequest:
description: |-
Infrastructure-backed request for the host map widget. Supports entity-based
visualization with metric query enrichments, tag-based filtering, flexible grouping,
and hierarchical views.
properties:
child:
$ref: "#/components/schemas/HostMapWidgetInfrastructureRequestLeaf"
description: |-
Optional child request for hierarchical visualization (for example, hosts containing
containers). Maximum one level of nesting.
conditional_formats:
description: List of conditional formatting rules applied to fill values.
items:
$ref: "#/components/schemas/WidgetConditionalFormat"
type: array
enrichments:
description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
example:
- formulas:
- dimension: fill
formula: "query1"
queries:
- data_source: metrics
name: "query1"
query: "avg:system.cpu.user{*} by {host}"
response_format: scalar
items:
$ref: "#/components/schemas/HostMapWidgetScalarRequest"
type: array
filter:
description: Filter string for the entity set in tag format (for example, `env:prod`).
example: "env:prod"
type: string
group_by:
description: |-
Defines how entities are grouped into tiles. The ordering of entries implies
the grouping hierarchy.
items:
$ref: "#/components/schemas/HostMapWidgetGroupBy"
type: array
no_group_hosts:
description: Whether to hide entities that have no group assignment.
type: boolean
no_metric_hosts:
description: Whether to hide entities that have no enrichment data.
type: boolean
node_type:
$ref: "#/components/schemas/HostMapWidgetNodeType"
request_type:
$ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType"
style:
$ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
required:
- request_type
- node_type
- enrichments
type: object
HostMapWidgetInfrastructureRequestLeaf:
description: Infrastructure-backed host map child request (leaf node, no further nesting supported).
properties:
conditional_formats:
description: List of conditional formatting rules applied to fill values.
items:
$ref: "#/components/schemas/WidgetConditionalFormat"
type: array
enrichments:
description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
example:
- formulas:
- dimension: fill
formula: "query1"
queries:
- data_source: metrics
name: "query1"
query: "avg:system.cpu.user{*} by {host}"
response_format: scalar
items:
$ref: "#/components/schemas/HostMapWidgetScalarRequest"
type: array
filter:
description: Filter string for the entity set in tag format (for example, `env:prod`).
example: "env:prod"
type: string
group_by:
description: |-
Defines how entities are grouped into tiles. The ordering of entries implies
the grouping hierarchy.
items:
$ref: "#/components/schemas/HostMapWidgetGroupBy"
type: array
no_group_hosts:
description: Whether to hide entities that have no group assignment.
type: boolean
no_metric_hosts:
description: Whether to hide entities that have no enrichment data.
type: boolean
node_type:
$ref: "#/components/schemas/HostMapWidgetNodeType"
request_type:
$ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType"
style:
$ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
required:
- request_type
- node_type
- enrichments
type: object
HostMapWidgetInfrastructureRequestRequestType:
description: Identifies this as an infrastructure-backed host map request.
enum:
- infrastructure_hostmap
example: infrastructure_hostmap
type: string
x-enum-varnames:
- INFRASTRUCTURE_HOSTMAP
HostMapWidgetInfrastructureStyle:
description: Style configuration for the infrastructure host map.
properties:
fill_max:
description: Maximum value for the fill color scale. Omit to use automatic scaling.
format: double
type: number
fill_min:
description: Minimum value for the fill color scale. Omit to use automatic scaling.
format: double
type: number
palette:
description: Color palette name or alias.
example: hostmap_blues
type: string
palette_flip:
description: Whether to invert the color palette.
type: boolean
type: object
HostMapWidgetNodeType:
description: Which type of infrastructure entity to visualize in the host map.
enum:
- host
- container
- pod
- cluster
example: host
type: string
x-enum-varnames:
- HOST
- CONTAINER
- POD
- CLUSTER
HostMapWidgetScalarRequest:
description: |-
Scalar formula request for the infrastructure host map widget. Each formula specifies
which visual dimension it drives.
properties:
formulas:
description: List of formulas that operate on queries, each assigned to a visual dimension.
example:
- dimension: fill
formula: "query1"
items:
$ref: "#/components/schemas/HostMapWidgetFormula"
type: array
queries:
description: List of queries that can be returned directly or used in formulas.
example:
- data_source: "metrics"
name: "my_query"
query: "avg:system.cpu.user{*}"
items:
$ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
type: array
response_format:
$ref: "#/components/schemas/HostMapWidgetScalarRequestResponseFormat"
required:
- response_format
- queries
- formulas
type: object
HostMapWidgetScalarRequestResponseFormat:
description: Response format for the scalar formula request. Only `scalar` is supported.
enum:
- scalar
example: scalar
type: string
x-enum-varnames:
- SCALAR
HostMeta:
description: Metadata associated with your host.
properties:
Expand Down
70 changes: 70 additions & 0 deletions docs/datadog_api_client.v1.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1467,6 +1467,76 @@ datadog\_api\_client.v1.model.host\_map\_widget\_definition\_type module
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_dimension module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_dimension
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_formula module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_formula
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_group\_by module
-----------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_group_by
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_infrastructure\_request module
-------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_infrastructure_request
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_infrastructure\_request\_leaf module
-------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_infrastructure_request_leaf
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_infrastructure\_request\_request\_type module
----------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_infrastructure_request_request_type
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_infrastructure\_style module
-----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_infrastructure_style
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_node\_type module
------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_node_type
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_scalar\_request module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_scalar_request
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_map\_widget\_scalar\_request\_response\_format module
-----------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.host_map_widget_scalar_request_response_format
:members:
:show-inheritance:

datadog\_api\_client.v1.model.host\_meta module
-----------------------------------------------

Expand Down
Loading
Loading