1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
plugin_name: python.d.plugin
modules:
- meta:
plugin_name: python.d.plugin
module_name: spigotmc
monitored_instance:
name: SpigotMC
link: ""
categories:
- data-collection.gaming
icon_filename: "spigot.jfif"
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
keywords:
- minecraft server
- spigotmc server
- spigot
most_popular: false
overview:
data_collection:
metrics_description: |
This collector monitors SpigotMC server performance, in the form of ticks per second average, memory utilization, and active users.
method_description: |
It sends the `tps`, `list` and `online` commands to the Server, and gathers the metrics from the responses.
supported_platforms:
include:
- Linux
exclude: []
multi_instance: true
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: By default, this collector will attempt to connect to a Spigot server running on the local host on port `25575`.
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list:
- title: Enable the Remote Console Protocol
description: |
Under your SpigotMC server's `server.properties` configuration file, you should set `enable-rcon` to `true`.
This will allow the Server to listen and respond to queries over the rcon protocol.
configuration:
file:
name: "python.d/spigotmc.conf"
options:
description: |
There are 2 sections:
* Global variables
* One or more JOBS that can define multiple different instances to monitor.
The following options can be defined globally: priority, penalty, autodetection_retry, update_every, but can also be defined per JOB to override the global values.
Additionally, the following collapsed table contains all the options that can be configured inside a JOB definition.
Every configuration JOB starts with a `job_name` value which will appear in the dashboard, unless a `name` parameter is specified.
folding:
title: "Config options"
enabled: true
list:
- name: update_every
description: Sets the default data collection frequency.
default_value: 1
required: false
- name: priority
description: Controls the order of charts at the netdata dashboard.
default_value: 60000
required: false
- name: autodetection_retry
description: Sets the job re-check interval in seconds.
default_value: 0
required: false
- name: penalty
description: Indicates whether to apply penalty to update_every in case of failures.
default_value: yes
required: false
- name: name
description: >
Job name. This value will overwrite the `job_name` value. JOBS with the same name are mutually exclusive. Only one of them will be allowed
running at any time. This allows autodetection to try several alternatives and pick the one that works.
default_value: ""
required: false
- name: host
description: The host's IP to connect to.
default_value: localhost
required: true
- name: port
description: The port the remote console is listening on.
default_value: 25575
required: true
- name: password
description: Remote console password if any.
default_value: ""
required: false
examples:
folding:
enabled: true
title: "Config"
list:
- name: Basic
description: A basic configuration example.
folding:
enabled: false
config: |
local:
name: local_server
url: 127.0.0.1
port: 25575
- name: Basic Authentication
description: An example using basic password for authentication with the remote console.
config: |
local:
name: local_server_pass
url: 127.0.0.1
port: 25575
password: 'foobar'
- name: Multi-instance
description: |
> **Note**: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
config: |
local_server:
name : my_local_server
url : 127.0.0.1
port: 25575
remote_server:
name : another_remote_server
url : 192.0.2.1
port: 25575
troubleshooting:
problems:
list: []
alerts: []
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: "These metrics refer to the entire monitored application."
labels: []
metrics:
- name: spigotmc.tps
description: Spigot Ticks Per Second
unit: "ticks"
chart_type: line
dimensions:
- name: 1 Minute Average
- name: 5 Minute Average
- name: 15 Minute Average
- name: spigotmc.users
description: Minecraft Users
unit: "users"
chart_type: area
dimensions:
- name: Users
- name: spigotmc.mem
description: Minecraft Memory Usage
unit: "MiB"
chart_type: line
dimensions:
- name: used
- name: allocated
- name: max
|
