Minecraft Input Plugin using RCON #2960

Ayrdrie · 2017-06-23T18:34:49Z

Required for all PRs:

Signed CLA.
Associated README.md updated.
Has appropriate unit tests.

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Update Formatting Change main package to minecraft Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Add error handling to ParseUsername for minecraft plugin Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Telegraf plugin is now in a working state Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

…ctly Add client interface and mock client struct for testing purposes, update usages of rcon client to use said interface Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

danielnelson

I think it will not reconnect in the case of temporary network failure, so we need to check into that.

danielnelson · 2017-06-23T18:45:58Z

plugins/inputs/minecraft/README.md

@@ -0,0 +1,52 @@
+#  Minecraft Plugin


Try to stick closer to the format style in https://github.com/influxdata/telegraf/blob/master/plugins/inputs/EXAMPLE_README.md and make sure you have all the sections.

danielnelson · 2017-06-23T18:48:13Z

plugins/inputs/minecraft/README.md

+```
+  enable-rcon=true
+  rcon.password=<your password>
+  rcon.port=<1-65535>


danielnelson · 2017-06-23T18:48:44Z

plugins/inputs/minecraft/README.md

+This plugin uses the RCON protocol to collect [statistics](http://minecraft.gamepedia.com/Statistics) from a [scoreboard](http://minecraft.gamepedia.com/Scoreboard) on a
+Minecraft server.
+
+To enable [RCON](http://wiki.vg/RCON) on the minecraft server, add this to your server configuration:


Mention that this is the servers server.properties file.

danielnelson · 2017-06-23T18:49:27Z

plugins/inputs/minecraft/README.md

+To create a new scoreboard objective called `jump` on a minecraft server tracking the `jump` stat, run this command
+in the Minecraft console:
+
+`/scoreboard objectives add jump stat.jump`


Remove leading /

danielnelson · 2017-06-23T18:50:27Z

plugins/inputs/minecraft/README.md

+  rcon.port=<1-65535>
+```
+
+To create a new scoreboard objective called `jump` on a minecraft server tracking the `jump` stat, run this command


tracking the stat.jump criteria

danielnelson · 2017-06-23T19:13:15Z

plugins/inputs/minecraft/minecraft.go

