Add instrumentation (issue 22572)

pkg/analyzer/lib/instrumentation/instrumentation.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library instrumentation;
 
 /**
  * A container with analysis performance constants.
  */
 class AnalysisPerformanceKind {
@@ skipping 35 matching lines @@
  * The interface used by client code to communicate with an instrumentation
  * server by wrapping an [InstrumentationServer].
  */
 class InstrumentationService {
   /**
    * An instrumentation service that will not log any instrumentation data.
    */
   static final InstrumentationService NULL_SERVICE =
       new InstrumentationService(null);
 
+  static const String TAG_ANALYSIS_TASK = 'Task';
   static const String TAG_ERROR = 'Err';
   static const String TAG_EXCEPTION = 'Ex';
   static const String TAG_FILE_READ = 'Read';
   static const String TAG_LOG_ENTRY = 'Log';
   static const String TAG_NOTIFICATION = 'Noti';
   static const String TAG_PERFORMANCE = 'Perf';
   static const String TAG_REQUEST = 'Req';
   static const String TAG_RESPONSE = 'Res';
   static const String TAG_VERSION = 'Ver';
+  static const String TAG_WATCH_EVENT = 'Watch';
 
   /**
    * The instrumentation server used to communicate with the server, or `null`
    * if instrumentation data should not be logged.
    */
   InstrumentationServer _instrumentationServer;
 
   /**
    * Initialize a newly created instrumentation service to comunicate with the
    * given [instrumentationServer].
    */
   InstrumentationService(this._instrumentationServer);
 
   /**
    * Return `true` if this [InstrumentationService] was initialized with a
    * non-`null` server (and hence instrumentation is active).
    */
   bool get isActive => _instrumentationServer != null;
 
   /**
    * The current time, expressed as a decimal encoded number of milliseconds.
    */
   String get _timestamp => new DateTime.now().millisecondsSinceEpoch.toString();
 
   /**
+   * Log that an analysis task is being performed in the given [context]. The
+   * task has the given [description].
+   */
+  void logAnalysisTask(String context, String description) {
+    if (_instrumentationServer != null) {
+      _instrumentationServer.log(
+          _join([TAG_ANALYSIS_TASK, context, description]));
+    }
+  }
+
+  /**
    * Log the fact that an error, described by the given [message], has occurred.
    */
   void logError(String message) {
     _log(TAG_ERROR, message);
   }
 
   /**
    * Log that the given non-priority [exception] was thrown, with the given
    * [stackTrace].
    */
@@ skipping 94 matching lines @@
                   TAG_VERSION,
                   uuid,
                   normalize(clientId),
                   normalize(clientVersion),
                   serverVersion,
                   sdkVersion]));
     }
   }
 
   /**
+   * Log that the file system watcher sent an event. The [folderPath] is the
+   * path to the folder containing the changed file, the [filePath] is the path
+   * of the file that changed, and the [changeType] indicates what kind of
+   * change occurred.
+   */
+  void logWatchEvent(String folderPath, String filePath, String changeType) {
+    if (_instrumentationServer != null) {
+      _instrumentationServer.log(
+          _join([TAG_WATCH_EVENT, folderPath, filePath, changeType]));
+    }
+  }
+
+  /**
    * Signal that the client is done communicating with the instrumentation
    * server. This method should be invoked exactly one time and no other methods
    * should be invoked on this instance after this method has been invoked.
    */
   void shutdown() {
     if (_instrumentationServer != null) {
       _instrumentationServer.shutdown();
       _instrumentationServer = null;
     }
   }
@@ skipping 73 matching lines @@
     }
   }
 
   @override
   void shutdown() {
     for (InstrumentationServer server in _servers) {
       server.shutdown();
     }
   }
 }