Skip to content

Commit 4915c73

Browse files
billmurrinbillmurrin
committed
v3 README updates
1 parent c2e84a8 commit 4915c73

File tree

1 file changed

+63
-74
lines changed

1 file changed

+63
-74
lines changed

‎README.md‎

Lines changed: 63 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,58 @@
33
[![GitHub Release](https://img.shields.io/github/release/billmurrin/graylog-plugin-quickvaluesplus-widget.svg)](https://github.com/billmurrin/graylog-plugin-quickvaluesplus-widget/releases)
44
[![Build Status](https://travis-ci.org/billmurrin/graylog-plugin-quickvaluesplus-widget.svg?branch=master)](https://travis-ci.org/billmurrin/graylog-plugin-quickvaluesplus-widget)
55

6-
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.
77

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.
99

10-
![alt text](http://i.imgur.com/uthGeG1.png "Remove From Search Button")
11-
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")
18-
19-
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.
10+
Field Analyzer Features
11+
-----------
12+
- "Customize" menu supports modifying the Sort Order (Ascending or Descending), Table Size and number of Top Values displayed by the widget.
13+
- Exclude from search button - Add negated search directly to the Search Bar (E.g. !field_name:foo).
2014

21-
![alt text](http://i.imgur.com/TsZQxil.png "Example of Options Menu")
15+
*Field Analyzer Features*
16+
![alt text](http://i.imgur.com/H9SRkRo.png "Field Analyzer Features")
2217

23-
Customize Menu Caveat
18+
New Dashboard Features
2419
-----------
20+
- Widgets now contain links so that you can drill into a Term search and view the results.
21+
- Widgets now contain a button to open the Term search inside of a new window.
22+
- Added Exclude Term from Query button - Negate a search term directly from the widget (Requires dashboard edit permissions)
23+
- Can now customize the field name used by the widget (Requires dashboard edit permissions)
24+
25+
*NEW - Version 3 Dashboard Features*
26+
![alt text](http://i.imgur.com/viZ3AoK.png "Version 3 Dashboard Features")
2527

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.
28+
*NEW - Version 3 Editable Field Name*
29+
![alt text](http://i.imgur.com/HmBs3YL.png "Editable Field Name")
2730

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.
31+
New Global System Configuration
32+
-----------
33+
- Can now Customize the Quick Values Plus default values in the System/Configuration page.
2934

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.
35+
*NEW - Version 3 Globally Configurable Default Values*
36+
![alt text](http://i.imgur.com/DZHbWzh.png "System Global Default Values")
3137

3238
Supported Graylog Versions
3339
-----------
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.
40+
* Version 3.0.0 was tested and is compatible with Graylog version 2.3.0 and above.
41+
* Version 2.1.0 was tested and is compatible with Graylog versions 2.2.1, 2.2.2, and 2.2.3.
42+
* Version 1.0.0 was tested and is compatible with Graylog version 2.1.3.
3643

37-
Please file a bug report providing as much detail as possible if you find that the plugin is not working.
44+
Features and Bugs
45+
-----------
46+
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.
47+
48+
Contributions to the code-base are greatly appreciated.
3849

3950
Related Graylog Issues
4051
-----------
4152
The following are Graylog issues that the QuickValuesPlus widget currently attempts to resolve.
4253
* [#2459](https://github.com/Graylog2/graylog2-server/issues/2459) - Reverse quick values/Bottom-N
4354
* [#2631](https://github.com/Graylog2/graylog2-server/issues/2631) - Feature request: rare values #2631
4455
* [#1684](https://github.com/Graylog2/graylog2-server/issues/1684) - Make number of terms in quick values widget configurable
56+
* [#3694](https://github.com/Graylog2/graylog2-server/issues/3694) - Add hyperlinks to "Quick Values" dashboard widgets
57+
* [#3394](https://github.com/Graylog2/graylog2-server/issues/3394) - Widgets has no way to edit all properties after creation
4558

4659
Installation
4760
------------
@@ -50,65 +63,41 @@ and place the `.jar` file in your Graylog plugin directory. The plugin directory
5063

5164
Restart `graylog-server` and you are done.
5265

53-
Way Ahead - Version 2.2.0
66+
Way Ahead - Version 3.1.0
5467
-----------
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-
68+
* Add additional Default Configuration options (show table, show pie chart, links, exclude query button)
69+
* Add ability to Turn Off links and/or exclude from Query buttons for each individual widget in the Widget Configuration.
70+
6071
Development
6172
-----------
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:
63-
64-
* `git clone https://github.com/Graylog2/graylog2-server.git`
65-
* `cd graylog2-server/graylog2-web-interface`
66-
* `ln -s $YOURPLUGIN plugin/`
67-
* `npm install && npm start`
73+
You can improve your development experience for the web interface part of your plugin dramatically by making use of hot reloading.
6874

69-
If you run into issues with the current snapshot you can clone the 2.2.3 version of Graylog by using the following:
70-
71-
`git clone -b "2.2.3" https://github.com/Graylog2/graylog2-server.git`
72-
73-
**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).
75+
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))
7476

77+
Steps for hot-loading setup with the plugin.
78+
* Clone the Repositories
7579
```
76-
"dependencies": {
77-
"reflux": "^0.2.12",
78-
"crossfilter": "1.3.x",
79-
"d3": "<=3.5.0",
80-
"dc": "2.0.0-beta.19",
81-
"deep-equal": "^1.0.1",
82-
"immutable": "^3.7.5"
83-
},
84-
"devDependencies": {
85-
"babel-core": "^6.0.0",
86-
"babel-loader": "^6.0.0",
87-
"babel-plugin-add-module-exports": "^0.2.1",
88-
"babel-polyfill": "^6.0.0",
89-
"babel-preset-es2015": "^6.0.0",
90-
"babel-preset-react": "^6.0.0",
91-
"babel-preset-stage-0": "^6.0.0",
92-
"clean-webpack-plugin": "^0.1.3",
93-
"graylog-web-manifests": "^2.0.0-SNAPSHOT-1",
94-
"graylog-web-plugin": "~0.0.21",
95-
"json-loader": "^0.5.4",
96-
"react": "^0.14.6",
97-
"react-bootstrap": "^0.28.2",
98-
"react-dom": "^0.14.6",
99-
"react-hot-loader": "^3.0.0-beta.3",
100-
"react-proxy-loader": "^0.3.4",
101-
"webpack": "^1.12.2"
102-
}
80+
git clone https://github.com/billmurrin/graylog-plugin-quickvaluesplus-widget.git
81+
git clone -b "2.3.0" https://github.com/Graylog2/graylog2-server.git
82+
```
83+
* Install the Node.JS modules
84+
```
85+
cd graylog-plugin-quickvaluesplus-widget
86+
npm install
87+
cd ../graylog2-server/graylog2-web-interface
88+
npm install
89+
```
90+
* Build the Vendor file (If you skip this, plugin might fail with an 'call an undefined function')
91+
```
92+
webpack --config webpack.vendor.js
93+
```
94+
* Start the web server
95+
```
96+
npm start
10397
```
10498

105-
Getting started
106-
---------------
107-
108-
This project is using Maven 3 and requires Java 8 or higher.
109-
110-
* Clone this repository.
111-
* Run `mvn package` to build a JAR file.
112-
* Optional: Run `mvn jdeb:jdeb` and `mvn rpm:rpm` to create a DEB and RPM package respectively.
113-
* Copy generated JAR file in target directory to your Graylog plugin directory.
114-
* Restart the Graylog.
99+
Steps to build the plugin.
100+
* Follow the steps above, but **DO NOT** run the `npm start` command. (no need to start the dev web-server)
101+
* Run `mvn package`
102+
* Copy the generated JAR file located in the target directory to the Graylog plugin directory.
103+
* Restart Graylog

0 commit comments

Comments
 (0)