Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetricsQueryOptions

Package version

Options used when querying metrics.

Hierarchy

  • any
    • MetricsQueryOptions

Index

Properties

Optional aggregations

aggregations: AggregationType[]

The list of aggregation types (comma separated) to retrieve.

Optional filter

filter: undefined | string

The $filter is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
$filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’
- Invalid variant:
$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
$filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’
- Return all time series where A = a1
$filter=A eq ‘a1’ and B eq ‘’ and C eq ‘.

Optional granularity

granularity: undefined | string

The interval (i.e. timegrain) of the query. Durations helper contains aliases for some common ISO8601 durations. This is an ISO8601 duration value in the format P[n]Y[n]M[n]DT[n]H[n]M[n]S where P is the duration designator (for period) placed at the start of the duration representation. Y is the year designator that follows the value for the number of years. M is the month designator that follows the value for the number of months. W is the week designator that follows the value for the number of weeks. D is the day designator that follows the value for the number of days. T is the time designator that precedes the time components of the representation. H is the hour designator that follows the value for the number of hours. M is the minute designator that follows the value for the number of minutes. S is the second designator that follows the value for the number of seconds.

Optional metricNamespace

metricNamespace: undefined | string

Metric namespace to query metric definitions for.

Optional orderBy

orderBy: undefined | string

The aggregation to use for sorting results and the direction of the sort. Only one order can be specified. Examples: sum asc.

Optional resultType

resultType: ResultType

Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.

Optional timespan

timespan: TimeInterval

The enclosing timespan for metrics.

Optional top

top: undefined | number

The maximum number of records to retrieve. Valid only if $filter is specified. Defaults to 10.

Generated using TypeDoc