@@ -4581,13 +4581,58 @@ components:
45814581 - requests
45824582 type: object
45834583 HostMapWidgetDefinitionRequests:
4584- description: List of definitions.
4584+ description: >-
4585+ 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`).
45854586 example: {}
45864587 properties:
4588+ child:
4589+ $ref: "#/components/schemas/HostMapWidgetInfrastructureRequest"
4590+ conditional_formats:
4591+ description: List of conditional formatting rules applied to fill values.
4592+ items:
4593+ $ref: "#/components/schemas/WidgetConditionalFormat"
4594+ type: array
4595+ enrichments:
4596+ description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
4597+ example:
4598+ - formulas:
4599+ - dimension: fill
4600+ formula: "query1"
4601+ queries:
4602+ - data_source: metrics
4603+ name: "query1"
4604+ query: "avg:system.cpu.user{*} by {host}"
4605+ response_format: scalar
4606+ items:
4607+ $ref: "#/components/schemas/HostMapWidgetScalarRequest"
4608+ type: array
45874609 fill:
45884610 $ref: "#/components/schemas/HostMapRequest"
4611+ filter:
4612+ description: Filter string for the entity set in tag format (for example, `env:prod`).
4613+ example: "env:prod"
4614+ type: string
4615+ group_by:
4616+ description: |-
4617+ Defines how entities are grouped into tiles. The ordering of entries implies
4618+ the grouping hierarchy.
4619+ items:
4620+ $ref: "#/components/schemas/HostMapWidgetGroupBy"
4621+ type: array
4622+ no_group_hosts:
4623+ description: Whether to hide entities that have no group assignment.
4624+ type: boolean
4625+ no_metric_hosts:
4626+ description: Whether to hide entities that have no enrichment data.
4627+ type: boolean
4628+ node_type:
4629+ $ref: "#/components/schemas/HostMapWidgetNodeType"
4630+ request_type:
4631+ $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType"
45894632 size:
45904633 $ref: "#/components/schemas/HostMapRequest"
4634+ style:
4635+ $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
45914636 type: object
45924637 HostMapWidgetDefinitionStyle:
45934638 description: The style to apply to the widget.
@@ -4614,6 +4659,239 @@ components:
46144659 type: string
46154660 x-enum-varnames:
46164661 - HOSTMAP
4662+ HostMapWidgetDimension:
4663+ description: Visual dimension driven by a formula in the infrastructure host map widget.
4664+ enum:
4665+ - node
4666+ - fill
4667+ - size
4668+ example: node
4669+ type: string
4670+ x-enum-varnames:
4671+ - NODE
4672+ - FILL
4673+ - SIZE
4674+ HostMapWidgetFormula:
4675+ description: |-
4676+ Formula for the infrastructure host map widget that specifies both the expression
4677+ and the visual dimension it populates.
4678+ properties:
4679+ alias:
4680+ description: Expression alias.
4681+ example: "my-metric"
4682+ type: string
4683+ dimension:
4684+ $ref: "#/components/schemas/HostMapWidgetDimension"
4685+ formula:
4686+ description: String expression built from queries, formulas, and functions.
4687+ example: "query1"
4688+ type: string
4689+ number_format:
4690+ $ref: "#/components/schemas/WidgetNumberFormat"
4691+ required:
4692+ - formula
4693+ - dimension
4694+ type: object
4695+ HostMapWidgetGroupBy:
4696+ description: Defines a grouping dimension for the infrastructure host map.
4697+ properties:
4698+ column:
4699+ description: Column name from the entity table (for example, `cloud_provider`, `tags`, `labels`).
4700+ example: tags
4701+ type: string
4702+ key:
4703+ description: Key within the column for nested attribute types (for example, `service` within `tags`).
4704+ example: service
4705+ type: string
4706+ required:
4707+ - column
4708+ type: object
4709+ HostMapWidgetInfrastructureRequest:
4710+ description: |-
4711+ Infrastructure-backed request for the host map widget. Supports entity-based
4712+ visualization with metric query enrichments, tag-based filtering, flexible grouping,
4713+ and hierarchical views.
4714+ properties:
4715+ child:
4716+ $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestLeaf"
4717+ description: |-
4718+ Optional child request for hierarchical visualization (for example, hosts containing
4719+ containers). Maximum one level of nesting.
4720+ conditional_formats:
4721+ description: List of conditional formatting rules applied to fill values.
4722+ items:
4723+ $ref: "#/components/schemas/WidgetConditionalFormat"
4724+ type: array
4725+ enrichments:
4726+ description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
4727+ example:
4728+ - formulas:
4729+ - dimension: fill
4730+ formula: "query1"
4731+ queries:
4732+ - data_source: metrics
4733+ name: "query1"
4734+ query: "avg:system.cpu.user{*} by {host}"
4735+ response_format: scalar
4736+ items:
4737+ $ref: "#/components/schemas/HostMapWidgetScalarRequest"
4738+ type: array
4739+ filter:
4740+ description: Filter string for the entity set in tag format (for example, `env:prod`).
4741+ example: "env:prod"
4742+ type: string
4743+ group_by:
4744+ description: |-
4745+ Defines how entities are grouped into tiles. The ordering of entries implies
4746+ the grouping hierarchy.
4747+ items:
4748+ $ref: "#/components/schemas/HostMapWidgetGroupBy"
4749+ type: array
4750+ no_group_hosts:
4751+ description: Whether to hide entities that have no group assignment.
4752+ type: boolean
4753+ no_metric_hosts:
4754+ description: Whether to hide entities that have no enrichment data.
4755+ type: boolean
4756+ node_type:
4757+ $ref: "#/components/schemas/HostMapWidgetNodeType"
4758+ request_type:
4759+ $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType"
4760+ style:
4761+ $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
4762+ required:
4763+ - request_type
4764+ - node_type
4765+ - enrichments
4766+ type: object
4767+ HostMapWidgetInfrastructureRequestLeaf:
4768+ description: Infrastructure-backed host map child request (leaf node, no further nesting supported).
4769+ properties:
4770+ conditional_formats:
4771+ description: List of conditional formatting rules applied to fill values.
4772+ items:
4773+ $ref: "#/components/schemas/WidgetConditionalFormat"
4774+ type: array
4775+ enrichments:
4776+ description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
4777+ example:
4778+ - formulas:
4779+ - dimension: fill
4780+ formula: "query1"
4781+ queries:
4782+ - data_source: metrics
4783+ name: "query1"
4784+ query: "avg:system.cpu.user{*} by {host}"
4785+ response_format: scalar
4786+ items:
4787+ $ref: "#/components/schemas/HostMapWidgetScalarRequest"
4788+ type: array
4789+ filter:
4790+ description: Filter string for the entity set in tag format (for example, `env:prod`).
4791+ example: "env:prod"
4792+ type: string
4793+ group_by:
4794+ description: |-
4795+ Defines how entities are grouped into tiles. The ordering of entries implies
4796+ the grouping hierarchy.
4797+ items:
4798+ $ref: "#/components/schemas/HostMapWidgetGroupBy"
4799+ type: array
4800+ no_group_hosts:
4801+ description: Whether to hide entities that have no group assignment.
4802+ type: boolean
4803+ no_metric_hosts:
4804+ description: Whether to hide entities that have no enrichment data.
4805+ type: boolean
4806+ node_type:
4807+ $ref: "#/components/schemas/HostMapWidgetNodeType"
4808+ request_type:
4809+ $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType"
4810+ style:
4811+ $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
4812+ required:
4813+ - request_type
4814+ - node_type
4815+ - enrichments
4816+ type: object
4817+ HostMapWidgetInfrastructureRequestRequestType:
4818+ description: Identifies this as an infrastructure-backed host map request.
4819+ enum:
4820+ - infrastructure_hostmap
4821+ example: infrastructure_hostmap
4822+ type: string
4823+ x-enum-varnames:
4824+ - INFRASTRUCTURE_HOSTMAP
4825+ HostMapWidgetInfrastructureStyle:
4826+ description: Style configuration for the infrastructure host map.
4827+ properties:
4828+ fill_max:
4829+ description: Maximum value for the fill color scale. Omit to use automatic scaling.
4830+ format: double
4831+ type: number
4832+ fill_min:
4833+ description: Minimum value for the fill color scale. Omit to use automatic scaling.
4834+ format: double
4835+ type: number
4836+ palette:
4837+ description: Color palette name or alias.
4838+ example: hostmap_blues
4839+ type: string
4840+ palette_flip:
4841+ description: Whether to invert the color palette.
4842+ type: boolean
4843+ type: object
4844+ HostMapWidgetNodeType:
4845+ description: Which type of infrastructure entity to visualize in the host map.
4846+ enum:
4847+ - host
4848+ - container
4849+ - pod
4850+ - cluster
4851+ example: host
4852+ type: string
4853+ x-enum-varnames:
4854+ - HOST
4855+ - CONTAINER
4856+ - POD
4857+ - CLUSTER
4858+ HostMapWidgetScalarRequest:
4859+ description: |-
4860+ Scalar formula request for the infrastructure host map widget. Each formula specifies
4861+ which visual dimension it drives.
4862+ properties:
4863+ formulas:
4864+ description: List of formulas that operate on queries, each assigned to a visual dimension.
4865+ example:
4866+ - dimension: fill
4867+ formula: "query1"
4868+ items:
4869+ $ref: "#/components/schemas/HostMapWidgetFormula"
4870+ type: array
4871+ queries:
4872+ description: List of queries that can be returned directly or used in formulas.
4873+ example:
4874+ - data_source: "metrics"
4875+ name: "my_query"
4876+ query: "avg:system.cpu.user{*}"
4877+ items:
4878+ $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
4879+ type: array
4880+ response_format:
4881+ $ref: "#/components/schemas/HostMapWidgetScalarRequestResponseFormat"
4882+ required:
4883+ - response_format
4884+ - queries
4885+ - formulas
4886+ type: object
4887+ HostMapWidgetScalarRequestResponseFormat:
4888+ description: Response format for the scalar formula request. Only `scalar` is supported.
4889+ enum:
4890+ - scalar
4891+ example: scalar
4892+ type: string
4893+ x-enum-varnames:
4894+ - SCALAR
46174895 HostMeta:
46184896 description: Metadata associated with your host.
46194897 properties:
0 commit comments