-
Notifications
You must be signed in to change notification settings - Fork 18
/
monitor.go
350 lines (316 loc) · 12.7 KB
/
monitor.go
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/***************************************************************
*
* Copyright (C) 2024, Pelican Project, Morgridge Institute for Research
*
* Licensed under the Apache License, Version 2.0 (the "License"); you
* may not use this file except in compliance with the License. You may
* obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
***************************************************************/
package director
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"time"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
log "github.com/sirupsen/logrus"
"github.com/pelicanplatform/pelican/config"
"github.com/pelicanplatform/pelican/metrics"
"github.com/pelicanplatform/pelican/param"
"github.com/pelicanplatform/pelican/server_structs"
"github.com/pelicanplatform/pelican/server_utils"
"github.com/pelicanplatform/pelican/token"
"github.com/pelicanplatform/pelican/token_scopes"
)
var originReportNotFoundError = errors.New("Origin does not support new reporting API")
// Report the health status of test file transfer to storage server
func reportStatusToServer(ctx context.Context, serverWebUrl string, status string, message string, serverType server_structs.ServerType, fallback bool) error {
directorUrl, err := url.Parse(param.Server_ExternalWebUrl.GetString())
if err != nil {
return errors.Wrapf(err, "failed to parse external URL %v", param.Server_ExternalWebUrl.GetString())
}
testTokenCfg := token.NewWLCGToken()
testTokenCfg.Lifetime = time.Minute
testTokenCfg.Issuer = directorUrl.String()
testTokenCfg.AddAudiences(serverWebUrl)
testTokenCfg.Subject = "director"
testTokenCfg.AddScopes(token_scopes.Pelican_DirectorTestReport)
tok, err := testTokenCfg.CreateToken()
if err != nil {
return errors.Wrap(err, "failed to create director test report token")
}
reportUrl, err := url.Parse(serverWebUrl)
if err != nil {
return errors.Wrap(err, "the server URL is not parseable as an URL")
}
if status != "ok" && status != "error" {
return errors.Errorf("bad status for reporting director test %s", status)
}
if serverType == server_structs.OriginType {
if fallback {
reportUrl.Path = "/api/v1.0/origin-api/directorTest"
} else {
reportUrl.Path = "/api/v1.0/origin/directorTest"
}
} else if serverType == server_structs.CacheType {
reportUrl.Path = "/api/v1.0/cache/directorTest"
}
dt := server_structs.DirectorTestResult{
Status: status,
Message: message,
Timestamp: time.Now().Unix(),
}
jsonData, err := json.Marshal(dt)
if err != nil {
return errors.Wrap(err, "failed to parse request body for reporting director test")
}
reqBody := bytes.NewBuffer(jsonData)
log.Debugf("Director is sending %s server test result to %s", string(serverType), reportUrl.String())
req, err := http.NewRequestWithContext(ctx, http.MethodPost, reportUrl.String(), reqBody)
if err != nil {
return errors.Wrap(err, "failed to create POST request for reporting director test")
}
req.Header.Set("Authorization", "Bearer "+tok)
req.Header.Set("Content-Type", "application/json")
tr := config.GetTransport()
client := http.Client{Transport: tr}
resp, err := client.Do(req)
if err != nil {
return errors.Wrap(err, "Failed to start request for reporting director test")
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
return errors.Wrap(err, "Failed to read response body for reporting director test")
}
if resp.StatusCode > 404 { // For all servers, >404 is a failure
return errors.Errorf("error response %v from reporting director test: %v", resp.StatusCode, string(body))
}
if serverType == server_structs.OriginType && resp.StatusCode != 200 {
return errors.Errorf("error response %v from reporting director test: %v", resp.StatusCode, string(body))
}
if serverType == server_structs.CacheType && resp.StatusCode == 404 {
return errors.New("cache reports a 404 error. For cache version < v7.7.0, director-based test is not supported")
}
if serverType == server_structs.OriginType && resp.StatusCode == 404 {
return originReportNotFoundError
}
return nil
}
// Run a periodic test file transfer against an origin to ensure
// it's talking to the director
func LaunchPeriodicDirectorTest(ctx context.Context, serverAd server_structs.ServerAd) {
serverName := serverAd.Name
serverUrl := serverAd.URL.String()
serverWebUrl := serverAd.WebURL.String()
log.Debug(fmt.Sprintf("Starting a new director test suite for %s server %s at %s", serverAd.Type, serverName, serverUrl))
metrics.PelicanDirectorFileTransferTestSuite.With(
prometheus.Labels{
"server_name": serverName, "server_web_url": serverWebUrl, "server_type": string(serverAd.Type),
}).Inc()
metrics.PelicanDirectorActiveFileTransferTestSuite.With(
prometheus.Labels{
"server_name": serverName, "server_web_url": serverWebUrl, "server_type": string(serverAd.Type),
}).Inc()
customInterval := param.Director_OriginCacheHealthTestInterval.GetDuration()
if customInterval < 15*time.Second {
log.Warningf("You set Director.OriginCacheHealthTestInterval to a very small number %s, which will cause high traffic volume to xrootd servers.", customInterval.String())
}
if customInterval == 0 {
customInterval = 15 * time.Second
log.Error("Invalid config value: Director.OriginCacheHealthTestInterval is 0. Fallback to 15s.")
}
ticker := time.NewTicker(customInterval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
log.Debug(fmt.Sprintf("End director test suite for %s server %s at %s", serverAd.Type, serverName, serverUrl))
metrics.PelicanDirectorActiveFileTransferTestSuite.With(
prometheus.Labels{
"server_name": serverName, "server_web_url": serverWebUrl, "server_type": string(serverAd.Type),
}).Dec()
return
case <-ticker.C:
log.Debug(fmt.Sprintf("Starting a director test cycle for %s server %s at %s", serverAd.Type, serverName, serverUrl))
ok := true
var err error
if serverAd.Type == server_structs.OriginType {
fileTests := server_utils.TestFileTransferImpl{}
ok, err = fileTests.RunTests(ctx, serverUrl, serverUrl, "", server_utils.DirectorFileTest)
} else if serverAd.Type == server_structs.CacheType {
err = runCacheTest(ctx, serverAd.URL)
}
// Successfully run a test, no error
if ok && err == nil {
log.Debugf("Director file transfer test cycle succeeded at %s for %s server with URL at %s", time.Now().Format(time.RFC3339), serverAd.Type, serverUrl)
func() {
healthTestUtilsMutex.Lock()
defer healthTestUtilsMutex.Unlock()
if existingUtil, ok := healthTestUtils[serverAd]; ok {
existingUtil.Status = HealthStatusOK
} else {
log.Debugln("HealthTestUtil missing for ", serverAd.Type, " server: ", serverUrl, " Failed to update internal status")
}
}()
// Report error back to origin/server
if err := reportStatusToServer(
ctx,
serverWebUrl,
"ok", "Director test cycle succeeded at "+time.Now().Format(time.RFC3339),
serverAd.Type,
false,
); err != nil {
// origin <7.7 only supports legacy report endpoint. Fallback to the legacy one
if err == originReportNotFoundError {
newErr := reportStatusToServer(
ctx,
serverWebUrl,
"ok", "Director test cycle succeeded at "+time.Now().Format(time.RFC3339),
serverAd.Type,
true, // Fallback to legacy endpoint
)
// If legacy endpoint still reports error
if newErr != nil {
log.Warningf("Failed to report director test result to %s server at %s: %v", serverAd.Type, serverAd.WebURL.String(), err)
metrics.PelicanDirectorFileTransferTestsRuns.With(
prometheus.Labels{
"server_name": serverName,
"server_web_url": serverWebUrl,
"server_type": string(serverAd.Type),
"status": string(metrics.FTXTestSucceeded),
"report_status": string(metrics.FTXTestFailed),
},
).Inc()
// Successfully report to the origin/cache via the legacy endpoint
} else {
metrics.PelicanDirectorFileTransferTestsRuns.With(
prometheus.Labels{
"server_name": serverName,
"server_web_url": serverWebUrl,
"server_type": string(serverAd.Type),
"status": string(metrics.FTXTestSucceeded),
"report_status": string(metrics.FTXTestSucceeded),
},
).Inc()
}
// If the error is not originReportNotFoundError, then we record the error right away
} else {
log.Warningf("Failed to report director test result to %s server at %s: %v", serverAd.Type, serverAd.WebURL.String(), err)
metrics.PelicanDirectorFileTransferTestsRuns.With(
prometheus.Labels{
"server_name": serverName,
"server_web_url": serverWebUrl,
"server_type": string(serverAd.Type),
"status": string(metrics.FTXTestSucceeded),
"report_status": string(metrics.FTXTestFailed),
},
).Inc()
}
// No error when reporting the result, we are good
} else {
metrics.PelicanDirectorFileTransferTestsRuns.With(
prometheus.Labels{
"server_name": serverName,
"server_web_url": serverWebUrl,
"server_type": string(serverAd.Type),
"status": string(metrics.FTXTestSucceeded),
"report_status": string(metrics.FTXTestSucceeded),
},
).Inc()
}
// The file tests failed. Report failure back to origin/cache
} else {
log.Warningln("Director file transfer test cycle failed for ", serverAd.Type, " server: ", serverUrl, " ", err)
func() {
healthTestUtilsMutex.Lock()
defer healthTestUtilsMutex.Unlock()
if existingUtil, ok := healthTestUtils[serverAd]; ok {
existingUtil.Status = HealthStatusError
} else {
log.Debugln("HealthTestUtil missing for", serverAd.Type, " server: ", serverUrl, " Failed to update internal status")
}
}()
if err := reportStatusToServer(
ctx,
serverWebUrl,
"error", "Director file transfer test cycle failed for origin: "+serverUrl+" "+err.Error(),
serverAd.Type,
false,
); err != nil {
// origin <7.7 only supports legacy report endpoint. Fallback to the legacy one
if err == originReportNotFoundError {
newErr := reportStatusToServer(
ctx,
serverWebUrl,
"ok", "Director test cycle succeeded at "+time.Now().Format(time.RFC3339),
serverAd.Type,
true, // Fallback to legacy endpoint
)
// If legacy endpoint still reports error
if newErr != nil {
log.Warningf("Failed to report director test result to %s server at %s: %v", serverAd.Type, serverAd.WebURL.String(), err)
metrics.PelicanDirectorFileTransferTestsRuns.With(
prometheus.Labels{
"server_name": serverName,
"server_web_url": serverWebUrl,
"server_type": string(serverAd.Type),
"status": string(metrics.FTXTestFailed),
"report_status": string(metrics.FTXTestFailed),
},
).Inc()
// Successfully report to the origin/cache via the legacy endpoint
} else {
metrics.PelicanDirectorFileTransferTestsRuns.With(
prometheus.Labels{
"server_name": serverName,
"server_web_url": serverWebUrl,
"server_type": string(serverAd.Type),
"status": string(metrics.FTXTestFailed),
"report_status": string(metrics.FTXTestSucceeded),
},
).Inc()
}
// If the error is not originReportNotFoundError, then we record the error right away
} else {
log.Warningf("Failed to report director test result to %s server at %s: %v", serverAd.Type, serverAd.WebURL.String(), err)
metrics.PelicanDirectorFileTransferTestsRuns.With(
prometheus.Labels{
"server_name": serverName,
"server_web_url": serverWebUrl,
"server_type": string(serverAd.Type),
"status": string(metrics.FTXTestFailed),
"report_status": string(metrics.FTXTestFailed),
},
).Inc()
}
} else {
// No error when reporting the result, we are good
metrics.PelicanDirectorFileTransferTestsRuns.With(
prometheus.Labels{
"server_name": serverName,
"server_web_url": serverWebUrl,
"server_type": string(serverAd.Type),
"status": string(metrics.FTXTestFailed),
"report_status": string(metrics.FTXTestSucceeded),
},
).Inc()
}
}
}
}
}