forked from grafana/grafana-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
/
grafana_client.go
255 lines (208 loc) · 6.34 KB
/
grafana_client.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
package grafanadashboardfolder
import (
"bytes"
"crypto/md5" //nolint
"encoding/json"
"fmt"
"github.com/grafana-operator/grafana-operator/v4/api/integreatly/v1alpha1"
"io"
"net/http"
"net/url"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"strings"
"time"
)
const (
CreateOrUpdateFolderUrl = "%v/api/folders"
FolderPermissionsUrl = "%v/api/folders/%v/permissions"
)
type GrafanaFolderPermissionsResponse struct {
ID *int64 `json:"id"`
Title string `json:"title"`
Message string `json:"message"`
}
type GrafanaFolderResponse struct {
ID *int64 `json:"id"`
Title string `json:"title"`
UID string `json:"uid"`
}
type GrafanaFolderRequest struct {
Title string `json:"title"`
UID string `json:"uid"`
}
type GrafanaClient interface {
FindOrCreateFolder(folderName string) (GrafanaFolderResponse, error)
ApplyFolderPermissions(folderName string, folderPermissions []*v1alpha1.GrafanaPermissionItem) (GrafanaFolderPermissionsResponse, error)
}
type GrafanaClientImpl struct {
url string
user string
password string
client *http.Client
}
func setHeaders(req *http.Request) {
req.Header.Set("Accept", "application/json")
req.Header.Set("Content-Type", "application/json")
req.Header.Set("User-Agent", "grafana-operator")
}
func NewGrafanaClient(url, user, password string, transport *http.Transport, timeoutSeconds time.Duration) GrafanaClient {
client := &http.Client{
Transport: transport,
Timeout: time.Second * timeoutSeconds,
}
return &GrafanaClientImpl{
url: url,
user: user,
password: password,
client: client,
}
}
var logger = logf.Log.WithName("folder-grafana-client")
func (r *GrafanaClientImpl) getAllFolders() ([]GrafanaFolderResponse, error) {
rawURL := fmt.Sprintf(CreateOrUpdateFolderUrl, r.url)
parsed, err := url.Parse(rawURL)
if err != nil {
return nil, err
}
parsed.User = url.UserPassword(r.user, r.password)
req, err := http.NewRequest("GET", parsed.String(), nil)
if err != nil {
return nil, err
}
setHeaders(req)
resp, err := r.client.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
// Grafana might be unavailable, no reason to panic, other checks are in place
if resp.StatusCode == 503 {
return nil, nil
} else {
return nil, fmt.Errorf(
"error getting folders, expected status 200 but got %v",
resp.StatusCode)
}
}
data, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var folders []GrafanaFolderResponse
err = json.Unmarshal(data, &folders)
return folders, err
}
func newFolderResponse() GrafanaFolderResponse {
var id int64 = 0
return GrafanaFolderResponse{
ID: &id,
}
}
func (r *GrafanaClientImpl) FindOrCreateFolder(folderName string) (GrafanaFolderResponse, error) {
response := newFolderResponse()
existingFolders, err := r.getAllFolders()
if err != nil {
return response, err
}
for _, folder := range existingFolders {
if strings.EqualFold(folder.Title, folderName) {
return folder, nil
}
}
rawURL := fmt.Sprintf(CreateOrUpdateFolderUrl, r.url)
apiUrl, err := url.Parse(rawURL)
if err != nil {
return response, err
}
raw, err := json.Marshal(GrafanaFolderRequest{
Title: folderName,
UID: buildFolderUidFromName(folderName),
})
if err != nil {
return response, err
}
apiUrl.User = url.UserPassword(r.user, r.password)
req, err := http.NewRequest("POST", apiUrl.String(), bytes.NewBuffer(raw))
if err != nil {
return response, err
}
setHeaders(req)
resp, err := r.client.Do(req)
if err != nil {
return response, err
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
if resp.StatusCode == 503 {
return GrafanaFolderResponse{}, nil
} else {
return response, fmt.Errorf(
"error creating folder, expected status 200 but got %v",
resp.StatusCode)
}
}
data, err := io.ReadAll(resp.Body)
if err != nil {
return response, err
}
err = json.Unmarshal(data, &response)
return response, err
}
func buildFolderUidFromName(folderName string) string {
// uid must not exceed 40 chars
return fmt.Sprintf("%x", md5.Sum([]byte(folderName))) //nolint
}
func (r *GrafanaClientImpl) ApplyFolderPermissions(folderName string, folderPermissions []*v1alpha1.GrafanaPermissionItem) (GrafanaFolderPermissionsResponse, error) {
response := GrafanaFolderPermissionsResponse{}
// ensure folder exists - permissions can only be applied to existing folders, so we need its UID
existingFolder, err := r.FindOrCreateFolder(folderName)
if err != nil {
return response, err
}
rawURL := fmt.Sprintf(FolderPermissionsUrl, r.url, existingFolder.UID)
apiUrl, err := url.Parse(rawURL)
if err != nil {
return response, err
}
requestBody := buildFolderPermissionRequestBody(folderPermissions)
apiUrl.User = url.UserPassword(r.user, r.password)
req, err := http.NewRequest("POST", apiUrl.String(), bytes.NewBuffer([]byte(requestBody)))
if err != nil {
return response, err
}
setHeaders(req)
resp, err := r.client.Do(req)
if err != nil {
return response, err
}
defer resp.Body.Close()
if resp.StatusCode == 503 {
return response, nil
} else if resp.StatusCode != 200 {
logger.V(1).Info(fmt.Sprintf("used request-data: url '%s' with body '%s'", rawURL, requestBody)) // use rawURL instead of apiUrl to not expose credentials in log
return response, fmt.Errorf("error setting folder-permissions, expected status 200 but got %v", resp.StatusCode)
}
responseBody, err := io.ReadAll(resp.Body)
if err != nil {
return response, err
}
err = json.Unmarshal(responseBody, &response)
return response, err
}
// buildFolderPermissionRequestBody creates a JSON-String according to the Spec of the HTTP-API:
// https://grafana.com/docs/grafana/latest/developers/http_api/folder_permissions/#update-permissions-for-a-folder
// Due to the rather dynamic key-names, that must be done programmatically rather than via marshaling an object
func buildFolderPermissionRequestBody(folderPermissions []*v1alpha1.GrafanaPermissionItem) string {
var b strings.Builder
b.WriteString("{ \"items\": [ ")
// TODO: support other targetTypes (teamId and userId) - value-type must be integer then
for i, item := range folderPermissions {
fmt.Fprintf(&b, "{%q: %q, \"permission\": %d}", item.PermissionTargetType, item.PermissionTarget, item.PermissionLevel)
if i+1 < len(folderPermissions) {
b.WriteString(",")
}
}
b.WriteString(" ]}")
return b.String()
}