android/src/com/android/tools/idea/stats/StatsTimeCollector.java

/*
 * Copyright (C) 2014 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.
 */
package com.android.tools.idea.stats;

import com.android.annotations.NonNull;
import gnu.trove.TObjectLongHashMap;

/**
 * Helper to use StudioBuildStatsPersistenceComponent to capture times intervals.
 * <p/>
 * Usage:
 * <pre>
 *   StatsTimeCollector.start(StatsKeys.SOME_KEY);
 *   ...action to measure...
 *   StatsTimeCollector.stop(StatsKeys.SOME_KEY);
 * </pre>
 *
 * <em>Note: StudioBuildStatsPersistenceComponent is only enabled in Android Studio
 * and thus collected times here are only served from that product and in accordance
 * with the Usage Statistics setting panel. This is by design.</em>
 */
public class StatsTimeCollector {
  private static final boolean isEnabled = StudioBuildStatsPersistenceComponent.getInstance() != null;
  private static final TObjectLongHashMap<String> myTimestampMap = new TObjectLongHashMap<String>();

  /**
   * Registers a build start event for the given stat key.
   * Timers are not nested and this replaces the last start value for the given key.
   * <p/>
   * This is a no-op if StudioBuildStatsPersistenceComponent is not available.
   *
   * @param key A key representing the action being timed.
   */
  public static void start(@NonNull String key) {
    if (!isEnabled) {
      return;
    }
    synchronized (myTimestampMap) {
      myTimestampMap.put(key, System.currentTimeMillis());
    }
  }

  /**
   * Registers a build stop event for the given stat key.
   * This generates a BuildRecord that will be sent in the next stats upload.
   * Does nothing if there hasn't been any corresponding start event.
   * <p/>
   * This is a no-op if StudioBuildStatsPersistenceComponent is not available.
   *
   * @param key A key representing the action being timed.
   */
  public static void stop(@NonNull String key) {
    if (!isEnabled) {
      return;
    }
    try {
      long now = System.currentTimeMillis();
      long start;
      synchronized (myTimestampMap) {
        start = myTimestampMap.remove(key);
      }
      if (start > 0 && start < now) {
        StudioBuildStatsPersistenceComponent stats = StudioBuildStatsPersistenceComponent.getInstance();
        if (stats != null) {
          BuildRecord record = new BuildRecord(key, Long.toString(now - start));
          stats.addBuildRecord(record);
        }
      }
    } catch (Throwable ignore) {
    }
  }

}