controller/aggregation/counter_aggregation_controller.ts

// Copyright (C) 2020 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import {Duration} from '../../base/time';
import {ColumnDef} from '../../common/aggregation_data';
import {Area, Sorting} from '../../common/state';
import {globals} from '../../frontend/globals';
import {Engine} from '../../trace_processor/engine';
import {COUNTER_TRACK_KIND} from '../../core_plugins/counter';

import {AggregationController} from './aggregation_controller';

export class CounterAggregationController extends AggregationController {
  async createAggregateView(engine: Engine, area: Area) {
    await engine.query(`drop view if exists ${this.kind};`);

    const trackIds: (string | number)[] = [];
    for (const trackKey of area.tracks) {
      const track = globals.state.tracks[trackKey];
      if (track?.uri) {
        const trackInfo = globals.trackManager.resolveTrackInfo(track.uri);
        if (trackInfo?.kind === COUNTER_TRACK_KIND) {
          trackInfo.trackIds && trackIds.push(...trackInfo.trackIds);
        }
      }
    }
    if (trackIds.length === 0) return false;
    const duration = area.end - area.start;
    const durationSec = Duration.toSeconds(duration);

    // TODO(lalitm): Rewrite this query in a way that is both simpler and faster
    let query;
    if (trackIds.length === 1) {
      // Optimized query for the special case where there is only 1 track id.
      query = `CREATE VIEW ${this.kind} AS
      WITH aggregated AS (
        SELECT
          COUNT(1) AS count,
          ROUND(SUM(
            (MIN(ts + dur, ${area.end}) - MAX(ts,${area.start}))*value)/${duration},
            2
          ) AS avg_value,
          (SELECT value FROM experimental_counter_dur WHERE track_id = ${trackIds[0]}
            AND ts + dur >= ${area.start}
            AND ts <= ${area.end} ORDER BY ts DESC LIMIT 1)
            AS last_value,
          (SELECT value FROM experimental_counter_dur WHERE track_id = ${trackIds[0]}
            AND ts + dur >= ${area.start}
            AND ts <= ${area.end} ORDER BY ts ASC LIMIT 1)
            AS first_value,
          MIN(value) AS min_value,
          MAX(value) AS max_value
        FROM experimental_counter_dur
          WHERE track_id = ${trackIds[0]}
          AND ts + dur >= ${area.start}
          AND ts <= ${area.end})
      SELECT
        (SELECT name FROM counter_track WHERE id = ${trackIds[0]}) AS name,
        *,
        MAX(last_value) - MIN(first_value) AS delta_value,
        ROUND((MAX(last_value) - MIN(first_value))/${durationSec}, 2) AS rate
      FROM aggregated`;
    } else {
      // Slower, but general purspose query that can aggregate multiple tracks
      query = `CREATE VIEW ${this.kind} AS
      WITH aggregated AS (
        SELECT track_id,
          COUNT(1) AS count,
          ROUND(SUM(
            (MIN(ts + dur, ${area.end}) - MAX(ts,${area.start}))*value)/${duration},
            2
          ) AS avg_value,
          value_at_max_ts(-ts, value) AS first,
          value_at_max_ts(ts, value) AS last,
          MIN(value) AS min_value,
          MAX(value) AS max_value
        FROM experimental_counter_dur
          WHERE track_id IN (${trackIds})
          AND ts + dur >= ${area.start} AND
          ts <= ${area.end}
        GROUP BY track_id
      )
      SELECT
        name,
        count,
        avg_value,
        last AS last_value,
        first AS first_value,
        last - first AS delta_value,
        ROUND((last - first)/${durationSec}, 2) AS rate,
        min_value,
        max_value
      FROM aggregated JOIN counter_track ON
        track_id = counter_track.id
      GROUP BY track_id`;
    }
    await engine.query(query);
    return true;
  }

  getColumnDefinitions(): ColumnDef[] {
    return [
      {
        title: 'Name',
        kind: 'STRING',
        columnConstructor: Uint16Array,
        columnId: 'name',
      },
      {
        title: 'Delta value',
        kind: 'NUMBER',
        columnConstructor: Float64Array,
        columnId: 'delta_value',
      },
      {
        title: 'Rate /s',
        kind: 'Number',
        columnConstructor: Float64Array,
        columnId: 'rate',
      },
      {
        title: 'Weighted avg value',
        kind: 'Number',
        columnConstructor: Float64Array,
        columnId: 'avg_value',
      },
      {
        title: 'Count',
        kind: 'Number',
        columnConstructor: Float64Array,
        columnId: 'count',
        sum: true,
      },
      {
        title: 'First value',
        kind: 'NUMBER',
        columnConstructor: Float64Array,
        columnId: 'first_value',
      },
      {
        title: 'Last value',
        kind: 'NUMBER',
        columnConstructor: Float64Array,
        columnId: 'last_value',
      },
      {
        title: 'Min value',
        kind: 'NUMBER',
        columnConstructor: Float64Array,
        columnId: 'min_value',
      },
      {
        title: 'Max value',
        kind: 'NUMBER',
        columnConstructor: Float64Array,
        columnId: 'max_value',
      },
    ];
  }

  async getExtra() {}

  getTabName() {
    return 'Counters';
  }

  getDefaultSorting(): Sorting {
    return {column: 'name', direction: 'DESC'};
  }
}