-
Notifications
You must be signed in to change notification settings - Fork 94
/
config_upload.go
367 lines (300 loc) · 10.8 KB
/
config_upload.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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
/**
* @license
* Copyright 2020 Dynatrace LLC
* 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 rest
import (
"encoding/json"
"fmt"
"net/http"
"strings"
"time"
"github.com/dynatrace-oss/dynatrace-monitoring-as-code/pkg/api"
"github.com/dynatrace-oss/dynatrace-monitoring-as-code/pkg/util"
)
func upsertDynatraceObject(client *http.Client, fullUrl string, objectName string, theApi api.Api, payload []byte, apiToken string) (api.DynatraceEntity, error) {
existingObjectId, err := getObjectIdIfAlreadyExists(client, theApi, fullUrl, objectName, apiToken)
var dtEntity api.DynatraceEntity
if err != nil {
return dtEntity, err
}
var resp Response
path := fullUrl
body := payload
configType := theApi.GetId()
// The calculated-metrics-log API doesn't have a POST endpoint, to create a new log metric we need to use PUT which
// requires a metric key for which we can just take the objectName
if configType == "calculated-metrics-log" && existingObjectId == "" {
existingObjectId = objectName
}
if existingObjectId != "" {
path = joinUrl(fullUrl, existingObjectId)
// Updating a dashboard requires the ID to be contained in the JSON, so we just add it...
if isApiDashboard(theApi) {
tmp := strings.Replace(string(payload), "{", "{\n\"id\":\""+existingObjectId+"\",\n", 1)
body = []byte(tmp)
}
resp, err = put(client, path, body, apiToken)
if err != nil {
return api.DynatraceEntity{}, err
}
} else {
if configType == "app-detection-rule" {
path += "?position=PREPEND"
}
resp, err = post(client, path, body, apiToken)
if err != nil {
return api.DynatraceEntity{}, err
}
// It can happen that the post fails because config needs time to be propagated on all cluster nodes. If the error
// constraintViolations":[{"path":"name","message":"X must have a unique name...
// is returned, try once again
if !success(resp) && strings.Contains(string(resp.Body), "must have a unique name") {
// Try again after 5 seconds:
util.Log.Warn("\t\tConfig '%s - %s' needs to have a unique name. Waiting for 5 seconds before retry...", configType, objectName)
time.Sleep(5 * time.Second)
resp, err = post(client, path, body, apiToken)
if err != nil {
return api.DynatraceEntity{}, err
}
}
// It can take longer until request attributes are ready to be used
if !success(resp) && strings.Contains(string(resp.Body), "must specify a known request attribute") {
util.Log.Warn("\t\tSpecified request attribute not known for %s. Waiting for 10 seconds before retry...", objectName)
time.Sleep(10 * time.Second)
resp, err = post(client, path, body, apiToken)
if err != nil {
return api.DynatraceEntity{}, err
}
}
}
if !success(resp) {
return dtEntity, fmt.Errorf("Failed to upsert DT object %s (HTTP %d)!\n Response was: %s", objectName, resp.StatusCode, string(resp.Body))
}
if updateSuccess(resp) {
util.Log.Debug("\t\t\tUpdated existing object for %s (%s)", objectName, existingObjectId)
return api.DynatraceEntity{
Id: existingObjectId,
Name: objectName,
Description: "Updated existing object",
}, nil
}
if configType == "synthetic-monitor" || configType == "synthetic-location" {
var entity api.SyntheticEntity
err := json.Unmarshal(resp.Body, &entity)
if util.CheckError(err, "Cannot unmarshal Synthetic API response") {
return dtEntity, err
}
dtEntity = translateSyntheticEntityResponse(entity, objectName)
} else if available, locationSlice := isLocationHeaderAvailable(resp); available {
// The SLO API does not return the ID of the config in its response. Instead, it contains a Location header,
// which contains the URL to the created resource. This URL needs to be cleaned, to get the ID of the
// config.
if len(locationSlice) == 0 {
return dtEntity,
fmt.Errorf("location response header was empty for API %s (name: %s)", configType, objectName)
}
location := locationSlice[0]
// Some APIs prepend the environment URL. If available, trim it from the location
existingObjectId = strings.TrimPrefix(location, fullUrl)
existingObjectId = strings.TrimPrefix(existingObjectId, "/")
dtEntity = api.DynatraceEntity{
Id: existingObjectId,
Name: objectName,
Description: "Created object",
}
} else {
err := json.Unmarshal(resp.Body, &dtEntity)
if util.CheckError(err, "Cannot unmarshal API response") {
return dtEntity, err
}
}
util.Log.Debug("\t\t\tCreated new object for %s (%s)", dtEntity.Name, dtEntity.Id)
return dtEntity, nil
}
func joinUrl(urlBase string, path string) string {
if strings.HasSuffix(urlBase, "/") {
return urlBase + path
}
return urlBase + "/" + path
}
func isLocationHeaderAvailable(resp Response) (headerAvailable bool, headerArray []string) {
if resp.Headers["Location"] != nil {
return true, resp.Headers["Location"]
}
return false, make([]string, 0)
}
func deleteDynatraceObject(client *http.Client, api api.Api, name string, url string, token string) error {
existingId, err := getObjectIdIfAlreadyExists(client, api, url, name, token)
if err != nil {
return err
}
if len(existingId) > 0 {
deleteConfig(client, url, token, existingId)
}
return nil
}
func getObjectIdIfAlreadyExists(client *http.Client, api api.Api, url string, objectName string, apiToken string) (existingId string, err error) {
values, err := getExistingValuesFromEndpoint(client, api, url, apiToken)
if err != nil {
return "", err
}
for i := 0; i < len(values); i++ {
value := values[i]
if value.Name == objectName {
return value.Id, nil
}
}
return "", nil
}
func isApiDashboard(api api.Api) bool {
return api.GetId() == "dashboard"
}
func getExistingValuesFromEndpoint(client *http.Client, theApi api.Api, url string, apiToken string) (values []api.Value, err error) {
var existingValues []api.Value
resp, err := get(client, url, apiToken)
if err != nil {
return nil, err
}
for {
err, values, objmap := unmarshalJson(theApi, err, resp)
if err != nil {
return values, err
}
existingValues = append(existingValues, values...)
// Does the API support paging?
if isPaginated, nextPage := isPaginatedResponse(objmap); isPaginated {
resp, err = get(client, url+"?nextPageKey="+nextPage, apiToken)
if err != nil {
return nil, err
}
} else {
break
}
}
return existingValues, nil
}
func unmarshalJson(theApi api.Api, err error, resp Response) (error, []api.Value, map[string]interface{}) {
var values []api.Value
var objmap map[string]interface{}
// This API returns an untyped list as a response -> it needs a special handling
if theApi.GetId() == "aws-credentials" {
var jsonResp []api.Value
err := json.Unmarshal(resp.Body, &jsonResp)
if util.CheckError(err, "Cannot unmarshal API response for existing aws-credentials") {
return err, values, objmap
}
values = jsonResp
} else {
if err := json.Unmarshal(resp.Body, &objmap); err != nil {
return err, nil, nil
}
if theApi.GetId() == "synthetic-location" {
var jsonResp api.SyntheticLocationResponse
err = json.Unmarshal(resp.Body, &jsonResp)
if util.CheckError(err, "Cannot unmarshal API response for existing synthetic location") {
return err, nil, nil
}
values = translateSyntheticValues(jsonResp.Locations)
} else if theApi.GetId() == "synthetic-monitor" {
var jsonResp api.SyntheticMonitorsResponse
err = json.Unmarshal(resp.Body, &jsonResp)
if util.CheckError(err, "Cannot unmarshal API response for existing synthetic location") {
return err, nil, nil
}
values = translateSyntheticValues(jsonResp.Monitors)
} else if !theApi.IsStandardApi() {
if available, array := isResultArrayAvailable(objmap, theApi); available {
jsonResp, err := translateGenericValues(array, theApi.GetId())
if err != nil {
return err, nil, nil
}
values = jsonResp
}
} else {
var jsonResponse api.ValuesResponse
err = json.Unmarshal(resp.Body, &jsonResponse)
if util.CheckError(err, "Cannot unmarshal API response for existing objects") {
return err, nil, nil
}
values = jsonResponse.Values
}
}
return nil, values, objmap
}
func isResultArrayAvailable(jsonResponse map[string]interface{}, theApi api.Api) (resultArrayAvailable bool, results []interface{}) {
if jsonResponse[theApi.GetPropertyNameOfGetAllResponse()] != nil {
return true, jsonResponse[theApi.GetPropertyNameOfGetAllResponse()].([]interface{})
}
return false, make([]interface{}, 0)
}
func isPaginatedResponse(jsonResponse map[string]interface{}) (paginated bool, pageKey string) {
if jsonResponse["nextPageKey"] != nil {
return true, jsonResponse["nextPageKey"].(string)
}
return false, ""
}
func translateGenericValues(inputValues []interface{}, configType string) ([]api.Value, error) {
numValues := len(inputValues)
values := make([]api.Value, numValues, numValues)
for i := 0; i < numValues; i++ {
input := inputValues[i].(map[string]interface{})
if input["id"] == nil {
return values, fmt.Errorf("config of type %s was invalid: No id", configType)
}
// repair invalid configs - but log them
if input["name"] == nil {
jsonStr, err := json.Marshal(input)
if err != nil {
util.Log.Warn("Config of type %s was invalid. Ignoring it!", configType)
continue
}
util.Log.Warn("Config of type %s was invalid. Auto-corrected to use ID as name!\nInvalid config: %s", configType, string(jsonStr))
values[i] = api.Value{
Id: input["id"].(string),
Name: input["id"].(string), // use the id as name
}
continue
}
values[i] = api.Value{
Id: input["id"].(string),
Name: input["name"].(string),
}
}
return values, nil
}
func translateSyntheticValues(syntheticValues []api.SyntheticValue) []api.Value {
numValues := len(syntheticValues)
values := make([]api.Value, numValues, numValues)
for i := 0; i < numValues; i++ {
loc := syntheticValues[i]
values[i] = api.Value{
Id: loc.EntityId,
Name: loc.Name,
}
}
return values
}
func translateSyntheticEntityResponse(resp api.SyntheticEntity, objectName string) api.DynatraceEntity {
return api.DynatraceEntity{
Name: objectName,
Id: resp.EntityId,
}
}
func success(resp Response) bool {
return resp.StatusCode == http.StatusOK || resp.StatusCode == http.StatusCreated || resp.StatusCode == http.StatusNoContent
}
func updateSuccess(resp Response) bool {
return resp.StatusCode == http.StatusNoContent
}