You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The QuickValuesPlus Widget is an enhanced fork of the GrayLog2 Quick Values Widget that ships with GrayLog2.
6
+
The QuickValuesPlus Widget is an enhancement to the Quick Values Widget that ships with GrayLog2. The QuickValuesPlus Widget can be added to a Stream as a Field Analyzer and to Dashboards as a widget.
7
7
8
-
When the QuickValuesPlus Widget is added to Search as a field analyzer it adds a "Remove from search" button. The button will negate the field in the search bar (E.g. !field_name:foo).
8
+
Several **NEW** features have been added to version 3.0.0 (See below). Version 3.0.0 is only compatible with Graylog 2.3.0 and above.
9
9
10
-
![alt text](http://i.imgur.com/uthGeG1.png"Remove From Search Button")
11
10
12
-
In addition, the QuickValuesPlus Widget has extra features when added to dashboards, such as:
13
-
* Support for **ascending** OR **descending** sort order in the datatable. Can now obtain true bottom values.
14
-
* Editable number of Top/Bottom values (Quick Values default is 5). This is the one with a color in the table.
15
-
* Customizable table size (Quick values default is 50).
16
-
17
-
![alt text](http://i.imgur.com/7PLDXCW.png"Example of Configuration Options")
11
+
Field Analyzer Features
12
+
-----------
13
+
- "Customize" menu supports modifying the Sort Order (Ascending or Descending), Table Size and number of Top Values displayed by the widget.
14
+
- Exclude from search button - Add negated search directly to the Search Bar (E.g. !field_name:foo).
In version 2.1.0, the Customize menu was introduced to help control the sort order, number of top values and the table size of the plugin when used on a Search page.
20
19
21
-
![alt text](http://i.imgur.com/TsZQxil.png"Example of Options Menu")
20
+
New Dashboard Features
21
+
-----------
22
+
- Widgets now contain links so that you can drill into a Term search and view the results.
23
+
- Widgets now contain a button to open the Term search inside of a new window.
24
+
- Added Exclude Term from Query button - Negate a search term directly from the widget (Requires dashboard edit permissions)
- Can now customize the field name used by the widget (Requires dashboard edit permissions)
25
32
26
-
Right now, Graylog's REST API does not support a sort option for the RelativeSearch lookup on /terms (See Issue #7). I plan on doing a Pull Request on Graylog to add this feature.
27
33
28
-
With that means is that, at this time, we cannot obtain a "TRUE" ascending order query on the Search pages. The ascending order is generic as the underlying Elasticsearch query is based on descending order.
34
+
*NEW - Version 3 Editable Field Name*
35
+
![alt text](http://i.imgur.com/Ezs7DL3.png"Edit Field Name")
29
36
30
-
If you want a true ascending ordered, or Bottom-N, query, simply add the widget to a dashboard. The widget code does conduct a *TRUE* ascending ordered query.
37
+
New Global System Configuration
38
+
-----------
39
+
- Can now Customize the Quick Values Plus default values in the System/Configuration page.
40
+
41
+
*NEW - Version 3 Globally Configurable Default Values*
42
+
![alt text](http://i.imgur.com/DZHbWzh.png"System Global Default Values")
31
43
32
44
Supported Graylog Versions
33
45
-----------
34
-
* Version 2.1.0 was tested and is compatible with Graylog versions 2.2.1, 2.2.2, and 2.2.3
35
-
* Version 1.0.0 was tested and is compatible with Graylog version 2.1.3. No Customize menu.
46
+
* Version 3.0.0 was tested and is compatible with Graylog version 2.3.0 and above.
47
+
* Version 2.1.0 was tested and is compatible with Graylog versions 2.2.1, 2.2.2, and 2.2.3.
48
+
* Version 1.0.0 was tested and is compatible with Graylog version 2.1.3.
36
49
37
-
Please file a bug report providing as much detail as possible if you find that the plugin is not working.
50
+
Features and Bugs
51
+
-----------
52
+
If you come across a bug, require further assistance, or have a great feature request, please file an [Issue](https://github.com/billmurrin/graylog-plugin-quickvaluesplus-widget/issues) providing as much detail as possible.
53
+
54
+
Contributions to the code-base are greatly appreciated.
38
55
39
56
Related Graylog Issues
40
57
-----------
41
58
The following are Graylog issues that the QuickValuesPlus widget currently attempts to resolve.
*[#1684](https://github.com/Graylog2/graylog2-server/issues/1684) - Make number of terms in quick values widget configurable
62
+
*[#3694](https://github.com/Graylog2/graylog2-server/issues/3694) - Add hyperlinks to "Quick Values" dashboard widgets
63
+
*[#3394](https://github.com/Graylog2/graylog2-server/issues/3394) - Widgets has no way to edit all properties after creation
45
64
46
65
Installation
47
66
------------
@@ -50,65 +69,41 @@ and place the `.jar` file in your Graylog plugin directory. The plugin directory
50
69
51
70
Restart `graylog-server` and you are done.
52
71
53
-
Way Ahead - Version 2.2.0
72
+
Way Ahead - Version 3.1.0
54
73
-----------
55
-
* Add support to modify the field of the widget. (Issue #6)
56
-
* Add HTML links to the dashboard (Issue #5)
57
-
* Add code to make the Dropdown menu go away after a selection. (Issue #8)
58
-
* Add a System Configuration menu to allow users to change the global defaults for sort order, top values, and table size. (Issue #9)
59
-
74
+
* Add additional Default Configuration options (show table, show pie chart, links, exclude query button)
75
+
* Add ability to Turn Off links and/or exclude from Query buttons for each individual widget in the Widget Configuration.
76
+
60
77
Development
61
78
-----------
62
-
You can improve your development experience for the web interface part of your plugin dramatically by making use of hot reloading. To do this, do the following:
79
+
You can improve your development experience for the web interface part of your plugin dramatically by making use of hot reloading.
**TIP** If you happen to use "[graylog-project](https://github.com/Graylog2/graylog-project)" and are having issues with the plugin compiling properly or not loading on the page, ensure your plugin's package.json has the same dependcies as "[graylog-plugin-sample](https://github.com/Graylog2/graylog-plugin-sample)". The example below has a few additional packages (crossfilter, d3, dc, deep-equal and immutable).
81
+
To hot reload using Graylog 2.3.0, your plugin directory should be located two directories above your graylog2-web-server directory (../../) and the folder name of your plugin should be begin with graylog-plugin (More info[HERE](https://github.com/Graylog2/graylog2-server/blob/2.3/graylog2-web-interface/webpack.combined.config.js#L11))
0 commit comments