Grouper Plugin for Graylog
Required Graylog version: 3.1.2 and later
This plugin adds Stream Orchestration functionality to the Open-Source Log-Management Software Graylog.
This plugin was developed in order to orchestrate streams -- a key concept of the popular Log-Management-Tool Graylog to categorize log messages.
Stream groups as key-concept for orchestration represent a composition of streams as parent-child-relationship in which the children are interconnected by a logical operator (AND, OR) -- allowing more complex routing-possibilities than plain streams.
Based on configured stream groups a directed graph with vertices and edges is constructed to provide an abstract and flexible way of organizing log messages which are efficiently analysed in realtime by a modified graph-traversal-algorithm.
Help section w/ info text is also available in plugin frontend.
full SETUP DOC
Installation
Download the plugin
and place the .jar file in your Graylog plugin directory. The plugin directory
is the plugins/ folder relative from your graylog-server directory by default
and can be configured in your graylog.conf file.
Restart graylog-server and you are done.
Configuration
No manual configuration needed for usage.
Usage
- Access frontend via header entry
System -> Grouper or /grouper-subpath
- Bottom of the page contains help section
Development
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:
-
Node
git clone https://github.com/Graylog2/graylog2-server.gitcd graylog2-server/graylog2-web-interfaceln -s $YOURPLUGIN plugin/npm install && npm start
-
Yarn (recommend)
cd graylog2-server/graylog2-web-interface/./node/yarn/dist/bin/yarn install./node/yarn/dist/bin/yarn start
Getting started
This project is using Maven 3 and requires Java 8 or higher.
- Clone this repository.
- Run
mvn clean package to build a JAR file.
- Optional: Run
mvn jdeb:jdeb and mvn rpm:rpm to create a DEB and RPM package respectively.
- Copy generated JAR file in target directory to your Graylog plugin directory.
- Restart the Graylog.
Plugin Release
We are using the maven release plugin:
$ mvn release:prepare
[...]
$ mvn release:perform
This sets the version numbers, creates a tag and pushes to GitHub. Travis CI will build the release artifacts and upload to GitHub automatically.
peteme
free!