Merge branch 'issue777'

Author: DJCordhose

app/assets/javascripts/dashboards/dashboards.js

@@ -154,8 +154,18 @@ $(document).ready(function() {
 
                 $(".reloading", widget).show();
 
+                // XXX: This is just the fixed resolution of the Rickshaw graph as defined in "search_result_chart.js"
+                var resolution = 800;
+
+                var url;
+                if (resolution) {
+                    url = appPrefixed('/a/dashboards/' + dashboardId + '/widgets/' + widgetId  + '/resolution/' + resolution + '/value');
+                } else {
+                    url = appPrefixed('/a/dashboards/' + dashboardId + '/widgets/' + widgetId + '/value');
+                }
+
                 $.ajax({
-                    url: appPrefixed('/a/dashboards/' + dashboardId + '/widgets/' + widgetId + '/value'),
+                    url: url,
                     type: 'GET',
                     success: function(data) {
                         // Pass to widget specific function to display actual value(s).

app/assets/javascripts/universalsearch.js

@@ -39,6 +39,18 @@ $(document).ready(function() {
         $("#universalsearch-fields", $(this)).val(searchViewState.getFieldsString());
     });
 
+    $(".universalsearch-form").on("submit", function() {
+        var width = $(document).width();
+        $("input[name='width']", $(this)).val(width);
+    });
+
+    $(".added-width-search-link").on("click", function() {
+        var width = $(document).width();
+        var href = $(this).attr("href");
+        href = URI(href).addSearch("width", width).toString();
+        $(this).attr("href", href);
+    });
+
     // initialize the user readable dates on page load
     $("#universalsearch .timerange-selector-container .absolute input[type='hidden']").each(function() {
         var input = $("input[type='text']", $(this).parent());
@@ -149,13 +161,14 @@ $(document).ready(function() {
 
     // Saved search selected. Get details and send to page that redirects to the actual search.
     $("#saved-searches-selector").on("change", function(e) {
+        var width = $(document).width();
         var searchId = $("#saved-searches-selector").val();
 
         var container = $(this).closest(".saved-searches-selector-container");
         if(!!container.attr("data-stream-id")) {
-            var url = "/savedsearches/" + encodeURI(searchId) + "/execute?" + "streamId=" + container.attr("data-stream-id");
+            var url = "/savedsearches/" + encodeURI(searchId) + "/execute?" + "streamId=" + container.attr("data-stream-id") + "&width=" + width;
         } else {
-            var url = "/savedsearches/" + encodeURI(searchId) + "/execute";
+            var url = "/savedsearches/" + encodeURI(searchId) + "/execute" + "?width=" + width;
         }
 
         window.location = appPrefixed(url);

app/controllers/OpenSearchController.java

@@ -23,7 +23,7 @@
 public class OpenSearchController extends BaseController  {
 
     public static Result index() {
-        final String relative = routes.SearchController.index("{searchTerms}", "relative", 3600, "", "", "", "", 1, "", "", "", "").absoluteURL(request());
+        final String relative = routes.SearchController.index("{searchTerms}", "relative", 3600, "", "", "", "", 1, "", "", "", "", -1).absoluteURL(request());
         final String unescaped = relative.replaceAll("%7B", "{").replaceAll("%7D", "}").replaceAll("&", "&");
         String content =
                 "<OpenSearchDescription xmlns=\"http://a9.com/-/spec/opensearch/1.1/\"\n" +

app/controllers/SavedSearchesController.java

@@ -37,14 +37,14 @@ public class SavedSearchesController extends AuthenticatedController {
     @Inject
     private SavedSearchService savedSearchService;
 
-    public Result execute(String searchId, String streamId) {
+    public Result execute(String searchId, String streamId, int displayWidth) {
         try {
             SavedSearch search = savedSearchService.get(searchId);
 
             if(streamId == null || streamId.isEmpty()) {
-                return redirect(callFromSavedSearch(search, streamId, true));
+                return redirect(callFromSavedSearch(search, streamId, true, displayWidth));
             } else {
-                return redirect(callFromSavedSearch(search, streamId, true));
+                return redirect(callFromSavedSearch(search, streamId, true, displayWidth));
             }
 
         } catch (IOException e) {
@@ -71,7 +71,7 @@ public Result delete(String searchId) {
         }
     }
 
-    private Call callFromSavedSearch(SavedSearch search, String streamId, boolean includeOriginal) {
+    private Call callFromSavedSearch(SavedSearch search, String streamId, boolean includeOriginal, int displayWidth) {
         int relative = 0;
         if (search.getQuery().containsKey("relative")) {
             relative = Integer.parseInt((String) search.getQuery().get("relative"));
@@ -115,7 +115,8 @@ private Call callFromSavedSearch(SavedSearch search, String streamId, boolean in
                     searchId,
                     "",
                     "",
-                    fields
+                    fields,
+                    displayWidth
             );
         } else {
             return routes.StreamSearchController.index(
@@ -131,7 +132,8 @@ private Call callFromSavedSearch(SavedSearch search, String streamId, boolean in
                     searchId,
                     "",
                     "",
-                    fields
+                    fields,
+                    displayWidth
             );
         }
     }

app/controllers/SearchController.java

@@ -21,8 +21,10 @@
 import com.google.common.base.Splitter;
 import com.google.common.collect.Iterables;
 import com.google.common.collect.Lists;
+import com.google.common.collect.Maps;
 import com.google.common.collect.Sets;
 import com.google.common.net.MediaType;
+import com.google.gson.Gson;
 import com.google.inject.Inject;
 import lib.*;
 import lib.security.RestPermissions;
@@ -35,15 +37,22 @@
 import org.graylog2.restclient.models.*;
 import org.graylog2.restclient.models.api.results.DateHistogramResult;
 import org.graylog2.restclient.models.api.results.SearchResult;
+import org.joda.time.DateTime;
+import org.joda.time.DateTimeConstants;
+import org.joda.time.Minutes;
 import play.mvc.Result;
 import views.helpers.Permissions;
 
 import java.io.IOException;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 public class SearchController extends AuthenticatedController {
 
+    // guess high, so we never have a bad resolution
+    private static int DEFAULT_ASSUMED_GRAPH_RESOLUTION = 4000;
+
     @Inject
     protected UniversalSearch.Factory searchFactory;
 
@@ -76,7 +85,8 @@ public Result index(String q,
                         int page,
                         String savedSearchId,
                         String sortField, String sortOrder,
-                        String fields) {
+                        String fields,
+                        int displayWidth) {
         SearchSort sort = buildSearchSort(sortField, sortOrder);
 
         UniversalSearch search;
@@ -92,25 +102,26 @@ public Result index(String q,
         DateHistogramResult histogramResult;
         SavedSearch savedSearch;
         Set<String> selectedFields = getSelectedFields(fields);
+        String formattedHistogramResults;
         try {
             if(savedSearchId != null && !savedSearchId.isEmpty()) {
                 savedSearch = savedSearchService.get(savedSearchId);
             } else {
                 savedSearch = null;
             }
 
-            // Histogram interval.
-            if (interval == null || interval.isEmpty() || !SearchTools.isAllowedDateHistogramInterval(interval)) {
-                interval = "minute";
-            }
-
             searchResult = search.search();
             if (searchResult.getError() != null) {
                 return ok(views.html.search.queryerror.render(currentUser(), q, searchResult, savedSearch, fields, null));
             }
             searchResult.setAllFields(getAllFields());
 
+            // histogram resolution (strangely aka interval)
+            if (interval == null || interval.isEmpty() || !SearchTools.isAllowedDateHistogramInterval(interval)) {
+                interval = determineHistogramResolution(searchResult);
+            }
             histogramResult = search.dateHistogram(interval);
+            formattedHistogramResults = formatHistogramResults(histogramResult.getResults(), displayWidth);
         } catch (IOException e) {
             return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
         } catch (APIException e) {
@@ -119,12 +130,67 @@ public Result index(String q,
         }
 
         if (searchResult.getTotalResultCount() > 0) {
-            return ok(views.html.search.results.render(currentUser(), search, searchResult, histogramResult, q, page, savedSearch, selectedFields, serverNodes.asMap(), null));
+            return ok(views.html.search.results.render(currentUser(), search, searchResult, histogramResult, formattedHistogramResults, q, page, savedSearch, selectedFields, serverNodes.asMap(), null));
         } else {
             return ok(views.html.search.noresults.render(currentUser(), q, searchResult, savedSearch, selectedFields, null));
         }
     }
 
+    protected String determineHistogramResolution(final SearchResult searchResult) {
+        final String interval;
+        final int queryRangeInMinutes = Minutes.minutesBetween(searchResult.getFromDateTime(), searchResult.getToDateTime()).getMinutes();
+        final int HOUR = DateTimeConstants.MINUTES_PER_HOUR;
+        final int DAY = DateTimeConstants.MINUTES_PER_DAY;
+        final int WEEK = DateTimeConstants.MINUTES_PER_WEEK;
+        final int MONTH = DAY * 30;
+        final int YEAR = MONTH * 12;
+
+        if (queryRangeInMinutes < DAY / 2) {
+            interval = "minute";
+        } else if (queryRangeInMinutes < DAY * 2) {
+            interval = "hour";
+        } else if (queryRangeInMinutes < MONTH) {
+            interval = "day";
+        } else if (queryRangeInMinutes < MONTH * 6) {
+            interval = "week";
+        } else if (queryRangeInMinutes < YEAR * 2) {
+            interval = "month";
+        } else if (queryRangeInMinutes < YEAR * 10) {
+            interval = "quarter";
+        } else {
+            interval = "year";
+        }
+        return interval;
+    }
+
+    /**
+     * [{ x: -1893456000, y: 92228531 }, { x: -1577923200, y: 106021568 }]
+     *
+     * @return A JSON string representation of the result, suitable for Rickshaw data graphing.
+     */
+    protected String formatHistogramResults(Map<String, Long> histogramResults, int displayWidth) {
+        final int saneDisplayWidth = (displayWidth == -1 || displayWidth < 100 || displayWidth > DEFAULT_ASSUMED_GRAPH_RESOLUTION) ? DEFAULT_ASSUMED_GRAPH_RESOLUTION : displayWidth;
+        final List<Map<String, Long>> points = Lists.newArrayList();
+
+        // using the absolute value guarantees, that there will always be enough values for the given resolution
+        final int factor = (saneDisplayWidth != -1 && histogramResults.size() > saneDisplayWidth) ? histogramResults.size() / saneDisplayWidth : 1;
+
+        int index = 0;
+        for (Map.Entry<String, Long> result : histogramResults.entrySet()) {
+            // TODO: instead of sampling we might consider interpolation (compare DashboardsApiController)
+            if (index % factor == 0) {
+                Map<String, Long> point = Maps.newHashMap();
+                point.put("x", Long.parseLong(result.getKey()));
+                point.put("y", result.getValue());
+
+                points.add(point);
+            }
+            index++;
+        }
+
+        return new Gson().toJson(points);
+    }
+
     protected Set<String> getSelectedFields(String fields) {
         Set<String> selectedFields = Sets.newLinkedHashSet();
         if (fields != null && !fields.isEmpty()) {

app/controllers/StreamSearchController.java

@@ -31,7 +31,8 @@ public Result index(String streamId,
                         int page,
                         String savedSearchId,
                         String sortField, String sortOrder,
-                        String fields) {
+                        String fields,
+                        int displayWidth) {
         SearchSort sort = buildSearchSort(sortField, sortOrder);
 
         Stream stream;
@@ -71,25 +72,27 @@ public Result index(String streamId,
         DateHistogramResult histogramResult;
         SavedSearch savedSearch;
         Set<String> selectedFields = getSelectedFields(fields);
+        String formattedHistogramResults;
+
         try {
             if(savedSearchId != null && !savedSearchId.isEmpty()) {
                 savedSearch = savedSearchService.get(savedSearchId);
             } else {
                 savedSearch = null;
             }
 
-            // Histogram interval.
-            if (interval == null || interval.isEmpty() || !SearchTools.isAllowedDateHistogramInterval(interval)) {
-                interval = "minute";
-            }
-
             searchResult = search.search();
             if (searchResult.getError() != null) {
                 return ok(views.html.search.queryerror.render(currentUser(), q, searchResult, savedSearch, fields, stream));
             }
             searchResult.setAllFields(getAllFields());
 
+            // histogram resolution (strangely aka interval)
+            if (interval == null || interval.isEmpty() || !SearchTools.isAllowedDateHistogramInterval(interval)) {
+                interval = determineHistogramResolution(searchResult);
+            }
             histogramResult = search.dateHistogram(interval);
+            formattedHistogramResults = formatHistogramResults(histogramResult.getResults(), displayWidth);
         } catch (IOException e) {
             return status(504, views.html.errors.error.render(ApiClient.ERROR_MSG_IO, e, request()));
         } catch (APIException e) {
@@ -98,7 +101,7 @@ public Result index(String streamId,
         }
 
         if (searchResult.getTotalResultCount() > 0) {
-            return ok(views.html.search.results.render(currentUser(), search, searchResult, histogramResult, q, page, savedSearch, selectedFields, serverNodes.asMap(), stream));
+            return ok(views.html.search.results.render(currentUser(), search, searchResult, histogramResult, formattedHistogramResults, q, page, savedSearch, selectedFields, serverNodes.asMap(), stream));
         } else {
             return ok(views.html.search.noresults.render(currentUser(), q, searchResult, savedSearch, selectedFields, stream));
         }

app/controllers/api/DashboardsApiController.java

@@ -43,9 +43,7 @@
 import views.helpers.Permissions;
 
 import java.io.IOException;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 /**
  * @author Lennart Koopmann <[email protected]>
@@ -132,14 +130,15 @@ public Result setWidgetPositions(String dashboardId) {
         return ok();
     }
 
-    public Result widgetValue(String dashboardId, String widgetId) {
+    public Result widgetValue(String dashboardId, String widgetId, int resolution) {
         try {
             Dashboard dashboard = dashboardService.get(dashboardId);
             DashboardWidget widget = dashboard.getWidget(widgetId);
             DashboardWidgetValueResponse widgetValue = widget.getValue(api());
 
+            Object resultValue = filterValuesByResolution(resolution, widgetValue.result);
             Map<String, Object> result = Maps.newHashMap();
-            result.put("result", widgetValue.result);
+            result.put("result", resultValue);
             result.put("took_ms", widgetValue.tookMs);
             result.put("calculated_at", widgetValue.calculatedAt);
             result.put("time_range", widgetValue.computationTimeRange);
@@ -153,6 +152,32 @@ public Result widgetValue(String dashboardId, String widgetId) {
         }
     }
 
+    // in case the widget submitted its resolution, make sure we do not deliver more result values than the widget can display for performance reasons
+    private Object filterValuesByResolution(final int resolution, final Object resultValue) {
+        if (resultValue instanceof Map && resolution != -1) {
+            final Map<?, ?> resultMap = (Map) resultValue;
+            final int size = resultMap.size();
+            if (size > resolution) {
+                // using the absolute value guarantees, that there will always be enough values for the given resolution
+                final int factor = size / resolution;
+                // shortcut, no need to copy verbatim
+                if (factor != 1) {
+                    final Map<Object, Object> filteredResults = new LinkedHashMap<>(resolution);
+                    int index = 0;
+                    for (Map.Entry entry : resultMap.entrySet()) {
+                        // TODO: instead of sampling we might consider interpolation (compare SearchController)
+                        if (index % factor == 0) {
+                            filteredResults.put(entry.getKey(), entry.getValue());
+                        }
+                        index++;
+                    }
+                    return filteredResults;
+                }
+            }
+        }
+        return resultValue;
+    }
+
     public Result addWidget(String dashboardId) {
         try {
             final Map<String, String> params = flattenFormUrlEncoded(request().body().asFormUrlEncoded());

app/views/dashboards/show.scala.html

@@ -200,7 +200,7 @@ <h2>Widget config</h2>
                 <a class="btn" href="@routes.MetricsController.ofMasterNode("org.graylog2.dashboards.widgets.*." + widget.getId)">
                     Show widget metrics
                 </a>
-                <a class="btn btn-success" href="@DashboardWidgetRouteHelper.replayRoute(widget)">
+                <a class="btn btn-success added-width-search-link" href="@DashboardWidgetRouteHelper.replayRoute(widget)">
                     Replay search
                 </a>
                 <button class="btn btn-primary" data-dismiss="modal" aria-hidden="true">Close</button>

app/views/helpers/DashboardWidgetRouteHelper.java

@@ -32,7 +32,8 @@ protected static Call prepareNonStreamBoundReplayRoute(String query, TimeRange t
                 "",
                 "",
                 "",
-                "" // TODO fields
+                "", // TODO fields
+                -1
         );
     }
 
@@ -50,7 +51,8 @@ protected static Call prepareStreamBoundReplayRoute(String streamId, String quer
                 "",
                 "",
                 "",
-                "" // TODO fields
+                "", // TODO fields
+                -1
         );
     }
 }