@grow-codes/signoz - v0.1.1
    Preparing search index...

    Class AggregateBuilder

    Fluent builder for SigNoz aggregations (requestType: scalar or time_series), e.g. query.aggregate("traces").count("calls").p99("duration_nano", "p99").groupBy("name").run(). Aliases are mapped back from SigNoz's __result_<i> columns by aggregation index. Default window: the last hour.

    Index
    signal: SignozSignal
    • avg(field).

      Parameters

      • field: string
      • Optionalalias: string

      Returns this

    • Time window (default: the last hour).

      Parameters

      • start: Date
      • end: Date

      Returns this

    • count().

      Parameters

      • Optionalalias: string

      Returns this

    • count_distinct(field).

      Parameters

      • field: string
      • Optionalalias: string

      Returns this

    • Adds any aggregation expression.

      Parameters

      • expression: string
      • Optionalalias: string

      Returns this

    • Maximum number of groups.

      Parameters

      • limit: number

      Returns this

    • max(field).

      Parameters

      • field: string
      • Optionalalias: string

      Returns this

    • min(field).

      Parameters

      • field: string
      • Optionalalias: string

      Returns this

    • Orders by a group field or an aggregation alias/expression.

      Parameters

      • key: string
      • direction: "asc" | "desc" = "desc"

      Returns this

    • p50(field) (default field duration_nano).

      Parameters

      • field: string = "duration_nano"
      • Optionalalias: string

      Returns this

    • p90(field).

      Parameters

      • field: string = "duration_nano"
      • Optionalalias: string

      Returns this

    • p95(field).

      Parameters

      • field: string = "duration_nano"
      • Optionalalias: string

      Returns this

    • p99(field).

      Parameters

      • field: string = "duration_nano"
      • Optionalalias: string

      Returns this

    • p<percentile>(field); percentile is one of 5, 10, 20, 25, 50, 75, 90, 95, 99.

      Parameters

      • percentile: number
      • field: string = "duration_nano"
      • Optionalalias: string

      Returns this

    • sum(field).

      Parameters

      • field: string
      • Optionalalias: string

      Returns this

    • Runs a time-series query with buckets of stepSeconds (default: chosen by SigNoz).

      Parameters

      • OptionalstepSeconds: number
      • options: { signal?: AbortSignal } = {}

      Returns Promise<AggregateSeries[]>

    • The request body that run / timeSeries send (for inspection).

      Parameters

      • requestType: "scalar" | "time_series" = "scalar"
      • OptionalstepSeconds: number

      Returns Record<string, unknown>