2024-02-03 14:07:41 +01:00
|
|
|
# RedisLookupPlugin Plugin for Graylog
|
|
|
|
|
|
2024-02-03 19:55:36 +01:00
|
|
|
Plugin to add Redis Data Adapter in read/write to graylog so you can store and retrieve key/values from pipelines
|
|
|
|
|
Support Redis authentication (with password and username/password)
|
2024-02-03 14:07:41 +01:00
|
|
|
|
2024-02-03 19:55:36 +01:00
|
|
|
**Required Graylog version:** 5.0 and later
|
2024-02-03 14:07:41 +01:00
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
2024-02-03 20:09:44 +01:00
|
|
|
[Download the plugin](https://git.nosd.in/yo/graylog-redis-lookup-plugin/releases/download/v1.0.0/graylog-plugin-redis-lookup-1.0.0.jar)
|
2024-02-03 14:07:41 +01:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
* `git clone https://github.com/Graylog2/graylog2-server.git`
|
|
|
|
|
* `cd graylog2-server/graylog2-web-interface`
|
|
|
|
|
* `ln -s $YOURPLUGIN plugin/`
|
|
|
|
|
* `npm install && npm start`
|
|
|
|
|
|
|
|
|
|
Usage
|
|
|
|
|
-----
|
|
|
|
|
|
2024-02-03 19:56:47 +01:00
|
|
|
* Create data adapter, cache (or not), lookup table
|
|
|
|
|
* Use 'lookup_set_value(lookup_table, key, value)' to create or update key in redis
|
|
|
|
|
* Use 'lookup(lookup_table, key)' to get key
|
2024-02-03 14:07:41 +01:00
|
|
|
|
|
|
|
|
Getting started
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
This project is using Maven 3 and requires Java 8 or higher.
|
|
|
|
|
|
|
|
|
|
* Clone this repository.
|
|
|
|
|
* Run `mvn 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.
|
