add write xref latency meter

Author: vladak

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerGuru.java

@@ -119,6 +119,7 @@
 import org.opengrok.indexer.logger.LoggerFactory;
 import org.opengrok.indexer.search.QueryBuilder;
 import org.opengrok.indexer.util.IOUtils;
+import org.opengrok.indexer.util.Statistics;
 import org.opengrok.indexer.web.Util;
 
 /**
@@ -658,12 +659,15 @@ private static void populateDocumentHistory(Document doc, File file) {
      * @param defs definitions for the source file, if available
      * @param annotation Annotation information for the file
      * @param project Project the file belongs to
+     * @param file file object, used only for logging
      * @throws java.io.IOException If an error occurs while creating the output
      */
     public static void writeXref(AnalyzerFactory factory, Reader in,
             Writer out, Definitions defs,
-            Annotation annotation, Project project)
+            Annotation annotation, Project project, File file)
             throws IOException {
+
+        Statistics stat = new Statistics();
         Reader input = in;
         if (factory.getGenre() == AbstractAnalyzer.Genre.PLAIN) {
             // This is some kind of text file, so we need to expand tabs to
@@ -681,13 +685,14 @@ public static void writeXref(AnalyzerFactory factory, Reader in,
         analyzer.setScopesEnabled(env.isScopesEnabled());
         analyzer.setFoldingEnabled(env.isFoldingEnabled());
         analyzer.writeXref(args);
+
+        stat.report(LOGGER, Level.FINEST, String.format("wrote xref for '%s'", file), "xref.write.latency");
     }
 
     /**
-     * Writes a browse-able version of the file transformed for immediate
-     * serving to a web client.
+     * Writes a browse-able version of the file transformed for immediate serving to a web client.
      * @param contextPath the web context path for
-     * {@link Util#dumpXref(java.io.Writer, java.io.Reader, java.lang.String)}
+     * {@link Util#dumpXref(java.io.Writer, java.io.Reader, java.lang.String, File)}
      * @param factory the analyzer factory for this file type
      * @param in the input stream containing the data
      * @param out a defined instance to write
@@ -698,13 +703,12 @@ public static void writeXref(AnalyzerFactory factory, Reader in,
      */
     public static void writeDumpedXref(String contextPath,
             AnalyzerFactory factory, Reader in, Writer out,
-            Definitions defs, Annotation annotation, Project project)
-            throws IOException {
+            Definitions defs, Annotation annotation, Project project, File file) throws IOException {
 
         File xrefTemp = File.createTempFile("ogxref", ".html");
         try {
             try (FileWriter tmpout = new FileWriter(xrefTemp)) {
-                writeXref(factory, in, tmpout, defs, annotation, project);
+                writeXref(factory, in, tmpout, defs, annotation, project, file);
             }
             Util.dumpXref(out, xrefTemp, false, contextPath);
         } finally {

opengrok-indexer/src/test/java/org/opengrok/indexer/index/IndexerTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2008, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2023, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, 2019, Chris Fraire <cfraire@me.com>.
  * Portions Copyright (c) 2020, Ric Harris <harrisric@users.noreply.github.com>.
  */
@@ -400,7 +400,7 @@ void testXref() throws IOException {
             }
             try (FileReader in = new FileReader(f); StringWriter out = new StringWriter()) {
                 try {
-                    AnalyzerGuru.writeXref(factory, in, out, null, null, null);
+                    AnalyzerGuru.writeXref(factory, in, out, null, null, null, f);
                 } catch (UnsupportedOperationException exp) {
                     // ignore
                 }

opengrok-web/src/main/webapp/list.jsp

@@ -264,7 +264,7 @@ document.pageReady.push(function() { pageReadyList();});
                         r = IOUtils.createBOMStrippedReader(bin,
                             StandardCharsets.UTF_8.name());
                         AnalyzerGuru.writeDumpedXref(request.getContextPath(), a,
-                                r, out, defs, annotation, project);
+                                r, out, defs, annotation, project, resourceFile);
     %></pre>
 </div><%
                     } else {

opengrok-web/src/main/webapp/xref.jspf

@@ -126,7 +126,7 @@ org.opengrok.indexer.web.QueryParameters"
                         r = IOUtils.createBOMStrippedReader(in, StandardCharsets.UTF_8.name());
                         AnalyzerGuru.writeDumpedXref(request.getContextPath(),
                             a, r, out,
-                            defs, annotation, project);
+                            defs, annotation, project, resourceFile);
                     } else if (g == AbstractAnalyzer.Genre.IMAGE) {
         %></pre>
     <img src="<%= rawPath %>?<%= QueryParameters.REVISION_PARAM_EQ %><%= Util.uriEncode(rev) %>" alt="Image from Source Repository"/>