You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ATTENTION: This is a raw wikimarkup copy of the "live" README on LizardWiki at <https://fastlizard4.org/wiki/Download:Minecraft_Munin_plugins>
4
3
5
-
This copy may not be up to date, so if at all possible please refer to the LizardWiki version linked to above!
6
-
7
-
For copyright information, please open the COPYRIGHT file.
4
+
This copy may not be up to date, so if at all possible please refer to the LizardWiki version linked to above! This file may also have rendering errors if viewed on GitHub; again, for accurate
5
+
rendering (complete with images), please click the link above!
8
6
9
-
-->
7
+
For copyright and licensing information, please open the LICENSE file.
8
+
</div>
10
9
11
10
'''LIZARDNET FASTLIZARD4/MUNIN-PLUGINS/MINECRAFT - A set of RRDTool/Munin plugins written in PHP to graph various statistics regarding a Minecraft server.'''
12
11
12
+
[[File:Minecraft Munin plugins demo.png|thumb|right|600px|Some captured graphs from my own Minecraft servers utilizing these plugins (click to enlarge)]]
13
13
__TOC__
14
+
{{-}}
15
+
16
+
== Git, Download, and Source Code ==
17
+
*[[File:Git icon.svg|20px|link=]] '''Clone with Git (Gerrit): <code>git clone https://gerrit.fastlizard4.org/r/p/munin-plugins/minecraft.git</code>'''
*[https://ridley.fastlizard4.org/bugzilla/buglist.cgi?product=munin-plugins%2Fminecraft&component=%28not%20applicable%29&resolution=---&list_id=6 ''Currently open bug reports'']
21
25
26
+
=== GitHub Mirroring ===
27
+
A '''read-only''' mirror of the LizardNet Gerrit project is available on GitHub. Pull requests and issue reports are accepted there, however they will be only acted on in Gerrit (in the case of pull requests, they will be converted into patches and submitted by a developer as a new patchset in Gerrit before they are acted on). Developers with direct push access should never push directly to the GitHub repository and should instead submit their code to Gerrit. LizardNet Continuous Integration automatically pushes all commits to the master branch on LizardNet Gerrit to GitHub when the patchset is approved and merged.
This is a set of plugins that can be used in tandem with Munin (or RRDTool) to graph various aspects of a Minecraft server, including:
24
33
*Loaded chunks (overworld, Nether, and The End) (minecraft_chunks.php)
@@ -29,19 +38,37 @@ This is a set of plugins that can be used in tandem with Munin (or RRDTool) to g
29
38
30
39
=== Prerequisites ===
31
40
The following prerequisites must be satisfied for using any of the plugins provided here, unless otherwise noted:
32
-
*PHP 5.0 or above
41
+
*PHP <abbr title="Command Line Interface">CLI</abbr> 5.0 or above
33
42
*Minecraft server 1.0 or later
34
-
*''For minecraft_chunks.php, minecraft_entities.php, minecraft_lag.php, and minecraft_memory.php'': [http://bukkit.org CraftBukkit] version 1.0 or later '''and''' the [http://dev.bukkit.org/bukkit-plugins/lagmeter/ LagMeter plugin] for CraftBukkit
43
+
*''For minecraft_chunks.php, minecraft_entities.php, minecraft_lag.php, and minecraft_memory.php'': [http://bukkit.org CraftBukkit] version 1.0 or later ('''instead of''' the vanilla Minecraft server) '''and''' the [http://dev.bukkit.org/bukkit-plugins/lagmeter/ LagMeter plugin] for CraftBukkit
35
44
*RCON must be enabled in your Minecraft server configuration (instructions for doing this below)
36
45
37
46
== Downloading ==
47
+
=== Directly ===
48
+
These plugins can be downloaded in the archive format of your choice. See the bolded links [[#Git, Download, and Source Code|above]].
49
+
50
+
=== From Git ===
38
51
These plugins can be found on the LizardNet Git repositories. Run:
To automatically clone the Git repository to your computer.
61
+
62
+
These plugins can also be cloned from the '''read only''' GitHub mirror repository. Before you do this, though, please read the [[#GitHub Mirroring|GitHub Mirroring]] section above for important caveats.
To automatically clone the Git repository to your computer. For the rest of these instructions, we'll assume that you've cloned this repository into the folder <code>/home/''username''/munin-plugins</code>, so that your local repository root is <code>/home/''username''/munin-plugins/minecraft</code>.
71
+
For the rest of these instructions, we'll assume that you've cloned this repository into the folder <code>/home/''username''/munin-plugins</code>, so that your local repository root is <code>/home/''username''/munin-plugins/minecraft</code>.
45
72
46
73
== Installation ==
47
74
=== Enabling Minecraft RCON ===
@@ -59,6 +86,27 @@ Minecraft uses the Source RCON protocol for administrative communication, and th
59
86
[INFO] Starting remote control listener
60
87
[INFO] RCON running on 0.0.0.0:'''''portnumber'''''
61
88
89
+
=== (Required only for some components) Install and configure CraftBukkit and LagMeter ===
90
+
If you play to use any of the plugins other than minecraft_users.php, you'll need to use the CraftBukkit server distribution to replace vanilla Minecraft and install the LagMeter plugin. Don't worry, installing CraftBukkit is quick and easy, as it's a drop-in replacement for the vanilla Minecraft server .jar. However, the CraftBukkit installation guide is beyond the scope of this document, so please see [http://wiki.bukkit.org/Setting_up_a_server the Bukkit wiki] for help with that.
91
+
92
+
If you already use CraftBukkit, or have finished installing it, now install (if you haven't already) the [http://dev.bukkit.org/bukkit-plugins/lagmeter/ LagMeter plugin] by navigating to the <code>plugins/</code> directory of the Minecraft server and typing this command:
''Note: The link above may occasionally change, and if it does, go to the [http://dev.bukkit.org/bukkit-plugins/lagmeter/ plugin information page] to get the most up-to-date installation information.''
99
+
100
+
After you install LagMeter, restart your Minecraft server.
101
+
102
+
Now, regardless of whether you've just installed LagMeter or have previously had it installed, stop your CraftBukkit server as some configuration changes now need to be made in LagMeter:
103
+
104
+
*Open the <code>plugins/LagMeter/settings.yml</code> file in your CraftBukkit server directory
105
+
*Ensure that <code>useAverage</code> under ''General'' at the top of the file is set to <code>'''true'''</code> (this is the default).
106
+
*Go down to the ''Commands'' section of the config file
107
+
*Set both <code>Commands.Lag.displayEntities</code> and <code>Commands.Lag.displayChunks</code> to <code>'''true'''</code> (changing the values from the default).
108
+
*Save the file, exit your text editor, and start CraftBukkit
109
+
62
110
=== Install the Munin plugins ===
63
111
This guide assumes that you already have Munin installed. If you need help installing Munin, please see [http://munin-monitoring.org/wiki/MuninInstallationLinux here].
64
112
@@ -79,7 +127,7 @@ Now you need to configure Munin to connect to the server. Open the the ''munin-
79
127
env.port '''''portnumber'''''
80
128
env.password '''''password'''''
81
129
82
-
Using the same information you entered into your server.properties file above. Note that if Munin is running on the same machine as your Minecraft servers, ''hostname'' will be <code>localhost</code>.
130
+
Using the same information you entered into your server.properties file above. In almost all circumstances, ''hostname'' will be <code>localhost</code> (the rare exception would be if Munin-Node is running on a different system from the Minecraft servers being monitored).
83
131
84
132
Once that is done, run (as root):
85
133
@@ -132,7 +180,7 @@ Now we need to configure Munin with the RCON details. In this case, you would d
132
180
env.password '''''password_srv3'''''
133
181
env.customTitle Minecraft server srv3
134
182
135
-
Note that each Minecraft server has its own RCON connection configuration in the Munin config now (each server will have different RCON ports and ''should'' have different RCON passwords!), and that here the <code>env.customTitle</code> setting is used to make each server's set of graphs have identifying titles (though the <code>env.customTitle</code> setting is, of course, optional). The ''hostname''s will be <code>localhost</code> if the Minecraft servers are running on the same server as the Munin master instance.
183
+
Note that each Minecraft server has its own RCON connection configuration in the Munin config now (each server will have different RCON ports and ''should'' have different RCON passwords!), and that here the <code>env.customTitle</code> setting is used to make each server's set of graphs have identifying titles (though the <code>env.customTitle</code> setting is, of course, optional). The ''hostname''s will be <code>localhost</code> if the Minecraft servers are running on the same server as the Munin-Node instance - i.e., almost always.
136
184
137
185
Now, just restart munin-node by running this command as root:
0 commit comments