+}
+
+func init() {
+	inputs.Add("minecraft", func() telegraf.Input { return &Minecraft{} })


Probably want to set config file defaults here.

danielnelson · 2017-06-23T19:16:02Z

plugins/inputs/minecraft/minecraft.go

+			return err
+		}
+		tags := map[string]string{
+			"playerName": playerName,


Change tag to player_name

danielnelson · 2017-06-23T19:18:57Z

plugins/inputs/minecraft/README.md

+
+- The `minecraft` measurement:
+    - `server`: the Minecraft RCON server
+    - `player`: the Minecraft player


Make sure the name of this tag is correct.

danielnelson · 2017-06-23T19:20:07Z

plugins/inputs/minecraft/minecraft.go

+		}
+		tags := map[string]string{
+			"playerName": playerName,
+			"server":     s.Server,


Probably should include the port s.Server + ":" + s.Port

danielnelson · 2017-06-23T19:30:13Z

plugins/inputs/minecraft/minecraft.go

+		// maybe become necessary if regex is modified to match more types of
+		//numbers
+		if err != nil {
+			return nil, fmt.Errorf("Failed to parse statistic")


Use consistent terminology: "failed to parse score", also fix up the spacing on comment above :)

… spec

…es file path

…E specification Fix usage of server commmands with README Update Formatting

…'s RCON go package

adamperlin · 2017-06-23T22:59:54Z

All review changes have been addressed!

danielnelson · 2017-06-23T23:03:29Z

plugins/inputs/minecraft/minecraft.go

@@ -0,0 +1,144 @@
+package minecraft
+
+// minecraft.go


We should remove this comment

danielnelson · 2017-06-23T23:03:56Z

plugins/inputs/minecraft/minecraft.go

+## port for RCON
+port = "25575"
+## password RCON for mincraft server
+password = "replace_me"


This bit does need two space indents so that it looks right in telegraf config

danielnelson · 2017-06-23T23:10:48Z

plugins/inputs/minecraft/README.md

+> minecraft,host=InfluxDatas-MacBook-Air.local,player=notch,server=127.0.0.1:25575 jumps=178i 1498254216000000000
+> minecraft,player=dinnerbone,server=127.0.0.1:25575,host=InfluxDatas-MacBook-Air.local jumps=1821i,cow_kills=1i,😂=7i,lvl=7i,deaths=1i,iron_pickaxe=3260i,total_kills=40i,dalevel=7i 1498254216000000000
+> minecraft,player=jeb,server=127.0.0.1:25575,host=InfluxDatas-MacBook-Air.local total_kills=29i,dalevel=33i,lvl=33i,jumps=263i,😂=33i 1498254216000000000
+```


We should use a more realistic set of criteria instead of the current corner case data. Also we can remove the host tag since it is added by the default config file.

adamperlin · 2017-06-23T23:48:58Z

Final Comments are now addressed!

Ayrdrie Palmer and others added 16 commits June 23, 2017 11:30

Add boilerplate for minecraft plugin

48d7258

Add RCON minecraft client lib

5cbb550

Change rcon.go to package main

9d737b7

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Isolate username with regex

8fd5848

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Add username parsing test for minecraft plugin

a4b87da

Update Formatting Change main package to minecraft Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Update ParseUsername test for minecraft plugin

96994e3

Add error handling to ParseUsername for minecraft plugin Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Add method to parse scoreboard data from rcon for minecraft input plugin

54b1778

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Remove main.go from minecraft plugin

b1c970c

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Change field names in RCON struct for minecraft input plugin

e775ba0

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Add gathering of data from RCON client for minecraft input plugin

93c36f6

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Fix empty username, fix uninitialized map for minecraft input plugin

c3c6a8e

Telegraf plugin is now in a working state Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Change all instances of username to playername

80ed9f3

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Add gather test for minecraft plugin

c4fab38

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Add rcon_test.go to verify that RCON server output is processed corre…

db22951

…ctly Add client interface and mock client struct for testing purposes, update usages of rcon client to use said interface Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

Remove unused variable in minecraft plugin

6a8b6b5

Signed-off-by: Adam Perlin <adamperlin@seattleacademy.org>

Add README.md to minecraft plugin

e72948e

Signed-off-by: Ayrdrie Palmer <ayrdriepalmer@gmail.com>

danielnelson suggested changes Jun 23, 2017

View reviewed changes

Adam Perlin added 10 commits June 23, 2017 14:47

Update minecraft input plugin README.md to conform to telegraf README…

846b487

… spec

Update README.md in minecraft input plugin to include server properti…

6fd5718

…es file path

Update minecraft plugin README.md to futher conform to telegraf READM…

c48cf8d

…E specification Fix usage of server commmands with README Update Formatting

Update LICENSE_OF_DEPENDENCIES.md to include license for chuckpreslar…

f0f5f8b

…'s RCON go package

Update playerName tag to player in minecraft plugin

bfbb286

Update server tag format to include port in minecraft plugin

a0ed0cf

Refactor regexps into package variables in minecraft plugin

f850a78

Update comment spacing in minecraft plugin

3e4559d

Add configuration defaults in minecraft package init

7d33813

Add RCON network reconnect in minecraft plugin

2de9da1

danielnelson suggested changes Jun 23, 2017

View reviewed changes

Remove extraneous comment and update formatting in minecraft plugin

66adba4

Adam Perlin added 2 commits June 23, 2017 16:22

Update default config file formatting in minecraft plugin

5818f5c

Update test data in README.md for minecraft plugin

8ed6801

danielnelson approved these changes Jun 23, 2017

View reviewed changes

danielnelson merged commit a726579 into master Jun 23, 2017

danielnelson deleted the minecraft branch June 23, 2017 23:54

jeichorn pushed a commit to jeichorn/telegraf that referenced this pull request Jul 24, 2017

Add Minecraft input plugin (influxdata#2960)

b2f81ea

maxunt pushed a commit that referenced this pull request Jun 26, 2018

Add Minecraft input plugin (#2960)

2ed4a73

iBug mentioned this pull request Feb 20, 2024

chore(inputs.minecraft): Migrate plugin to new maintained version of rcon #14868

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Minecraft Input Plugin using RCON #2960

Minecraft Input Plugin using RCON #2960

Ayrdrie commented Jun 23, 2017

danielnelson left a comment

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

adamperlin commented Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

danielnelson Jun 23, 2017

adamperlin commented Jun 23, 2017

Minecraft Input Plugin using RCON #2960

Minecraft Input Plugin using RCON #2960

Conversation

Ayrdrie commented Jun 23, 2017

Required for all PRs:

danielnelson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamperlin commented Jun 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamperlin commented Jun 23, 2017