1 # -*- coding: utf-8 -*-
3 # Copyright 2018 Whitestack, LLC
4 # *************************************************************
6 # This file is part of OSM Monitoring module
7 # All Rights Reserved to Whitestack, LLC
9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
10 # not use this file except in compliance with the License. You may obtain
11 # a copy of the License at
13 # http://www.apache.org/licenses/LICENSE-2.0
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
18 # License for the specific language governing permissions and limitations
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact: glavado@whitestack.com or fbravo@whitestack.com
27 from osm_mon
.core
.config
import Config
29 log
= logging
.getLogger(__name__
)
33 def __init__(self
, config
: Config
):
35 self
.url
= config
.get("grafana", "url")
36 grafana_user
= config
.get("grafana", "user")
37 grafana_password
= config
.get("grafana", "password")
39 "content-type": "application/json",
40 "authorization": "Basic %s"
42 (grafana_user
+ ":" + grafana_password
).encode("utf-8")
46 def get_all_dashboard_uids(self
):
47 # Gets only dashboards that were automated by OSM (with tag 'osm_automated')
48 response
= requests
.request(
49 "GET", self
.url
+ "/api/search?tag=osm_automated", headers
=self
.headers
51 dashboards
= response
.json()
53 for dashboard
in dashboards
:
54 dashboard_uids
.append(dashboard
["uid"])
55 log
.debug("Searching for all dashboard uids: %s", dashboard_uids
)
58 def get_all_datasource_names(self
, datasource_name_substr
):
59 # Gets only dashboards that were created for prom-operator
60 response
= requests
.request(
61 "GET", self
.url
+ "/api/datasources", headers
=self
.headers
63 datasources
= response
.json()
65 for datasource
in datasources
:
66 if datasource
["name"].startswith(datasource_name_substr
):
67 datasource_names
.append(datasource
["name"])
68 log
.debug("Searching for all datasource names: %s", datasource_names
)
69 return datasource_names
71 def get_dashboard_status(self
, uid
):
72 response
= requests
.request(
73 "GET", self
.url
+ "/api/dashboards/uid/" + uid
, headers
=self
.headers
75 log
.debug("Searching for dashboard result: %s", response
.text
)
78 def create_dashboard(self
, uid
, name
, json_file
, project_name
=None, datasource_name
=None):
80 with
open(json_file
) as f
:
81 dashboard_data
= f
.read()
83 dashboard_data
= dashboard_data
.replace("OSM_ID", uid
).replace(
87 dashboard_data
= dashboard_data
.replace("OSM_DATASOURCE_NAME", datasource_name
)
88 dashboard_json_data
= json
.loads(dashboard_data
)
91 folder_name
= project_name
94 response_folder_id
= requests
.request(
96 self
.url
+ "/api/folders/{}".format(folder_name
),
99 if response_folder_id
.status_code
== 200:
100 folder_id
= json
.loads(response_folder_id
.text
)["id"]
101 dashboard_json_data
["folderId"] = folder_id
102 dashboard_json_data
["overwrite"] = False
104 response
= self
.send_request_for_creating_dashboard(dashboard_json_data
)
106 # Admin dashboard will be created if already exists. Rest will remain same.
107 if json
.loads(response
.text
).get("status") == "name-exists":
108 # Delete any previous project-admin dashboard if it already exist.
110 self
.delete_admin_dashboard()
111 response
= self
.send_request_for_creating_dashboard(
118 if project_name
is not None:
120 response_team
= requests
.request(
122 self
.url
+ "/api/teams/search?name={}".format(name
),
123 headers
=self
.headers
,
126 # Remove default permissions of admin user's dashboard so that it is not visible to non-admin users
127 if len(json
.loads(response_team
.text
)["teams"]) == 0:
128 # As team information is not available so it is admin user
129 dahboard_id
= json
.loads(response
.text
)["id"]
132 self
.url
+ "/api/dashboards/id/{}/permissions".format(dahboard_id
),
133 headers
=self
.headers
,
136 log
.info("Dashboard %s is created in Grafana", name
)
139 log
.exception("Exception processing message: ")
141 def create_datasource(self
, datasource_name
, datasource_type
, datasource_url
):
144 "name": datasource_name
,
145 "type": datasource_type
,
146 "url": datasource_url
,
151 response
= requests
.request(
153 self
.url
+ "/api/datasources",
154 data
=json
.dumps(datasource_data
),
155 headers
=self
.headers
,
157 log
.info("Datasource %s is created in Grafana", datasource_name
)
158 log
.info("************* response: {}".format(response
.__dict
__))
161 log
.exception("Exception processing request for creating datasource: ")
163 def send_request_for_creating_dashboard(self
, dashboard_data
):
164 response
= requests
.request(
166 self
.url
+ "/api/dashboards/db/",
167 data
=json
.dumps(dashboard_data
),
168 headers
=self
.headers
,
172 def delete_dashboard(self
, uid
):
173 response
= requests
.request(
174 "DELETE", self
.url
+ "/api/dashboards/uid/" + uid
, headers
=self
.headers
176 log
.debug("Dashboard %s deleted from Grafana", uid
)
179 def delete_datasource(self
, datasource_name
):
180 response
= requests
.request(
181 "DELETE", self
.url
+ "/api/datasources/name/" + datasource_name
, headers
=self
.headers
183 log
.debug("Datasource %s deleted from Grafana", datasource_name
)
186 def delete_admin_dashboard(self
):
189 self
.url
+ "/api/dashboards/db/osm-project-status-admin",
190 headers
=self
.headers
,
192 log
.debug("Dashboard osm-project-status-admin deleted from Grafana")
194 def create_grafana_users(self
, user
):
195 email
= "{}@osm.etsi.org".format(user
)
202 response_users
= requests
.request(
204 self
.url
+ "/api/admin/users/",
206 headers
=self
.headers
,
208 json_data
= json
.loads(response_users
.text
)
209 url
= "/api/org/users/{}/".format(json_data
["id"])
210 permission_payload
= {
214 "PATCH", self
.url
+ url
, json
=permission_payload
, headers
=self
.headers
216 log
.info("New user %s created in Grafana", user
)
217 return response_users
220 def get_grafana_users(self
):
221 response_users
= requests
.request(
223 self
.url
+ "/api/users",
224 headers
=self
.headers
,
227 users
= json
.loads(response_users
.text
)
229 if user
["name"] and user
["name"] != "admin":
230 user_list
.append(user
["name"])
233 # Create Grafana team with member
234 def create_grafana_teams_members(
235 self
, project_name
, user_name
, is_admin
, proj_list
237 # Check if user exist in Grafana
238 user_response
= requests
.request(
240 self
.url
+ "/api/users/lookup?loginOrEmail={}".format(user_name
),
241 headers
=self
.headers
,
243 user_obj
= json
.loads(user_response
.text
)
244 if user_response
.status_code
!= 200:
245 user_response
= self
.create_grafana_users(user_name
)
246 user_obj
= json
.loads(user_response
.text
)
248 user_id
= user_obj
["id"]
251 team_objs
= requests
.request(
253 self
.url
+ "/api/users/{}/teams".format(user_id
),
254 headers
=self
.headers
,
256 team_obj
= json
.loads(team_objs
.text
)
259 for team
in team_obj
:
260 team_list
.append(team
["name"])
262 proj_unlink
= set(team_list
) - set(proj_list
)
263 for prj
in proj_unlink
:
264 response_team
= requests
.request(
266 self
.url
+ "/api/teams/search?name={}".format(prj
),
267 headers
=self
.headers
,
269 team_id
= json
.loads(response_team
.text
)["teams"][0]["id"]
272 self
.url
+ "/api/teams/{}/members/{}".format(team_id
, user_id
),
273 headers
=self
.headers
,
275 if project_name
!= "admin":
277 response_team
= requests
.request(
279 self
.url
+ "/api/teams/search?name={}".format(project_name
),
280 headers
=self
.headers
,
283 # Search if team in Grafana corresponding to the project already exists
284 if not json
.loads(response_team
.text
)["teams"]:
285 self
.create_grafana_teams(project_name
)
286 response_team
= requests
.request(
288 self
.url
+ "/api/teams/search?name={}".format(project_name
),
289 headers
=self
.headers
,
291 team_id
= json
.loads(response_team
.text
)["teams"][0]["id"]
292 if project_name
not in team_list
:
293 # Create a team in Grafana corresponding to the project as it doesn't exist
294 member_payload
= {"userId": user_id
}
297 self
.url
+ "/api/teams/{}/members".format(team_id
),
299 headers
=self
.headers
,
301 # Check if user role or project name is admin
302 if is_admin
or project_name
== "admin":
303 # Give admin righsts to user
304 url
= "/api/org/users/{}/".format(user_id
)
305 permission_payload
= {
309 "PATCH", self
.url
+ url
, json
=permission_payload
, headers
=self
.headers
311 log
.info("User %s is assigned Admin permission", user_name
)
313 # Give editor rights to user
314 url
= "/api/org/users/{}/".format(user_id
)
315 permission_payload
= {
319 "PATCH", self
.url
+ url
, json
=permission_payload
, headers
=self
.headers
321 log
.info("User %s is assigned Editor permission", user_name
)
323 # Create team in Grafana
324 def create_grafana_teams(self
, team_name
):
329 "POST", self
.url
+ "/api/teams", json
=team_payload
, headers
=self
.headers
331 log
.info("New team %s created in Grafana", team_name
)
333 # Create folder in Grafana
334 def create_grafana_folders(self
, folder_name
):
335 folder_payload
= {"uid": folder_name
, "title": folder_name
}
337 "POST", self
.url
+ "/api/folders", json
=folder_payload
, headers
=self
.headers
339 log
.info("Dashboard folder %s created", folder_name
)
341 response_team
= requests
.request(
343 self
.url
+ "/api/teams/search?name={}".format(folder_name
),
344 headers
=self
.headers
,
346 # Create team if it doesn't already exists
347 if len(json
.loads(response_team
.text
)["teams"]) == 0:
348 self
.create_grafana_teams(folder_name
)
349 response_team
= requests
.request(
351 self
.url
+ "/api/teams/search?name={}".format(folder_name
),
352 headers
=self
.headers
,
354 # Assign required permission to the team's folder
355 team_id
= json
.loads(response_team
.text
)["teams"][0]["id"]
358 {"teamId": team_id
, "permission": 2},
363 self
.url
+ "/api/folders/{}/permissions".format(folder_name
),
364 json
=permission_data
,
365 headers
=self
.headers
,
368 # delete user from grafana
369 def delete_grafana_users(self
, user_name
):
371 response_id
= requests
.request(
373 self
.url
+ "/api/users/lookup?loginOrEmail={}".format(user_name
),
374 headers
=self
.headers
,
377 user_id
= json
.loads(response_id
.text
)["id"]
379 log
.exception("Exception processing message: ")
381 response
= requests
.request(
383 self
.url
+ "/api/admin/users/{}".format(user_id
),
384 headers
=self
.headers
,
386 log
.info("User %s deleted in Grafana", user_name
)
389 # delete team from grafana
390 def delete_grafana_team(self
, project_name
):
391 # Delete Grafana folder
394 self
.url
+ "/api/folders/{}".format(project_name
),
395 headers
=self
.headers
,
397 # Delete Grafana team
398 team_obj
= requests
.request(
400 self
.url
+ "/api/teams/search?name={}".format(project_name
),
401 headers
=self
.headers
,
403 team_id
= json
.loads(team_obj
.text
)["teams"][0]["id"]
404 response
= requests
.request(
405 "DELETE", self
.url
+ "/api/teams/{}".format(team_id
), headers
=self
.headers
407 log
.info("Team %s deleted in Grafana", project_name
)
410 # update grafana team
411 def update_grafana_teams(self
, project_new_name
, project_old_name
):
412 team_obj
= requests
.request(
414 self
.url
+ "/api/teams/search?name={}".format(project_old_name
),
415 headers
=self
.headers
,
417 team_id
= json
.loads(team_obj
.text
)["teams"][0]["id"]
419 "name": project_new_name
,
421 response
= requests
.request(
423 self
.url
+ "/api/teams/{}".format(team_id
),
425 headers
=self
.headers
,
427 log
.info("Grafana team updated %s", response
.text
)
430 # remove member from grafana team
431 def remove_grafana_team_member(self
, user_name
, project_data
):
433 response_id
= requests
.request(
435 self
.url
+ "/api/users/lookup?loginOrEmail={}".format(user_name
),
436 headers
=self
.headers
,
438 user_id
= json
.loads(response_id
.text
)["id"]
439 for project
in project_data
:
441 team_obj
= requests
.request(
443 self
.url
+ "/api/teams/search?name={}".format(project
["project"]),
444 headers
=self
.headers
,
446 team_id
= json
.loads(team_obj
.text
)["teams"][0]["id"]
447 response
= requests
.request(
449 self
.url
+ "/api/teams/{}/members/{}".format(team_id
, user_id
),
450 headers
=self
.headers
,