Kiln » KilnSupportScripts Powershell Scripts to help monitor a Kiln environment. Contact Fog Creek support before using.
Clone URL:  
Pushed to one repository · View In Graph Contained in tip

Attempts to automatically restart services (optionally IIS) when failures are detected.

Changeset 0ca99d0c705a

Parent e8792002a292

by Profile picture of User 1563Quentin Schroeder <quentin@fogcreek.com>

Changes to one file · Browse files at 0ca99d0c705a Showing diff from parent e8792002a292 Diff from another changeset...

 
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
 
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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
 
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
268
269
270
271
272
273
274
@@ -8,38 +8,79 @@
     param([string]$kilnURL = "http://localhost/fogbugz/kiln", + [string]$smtpServer = "", + [string]$from = "", + [string]$to = "",   [string]$backendVersionUrl = "http://localhost:56783/version", - [string]$EsUrl = "http://localhost:9200/", - [string]$QueueStatsUrl = "http://localhost:56785/stats.json") + [string]$esUrl = "http://localhost:9200/", + [string]$queueStatsUrl = "http://localhost:56785/stats.json", + [string]$iisSiteName = "", + [switch]$noRestart, + [string]$reenqueuePath = ".\reenqueue_2.9_tasks.ps1")       -function Write-WithTime($msg){ - write "$(Get-Date -format o) $msg" + +############################# FUNCTION DEFINITIONS ############################# + +function Write-WithTime($msg, $error=$false){ + if ($error) + { + write-host "$(Get-Date -format o) $msg" -foregroundcolor "red" + return + } + write-host "$(Get-Date -format o) $msg"  }     -function Test-ProcessRunning($processName, $count = 1) + +function Handle-Error($msg) +{ + Write-WithTime " ERROR!" $true + if ($smtpServer -and $from -and $to) + { + Send-MailMessage -From $from -To $to -SmtpServer $smtpServer -Subject "Kiln Server Error Report!" -Body "" + } + else + { + Write-WithTime " $msg" $true + } +} + + + +function Test-ProcessRunning($processName, $count = 1, [ref]$serviceNeedsRestart)  {   Write-WithTime "Checking that $count instance(s) of $processName are running..."   $result = (Get-Process $processName -ea SilentlyContinue | select id | measure).count -ge $count - if ($result) { Write-WithTime "Success!" } - else { Write-WithTime "FAILURE!" } + if (!($result)) + { + Handle-Error("Critical Kiln Server error. Process `'$processName`' could not be found!") + $serviceNeedsRestart.value = $true + }  }       -function Test-ElasticSearchRunning() +function Test-ElasticSearchRunning([ref]$serviceNeedsRestart)  {   Write-WithTime "Checking that 1 instances(s) of ElasticSearch are running..." - $result = (Get-WmiObject win32_process -Filter "name like 'java.exe'" | select commandline | select-string "ElasticSearch" | measure).count -eq 1 - if ($result) { Write-WithTime "Success!" } - else { Write-WithTime "FAILURE!" } + $result = $false + (Get-WmiObject win32_process -Filter "name like 'java.exe'") | ForEach-Object { + if (($_.CommandLine | select-string "ElasticSearch" | measure).count -eq 1) { + $result = $true + } + } + if (!($result)) + { + Handle-Error("Critical Kiln Server error. Elastic Search is not running!") + $serviceNeedsRestart.value = $true + }  }       -function Test-HttpResponse($url, $searchString) +function Test-HttpResponse($url, $searchString, [ref]$serviceNeedsRestart)  {   Write-WithTime "Checking for expected response from URL ($url)..."   @@ -48,25 +89,186 @@
  $response = (New-Object net.webclient).DownloadString($url)   $response = (New-Object net.webclient).DownloadString($url)   $result = $response | select-string $searchString - if ($result) { Write-WithTime "Success!" } - else { Write-WithTime "FAILURE!" } + if (!($result)) + { + Handle-Error("Critical Kiln Server error. URL [$url] did not contain the expected string `'$searchString`'") + $serviceNeedsRestart.value = $true + }   }   catch [Net.WebException]   { - Write-WithTime $_.Exception.ToString() + $exceptionMessage = $_.Exception.Message + Handle-Error("Critical Kiln Server error. Could not reach URL [$url]`n$exceptionMessage") + $serviceNeedsRestart = $true   }  }     +function Test-QueueStats([ref]$serviceNeedsRestart) +{ + try + { + $response = (New-Object System.Net.WebClient).DownloadString($queueStatsUrl) + + $stats = Convert-JsonToXml($response) + + $statsTime = [long]$stats.root.currentTime."#text" + $timeDiff = (((Get-Date).ToUniversalTime().Ticks / 10e6) - $statsTime) + $queueLength = [int]$stats.root.queueLength."#text" + $runningTaskCount = $stats.root.runningTasks.ChildNodes.count + $oldestTaskAge = [int]$stats.root.oldestRunningTaskTotalSeconds."#text"   -Test-ProcessRunning "backend" -Test-ProcessRunning "redis-server" 2 -Test-ProcessRunning "QueueService" -Test-ElasticSearchRunning   -Test-HttpResponse $kilnURL "Log on to Kiln" -Test-HttpResponse $backendVersionUrl '"hg_version"' -Test-HttpResponse $EsUrl '"status" : 200' -Test-HttpResponse $QueueStatsUrl '"queueName":"Kiln"'   -# TODO: Parse the QueueStats data and alert when poor behavior is detected. Attempt automatic restart? \ No newline at end of file
+ + if (($timeDiff -gt 5) -or ($timeDiff -lt 5)) + { + $serviceNeedsRestart = $true + } + + + # This is a warning sign, so just alert, but don't attempt to restart the service yet. + if ($queueLength -gt 50) + { + Handle-Error("The Kiln Queue is exceptionally long ($queueLength tasks), this might by a symptom of a recent large change or a problem.") + } + + + # This is a warning sign, so just alert, but don't attempt to restart the service yet. + if ($runningTaskCount -gt 16) + { + Handle-Error("Too many tasks ($runningTaskCount) are currently running in the Kiln Queue.") + } + + + # Longer than 15 minutes on a task? This is a bad sign, time to give it some help! + if ( $oldestTaskAge -gt (15*60) ) + { + Handle-Error("Oldest task has been running for $oldestTaskAge seconds!") + + if (test-path $reenqueuePath) + { + Start-Process $reenqueuePath "-retryRunning" + } + } + + } + catch [Exception] + { + $exceptionMessage = $_.Exception.Message + Handle-Error("Error obtaining or processing Kiln Queue Stats`n$exceptionMessage") + $serviceNeedsRestart = $true + } +} + + + + +# This is provided as an alternative to ConvertFrom-JSON, which requires Powershell V3. +# Powershell V3 is not on most servers by default and requires a reboot to install, so here we are instead... +# Source: (https://www.cogmotive.com/blog/powershell/parsing-json-in-powershell-xml-the-member-item-is-already-present) +Add-Type -Assembly System.ServiceModel.Web,System.Runtime.Serialization +function Convert-JsonToXml([string]$json) +{ + $bytes = [byte[]][char[]]$json + $quotas = [System.Xml.XmlDictionaryReaderQuotas]::Max + $jsonReader = [System.Runtime.Serialization.Json.JsonReaderWriterFactory]::CreateJsonReader($bytes,$quotas) + try + { + $xml = new-object System.Xml.XmlDocument + $xml.Load($jsonReader) + $xml + } + finally + { + $jsonReader.Close() + } +} + + + +########################### END FUNCTION DEFINITIONS ########################### + + + + + +$tryAutoRestart = !($noRestart) # Needed a negative name for the parameter since the default is true. Sanity rename here. +$kssNeedsRestart = $false +$kqsNeedsRestart = $false +$iisNeedsRestart = $false + +Test-ProcessRunning "backend" 1 -serviceNeedsRestart ([ref]$kssNeedsRestart) +Test-ProcessRunning "redis-server" 2 -serviceNeedsRestart ([ref]$kssNeedsRestart) +Test-ElasticSearchRunning -serviceNeedsRestart ([ref]$kssNeedsRestart) +Test-ProcessRunning "QueueService" -serviceNeedsRestart ([ref]$kqsNeedsRestart) + +Test-HttpResponse $kilnURL "Log on to Kiln" -serviceNeedsRestart ([ref]$iisNeedsRestart) +Test-HttpResponse $backendVersionUrl '"hg_version"' -serviceNeedsRestart ([ref]$kssNeedsRestart) +Test-HttpResponse $esUrl '"status" : 200' -serviceNeedsRestart ([ref]$kssNeedsRestart) +Test-HttpResponse $queueStatsUrl '"queueName":"Kiln"' -serviceNeedsRestart ([ref]$kqsNeedsRestart) + +Test-QueueStats -serviceNeedsRestart ([ref]$kqsNeedsRestart) + + + + + + + +Write-Host "`n" + + + +if ($iisNeedsRestart -and $iisSiteName -and $tryAutoRestart) +{ + Write-WithTime "Attemping to restart site $iisSiteName in IIS...`n" + + $appcmd = $env:SystemRoot + "\system32\inetsrv\appcmd.exe" + $stopArgs = "stop site /site.name:$iisSiteName" + $startArgs = "start site /site.name:$iisSiteName" + + Start-Process $appcmd $stopArgs + Start-Process $appcmd $startArgs +} + + +if ($kssNeedsRestart -and $tryAutoRestart) +{ + Write-WithTime "Attempting to restart Kiln Storage Service..." + + # Find and stop the java.exe process that is running Elastic Search + (Get-WmiObject win32_process -Filter "name like 'java.exe'") | ForEach-Object { + if (($_.CommandLine | select-string "ElasticSearch" | measure).count -eq 1) { + Stop-Process -id $_.ProcessId -Force -EV Err -EA "SilentlyContinue" + } + } + + # Try to stop the processes, but don't show any errors (it might already be stopped) + + # This will stop both of the redis-server.exe processes because the have the same name + Stop-Process -name redis-server -Force -EV Err -EA "SilentlyContinue" + + Stop-Process -name backend -Force -EV Err -EA "SilentlyContinue" + + Start-Service KilnStorageService +} + + + +if ($kqsNeedsRestart -and $tryAutoRestart) +{ + Write-WithTime "Attempting to restart Kiln Queuing Service..." + + # Try to stop the process, but don't show any errors (it might already be stopped) + Stop-Process -name QueueService -Force -EV Err -EA "SilentlyContinue" + + Start-Sleep -s 1 + Start-Service "Kiln Queuing Service" +} + + + + + +