https://github.com/splunk/minecraft-app
Splunking Minecraft with the App Framework
https://github.com/splunk/minecraft-app
Last synced: 7 months ago
JSON representation
Splunking Minecraft with the App Framework
- Host: GitHub
- URL: https://github.com/splunk/minecraft-app
- Owner: splunk
- License: apache-2.0
- Created: 2013-04-03T20:11:12.000Z (about 13 years ago)
- Default Branch: develop
- Last Pushed: 2016-07-14T23:39:42.000Z (almost 10 years ago)
- Last Synced: 2024-04-15T02:58:40.587Z (about 2 years ago)
- Language: JavaScript
- Size: 13.4 MB
- Stars: 19
- Watchers: 40
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README-PLUGMOD.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
Run `mvn clean package -Pinclude-forge` from the root directory to package the LogToSplunk plugmod.
The forge mod / spigot plugin that this project builds can be found in `logtosplunk-plugin/target` and is called `logtosplunk-plugin-{version}.jar`
Currently the supported veresion of minecraft are 1.8.7 for spigot and 1.8-1504 for forge; possible that newer versions are compatible with the plugmod.
# Splunk Logging Library
This library is currently hacked into the build because I don't have access to the splunk maven remote repo that stores this artifact. Currently the correctly-named jar needs to live in the `lib` directory where it will be automatically installed by maven during the build. This way of including the jar needs to be treated as a regular dependency when the aftifact becomes public. Email a Splunk developer to handle any NDAs etc. to get the logging library jar.
# Config
Place properties at `config/splunk.properties` (works for both plugin and mod); path is relative to directory where minecraft is executed from (generally where minecraft server jar is...).
The splunk host, port, and tokencan be configured with the properties: `splunk.craft.connection.host`, `splunk.craft.connection.port` and `splunk.craft.token`; for example:
```
splunk.craft.connection.host=127.0.0.1
splunk.craft.connection.port=8088
splunk.craft.token=12345678-1234-5678-1234-123456789012
splunk.craft.enable.consolelog=true
```
Note that the values listed here are the defaults.
Further configuration of Splunk via the splunk UI is needed as well as installing the LogToSplunk app (not currently covered in this readme).