Add instrumentation data to the analysis server diagnostics page.

pkg/analysis_server/lib/src/status/get_handler2.dart

 // Copyright (c) 2016, 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.
 
 import 'dart:convert';
 import 'dart:io';
 import 'dart:math';
 
 import 'package:analysis_server/plugin/protocol/protocol.dart' hide Element;
 import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/domain_completion.dart';
 import 'package:analysis_server/src/domain_diagnostic.dart';
 import 'package:analysis_server/src/domain_execution.dart';
 import 'package:analysis_server/src/services/completion/completion_performance.dart';
 import 'package:analysis_server/src/socket_server.dart';
 import 'package:analysis_server/src/status/get_handler.dart';
 import 'package:analyzer/exception/exception.dart';
 import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/instrumentation/instrumentation.dart';
 import 'package:analyzer/source/error_processor.dart';
 import 'package:analyzer/source/sdk_ext.dart';
 import 'package:analyzer/src/context/source.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart';
 import 'package:analyzer/src/dart/sdk/sdk.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/generated/utilities_general.dart';
 import 'package:analyzer/src/services/lint.dart';
@@ skipping 104 matching lines @@
     }
     return analysisServer.handlers
         .firstWhere((h) => h is CompletionDomainHandler, orElse: () => null);
   }
 
   /**
    * Handle a GET request received by the HTTP server.
    */
   void handleGetRequest(HttpRequest request) {
     String path = request.uri.path;
-    if (path == '/' || path == STATUS_PATH) {
+    if (path == '/') {
+      _returnRedirect(request, STATUS_PATH);

[Brian Wilkerson, 2017/02/27 14:41:32]

Out of curiosity (because I don't know much about web programming) what is the
advantage of redirecting rather than just returning the same data?

[devoncarew, 2017/03/01 01:51:32]

This will update the url in the browser (to say '/status'). No huge benefit, but
will give the user a bit more sense of where they are.

+    } else if (path == STATUS_PATH) {
       _returnServerStatus(request);
     } else if (path == ANALYSIS_PERFORMANCE_PATH) {
       _returnAnalysisPerformance(request);
     } else if (path == COMPLETION_PATH) {
       _returnCompletionInfo(request);
     } else if (path == COMMUNICATION_PERFORMANCE_PATH) {
       _returnCommunicationPerformance(request);
     } else if (path == CONTEXT_PATH) {
       _returnContextInfo(request);
     } else if (path == OVERLAY_PATH) {
@@ skipping 443 matching lines @@
           _writeAnalysisStatus(buffer);
           _writeEditStatus(buffer);
           _writeExecutionStatus(buffer);
           _writePluginStatus(buffer);
           _writeRecentOutput(buffer);
         }
       });
     });
   }
 
+  void _returnRedirect(HttpRequest request, String pathFragment) {
+    HttpResponse response = request.response;
+    response.redirect(request.uri.resolve(pathFragment));
+  }
+
   /**
    * Return an error in response to an unrecognized request received by the HTTP
    * server.
    */
   void _returnUnknownRequest(HttpRequest request) {
     _writeResponse(request, (StringBuffer buffer) {
       _writePage(buffer, 'Analysis Server', [], (StringBuffer buffer) {
         buffer.write('<h3>Unknown page: ');
         buffer.write(request.uri.path);
         buffer.write('</h3>');
@@ skipping 466 matching lines @@
       if (analysisServer == null) {
         buffer.write('Status: <span style="color:red">Not running</span>');
         return;
       }
       buffer.write('Status: Running<br>');
       buffer.write('New analysis driver: ');
       buffer.write(analysisServer.options.enableNewAnalysisDriver);
       buffer.write('<br>');
       buffer.write('Instrumentation: ');
       if (AnalysisEngine.instance.instrumentationService.isActive) {
-        buffer.write('<span style="color:red">Active</span>');
+        buffer.write('<strong>active</strong>');
       } else {
-        buffer.write('Inactive');
+        buffer.write('inactive');
       }
       buffer.write('<br>');
       buffer.write('Process ID: ');
       buffer.write(pid);
 
       buffer.write('<p><b>Performance Data</b></p>');
       buffer.write(makeLink(
           COMMUNICATION_PERFORMANCE_PATH, {}, 'Communication performance'));
+
+      if (AnalysisEngine.instance.instrumentationService.isActive) {
+        buffer.write('<p><b>Instrumentation</b></p>');
+        InstrumentationServer instrumentationServer = AnalysisEngine
+            .instance.instrumentationService.instrumentationServer;
+        buffer.write(instrumentationServer.describe.replaceAll('\n', '<br>'));

[skybrian, 2017/02/27 05:31:46]

If there is a link in the instrumentation server description, it might be nice
to put <a href> around it.

[devoncarew, 2017/03/01 01:51:32]

I think I'm just going to let implementations pass raw html through - it can be
understood that the `describe` output may be used in a web page; not sure it's
worth more effort here.

+      }
     }, (StringBuffer buffer) {
       _writeSubscriptionList(buffer, ServerService.VALUES, services);
       buffer.write('<p><b>Versions</b></p>');
       buffer.write('Dart SDK: ${Platform.version}<br>');
       buffer.write('Analysis server version: ${AnalysisServer.VERSION}<br>');
     });
     return analysisServer != null;
   }
 
   /**
@@ skipping 112 matching lines @@
   // TODO(devoncarew): Replace with the implementation from package:intl.
   String str = value.toString();
   int pos = 3;
   while (str.length > pos) {
     int len = str.length;
     str = '${str.substring(0, len - pos)},${str.substring(len - pos)}';
     pos += 4;
   }
   return str;
 }