Interface: QuerySquidMetricsRequest<NameType>
Type parameters
| Name | Type |
|---|---|
NameType | extends SquidMetricName = SquidMetricName |
Hierarchy
↳
QuerySquidMetricsRequest
Properties
domain
• domain: "squid"
Kind of the metrics (domain) to query.
Overrides
QueryMetricsRequestCommon.domain
fillValue
• Optional fillValue: null | number
If there is no data in the specified region this value will be used to fill the gap. Default: null.
Inherited from
QueryMetricsRequestCommon.fillValue
fn
• fn: "sum" | "max" | "min" | "average" | "median" | "p95" | "p99" | "count" | ("sum" | "max" | "min" | "average" | "median" | "p95" | "p99" | "count")[]
Aggregation functions that maps multiple points per point region to a single point value.
Inherited from
groupByTags
• Optional groupByTags: string[]
List of ordered tag names for a 'GROUP BY'.
Inherited from
QueryMetricsRequestCommon.groupByTags
name
• name: NameType
User metric name.
noDataBehavior
• Optional noDataBehavior: "return-no-result-groups" | "return-result-group-with-default-values"
Specifies what result will be returned if there were no records found in the database. In this case the 'resultGroups' array will be empty (default), or can be filled with a default values if 'return-result-group-with-default-values' is specified. The generated result group will have 'tagValues' set to empty strings.
May be useful to get a ready-to-render array with no additional post-processing required.
Note: 'tagDomains' can provide similar functionality when set of tag values is defined: multiple result groups will be filled with default values. There is no need to use this option if 'tagDomains' is used.
Default: 'return-no-result-groups'
Inherited from
QueryMetricsRequestCommon.noDataBehavior
orderByTags
• Optional orderByTags: string[]
The results will be ordered by the specified tags (ORDER BY).
Inherited from
QueryMetricsRequestCommon.orderByTags
periodEndSeconds
• periodEndSeconds: number
End of the queried interval. Must be an integer value.
Inherited from
QueryMetricsRequestCommon.periodEndSeconds
periodStartSeconds
• periodStartSeconds: number
Start of the queried interval. Must be an integer value.
Inherited from
QueryMetricsRequestCommon.periodStartSeconds
pointIntervalAlignment
• Optional pointIntervalAlignment: "align-by-start-time" | "align-by-end-time"
Specifies the alignment of the per-point interval. Default: 'align-by-start-time'
Inherited from
QueryMetricsRequestCommon.pointIntervalAlignment
pointIntervalSeconds
• Optional pointIntervalSeconds: number
Time interval per point. Must be less than periodEndSeconds - periodStartSeconds. Set to 0 or keep undefined to have only 1 value in the result.
Inherited from
QueryMetricsRequestCommon.pointIntervalSeconds
tagDomains
• Optional tagDomains: Record<string, string[]>
A mapping of known tag values that must be present in the response groups.
This ensures that the result will include groups for all specified tag values, even if there is no data for some values in the database.
Example: Consider a tag 'isError' with two possible values: '0' and '1'. When 'tagDomains' contains {'isError': ['0', '1']}, the result will include groups for both 'isError: 0' and 'isError: 1'. If the database lacks data for 'isError: 1', the points in this group will be set to 'fillValue' (default is 'null').
The tags in the new groups will be copied from the existing resultGroups, along with one of the tag domain values.
Inherited from
QueryMetricsRequestCommon.tagDomains
tagFilter
• Optional tagFilter: Record<string, string>
Tag filters. TODO: add operations to exclude tags: !=, !contains...