-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconfiguringIssueDetection.html
More file actions
267 lines (242 loc) · 10.5 KB
/
configuringIssueDetection.html
File metadata and controls
267 lines (242 loc) · 10.5 KB
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Server Assistant - Minecraft Server Monitoring and issue reporting/handling tool">
<meta name="author" content="storm345">
<title>Server Assistant</title>
<link rel="icon"
type="image/png"
href="img/brand/logo_icon.png">
<!-- Bootstrap Core CSS -->
<link href="css/bootstrap.min.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="css/landing-page.css" rel="stylesheet">
<!-- Custom Fonts -->
<link href="font-awesome/css/font-awesome.min.css" rel="stylesheet" type="text/css">
<link href="https://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic,700italic" rel="stylesheet" type="text/css">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target=".navbar" data-offset="50">
<!-- Navigation -->
<nav class="navbar navbar-default navbar-fixed-top topnav" role="navigation">
<div class="container topnav">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand topnav" href="index.html" style="padding-top:0px;"><img src="img/brand/logo_reduced.png" style="height:50px;" alt="Server Assistant" /></a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<li>
<a href="index.html#about">About</a>
</li>
<li>
<a href="index.html#download">Download</a>
</li>
<li>
<a href="index.html#documentation">Documentation</a>
</li>
<li>
<a href="index.html#api">API</a>
</li>
<li>
<a href="https://github.com/storm345/ServerAssistantIssues/issues" target="_blank" >Report Issue</a>
</li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<!-- /.container -->
</nav>
<div class="content-section-a" id="pagecontent" style="padding-bottom:5px;">
<div class="container">
<a href="index.html#documentation" class="lead"><span class="fa fa-toggle-left"></span> Back to homepage</a>
</div>
<!-- /.container -->
</div>
<a name="content"></a>
<div class="content-section-a" id="pagecontent" style="padding-top:5px;">
<div class="container">
<h1>Configuring issue detection:</h1>
<p>An issue detector is a part of the plugin that detects an issue. This section overviews each default detector, what it does and how to configure it.</p>
<h3>Default detectors:</h3>
<ol>
<li><a href="#crashDetectors"><b>Crash Detectors</b> - Detectors that can detect when the server crashes</a>
<ul>
<li><a href="#freezeCrashDetector"><b>Freeze detector</b> - Detects when the server freezes</a></li>
<li><a href="#hardCrashDetector"><b>Hard detector</b> - Detects when the server crashes from an error</a></li>
</ul>
</li>
<li><a href="#lagDetectors"><b>Lag Detectors</b> - Detectors that can detect when the server is lagging</a>
<ul>
<li><a href="#combinedLagDetector"><b>Combined detector</b> - Detects when the server has low TPS, or high memory usage</a></li>
</ul>
</li>
<li><a href="#errorDetectors"><b>Error Detectors</b> - Detectors that can detect when the server encouters an error</a>
<ul>
<li><a href="#exceptionErrorDetector"><b>Exception detector</b> - Detects when the server generates an exception (has an error)</a></li>
</ul>
</li>
<li><a href="api.html" target="_blank"><b>Create your own</b> - Create your own detector using the API</a></li>
</ol>
<div id="crashDetectors">
<h2>Crashes:</h2>
<p>The configuration files for crash detectors can be found in <b>"<ServerDirectory>/plugins/ServerAssistant/Config/Detectors/Crashes/"</b>
<span id="freezeCrashDetector"></span>
<h3>Freeze crashes:</h3>
<p>This crash is when the server becomes unresponsive. <b>Config file: 'freezeCrashes.yml'</b></p>
<table class="table table-striped table-hover">
<tr>
<th>Config Key</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>freezeThresholdInSeconds</td>
<td>15</td>
<td>When the server has been unresponsive for this amount of time it will be considered 'crashed'</td>
</tr>
<tr>
<td>doSpigotRestartCmdOnDetect</td>
<td>false</td>
<td>If this is true, then the spigot restart command specified in 'spigot.yml' will be invoked before the server shuts down</td>
</tr>
<tr>
<td>isEnabled</td>
<td>true</td>
<td>If this is true, then the freeze crash detector is enabled. If it is false then it will be disabled</td>
</tr>
</table>
<span id="hardCrashDetector"></span>
<h3>Hard (Error) crashes:</h3>
<p>This crash is when the server encouters an error and has to stop. <b>Config file: 'hardCrashes.yml'</b></p>
<table class="table table-striped table-hover">
<tr>
<th>Config Key</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>doSpigotRestartCmdOnDetect</td>
<td>false</td>
<td>If this is true, then the spigot restart command specified in 'spigot.yml' will be invoked before the server shuts down</td>
</tr>
<tr>
<td>isEnabled</td>
<td>true</td>
<td>If this is true, then the hard crash detector is enabled. If it is false then it will be disabled</td>
</tr>
</table>
</div>
<div id="lagDetectors">
<span id="combinedLagDetector"></span>
<h2>Lag:</h2>
<p>The configuration files for lag detectors can be found in <b>"<ServerDirectory>/plugins/ServerAssistant/Config/Detectors/Lag/"</b>
<h3>Combined detector:</h3>
<p>This detects when the server tickrate drops below a threshold or when the server's memory usage goes above a threshold. <b>Config file: 'combinedDetector.yml'</b></p>
<table class="table table-striped table-hover">
<tr>
<th>Config Key</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>memoryThresholdPercent</td>
<td>90.0</td>
<td>When the server is using this % of allocated memory, or higher, then it will be considered as lagging. Set to 100%+ to disable memory counting the server as 'lagging'</td>
</tr>
<tr>
<td>tpsLagThreshold</td>
<td>17.0</td>
<td>When the server's tickrate (How many game ticks per second, aka tps) falls below this threshold the server will be considered lagging. Set to 0 to disable tps counting the server as 'lagging'</td>
</tr>
<tr>
<td>grabTimings</td>
<td>true</td>
<td>If true, then the server will (when it lags) grab timings data and include it in the report. <b>Timings data is only recorded a maximum of once per hour</b></td>
</tr>
<tr>
<td>grabThreadDump</td>
<td>false</td>
<td>If true, then the server will (when it lags) grab a thread dump and include it in the report</b></td>
</tr>
<tr>
<td>minimumTimeBetweenReportsMins</td>
<td>3.0</td>
<td>The minimum number of minutes between lag reports</b></td>
</tr>
<tr>
<td>doSpigotRestartCmdOnDetect</td>
<td>false</td>
<td>If this is true, then the spigot restart command specified in 'spigot.yml' will be invoked when the server lags.</td>
</tr>
<tr>
<td>stopServerOnDetect</td>
<td>false</td>
<td>If this is true, then the server will be shutdown when it lags.</td>
</tr>
<tr>
<td>isEnabled</td>
<td>true</td>
<td>If this is true, then the combined lag detector is enabled. If it is false then it will be disabled</td>
</tr>
</table>
</div>
<div id="errorDetectors">
<h2>Errors:</h2>
<p>The configuration files for error detectors can be found in <b>"<ServerDirectory>/plugins/ServerAssistant/Config/Detectors/Errors/"</b>
<span id="exceptionErrorDetector"></span>
<h3>Exception detector:</h3>
<p>This is when the server generates an exception (An error occurs). <b>Config file: 'errorDetector.yml'</b></p>
<table class="table table-striped table-hover">
<tr>
<th>Config Key</th>
<th>Default Value</th>
<th>Description</th>
</tr>
<tr>
<td>detectOnlyUncaughtExceptions</td>
<td>false</td>
<td>If true will only detect exceptions that aren't caught anywhere. (If you are not a developer, do not worry about this). So if you 'catch' the exception anywhere, it is ignored.</td>
</tr>
<tr>
<td>isEnabled</td>
<td>false</td>
<td>If this is true, then the exception detector is enabled. If it is false then it will be disabled</td>
</tr>
</table>
</div>
</div>
<!-- /.container -->
</div>
<!-- /.content-section-a -->
<!-- Footer -->
<footer>
<div class="container">
<div class="row">
<div class="col-lg-12">
<p class="copyright text-muted small">Copyright © storm345 2016. All Rights Reserved</p>
</div>
</div>
</div>
</footer>
<!-- jQuery -->
<script src="js/jquery.js"></script>
<!-- Bootstrap Core JavaScript -->
<script src="js/bootstrap.min.js"></script>
</body>
</html>