osm_mon/dashboarder/backends/grafana.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright 2018 Whitestack, LLC
   4 # *************************************************************
   5
   6 # This file is part of OSM Monitoring module
   7 # All Rights Reserved to Whitestack, LLC
   8
   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
  12
  13 #         http://www.apache.org/licenses/LICENSE-2.0
  14
  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
  19 # under the License.
  20 # For those usages not covered by the Apache License, Version 2.0 please
  21 # contact: glavado@whitestack.com or fbravo@whitestack.com
  22 ##
  23 import logging
  24 import requests
  25 import base64
  26 import json
  27 from osm_mon.core.config import Config
  28
  29 log = logging.getLogger(__name__)
  30
  31
  32 class GrafanaBackend:
  33     def __init__(self, config: Config):
  34         self.conf = config
  35         self.url = config.get('grafana', 'url')
  36         grafana_user = config.get("grafana", "user")
  37         grafana_password = config.get("grafana", "password")
  38         self.headers = {
  39             'content-type': "application/json",
  40             'authorization': "Basic %s" % base64.b64encode(
  41                 (grafana_user + ":" + grafana_password).encode("utf-8")).decode()
  42         }
  43
  44     def get_all_dashboard_uids(self):
  45         # Gets only dashboards that were automated by OSM (with tag 'osm_automated')
  46         response = requests.request("GET", self.url + "/api/search?tag=osm_automated", headers=self.headers)
  47         dashboards = response.json()
  48         dashboard_uids = []
  49         for dashboard in dashboards:
  50             dashboard_uids.append(dashboard['uid'])
  51         log.debug("Searching for all dashboard uids: %s", dashboard_uids)
  52         return dashboard_uids
  53
  54     def get_dashboard_status(self, uid):
  55         response = requests.request("GET", self.url + "/api/dashboards/uid/" + uid, headers=self.headers)
  56         log.debug("Searching for dashboard result: %s", response.text)
  57         return response
  58
  59     def create_dashboard(self, uid, name, json_file, project_name=None):
  60         try:
  61             with open(json_file) as f:
  62                 dashboard_data = f.read()
  63
  64             dashboard_data = dashboard_data.replace('OSM_ID', uid).replace('OSM_NAME', name)
  65             dashboard_json_data = json.loads(dashboard_data)
  66             # Get folder id
  67             if project_name:
  68                 folder_name = project_name
  69             else:
  70                 folder_name = name
  71             response_folder_id = requests.request(
  72                 "GET", self.url + "/api/folders/{}".format(folder_name), headers=self.headers)
  73             if response_folder_id.status_code == 200:
  74                 folder_id = json.loads(response_folder_id.text)["id"]
  75                 dashboard_json_data["folderId"] = folder_id
  76                 dashboard_json_data["overwrite"] = False
  77
  78             response = requests.request(
  79                 "POST", self.url + "/api/dashboards/db/", data=json.dumps(dashboard_json_data), headers=self.headers)
  80
  81             # Get team id
  82             if project_name is not None:
  83                 name = project_name
  84             response_team = requests.request(
  85                 "GET", self.url + "/api/teams/search?name={}".format(name), headers=self.headers)
  86
  87             # Check if team informaiton is available
  88             if len(json.loads(response_team.text)["teams"]) > 0:
  89                 # As team information is available so it is a non-admin user
  90                 team_id = json.loads(response_team.text)["teams"][0]["id"]
  91                 permission_data = {"items": [{"teamId": team_id, "permission": 2}, ]}
  92                 # Give required permission to the team's folder
  93                 response = requests.request(
  94                     "POST", self.url + "/api/folders/{}/permissions".format(project_name), json=permission_data,
  95                     headers=self.headers)
  96             else:
  97                 # As team information is not available so it is admin user
  98                 dahboard_id = json.loads(response.text)["id"]
  99                 # Remove dashboard's default permissions so that it is only visible to admin user
 100                 requests.request(
 101                     "POST", self.url + "/api/dashboards/id/{}/permissions".format(dahboard_id),
 102                     headers=self.headers)
 103
 104             log.info("Dashboard %s is created in Grafana", name)
 105             return response
 106         except Exception:
 107             log.exception("Exception processing message: ")
 108
 109     def delete_dashboard(self, uid):
 110         response = requests.request("DELETE", self.url + "/api/dashboards/uid/" + uid, headers=self.headers)
 111         log.debug("Dashboard %s deleted from Grafana", uid)
 112         return response
 113
 114     def create_grafana_users(self, user):
 115         email = "{}@osm.etsi.org".format(user)
 116         user_payload = {
 117             "name": user,
 118             "email": email,
 119             "login": user,
 120             "password": user,
 121         }
 122         response_users = requests.request("POST", self.url + "/api/admin/users/", json=user_payload,
 123                                           headers=self.headers)
 124         json_data = json.loads(response_users.text)
 125         url = "/api/org/users/{}/".format(json_data["id"])
 126         permission_payload = {"role": "Editor", }
 127         requests.request("PATCH", self.url + url, json=permission_payload, headers=self.headers)
 128         log.info("New user %s created in Grafana", user)
 129         return response_users
 130
 131     # Create Grafana team with member
 132     def create_grafana_teams_members(self, project_name, user_name, is_admin, proj_list):
 133         # Check if user exist in Grafana
 134         user_response = requests.request("GET", self.url + "/api/users/lookup?loginOrEmail={}".format(user_name),
 135                                          headers=self.headers)
 136         user_obj = json.loads(user_response.text)
 137         if user_response.status_code != 200:
 138             user_response = self.create_grafana_users(user_name)
 139             user_obj = json.loads(user_response.text)
 140
 141         user_id = user_obj["id"]
 142
 143         # Get teams for user
 144         team_objs = requests.request("GET", self.url + "/api/users/{}/teams".format(user_id), headers=self.headers)
 145         team_obj = json.loads(team_objs.text)
 146         team_list = []
 147         if len(team_obj):
 148             for team in team_obj:
 149                 team_list.append(team["name"])
 150
 151         proj_unlink = set(team_list) - set(proj_list)
 152         for prj in proj_unlink:
 153             response_team = requests.request("GET", self.url + "/api/teams/search?name={}".format(prj),
 154                                              headers=self.headers)
 155             team_id = json.loads(response_team.text)["teams"][0]["id"]
 156             requests.request("DELETE", self.url + "/api/teams/{}/members/{}".format(team_id, user_id),
 157                              headers=self.headers)
 158         if project_name != "admin":
 159             # Add member to team
 160             response_team = requests.request("GET", self.url + "/api/teams/search?name={}".format(project_name),
 161                                              headers=self.headers)
 162
 163             # Search if team in Grafana corresponding to the project already exists
 164             if not json.loads(response_team.text)["teams"]:
 165                 self.create_grafana_teams(project_name)
 166                 response_team = requests.request("GET", self.url + "/api/teams/search?name={}".format(project_name),
 167                                                  headers=self.headers)
 168             team_id = json.loads(response_team.text)["teams"][0]["id"]
 169             if project_name not in team_list:
 170                 # Create a team in Grafana corresponding to the project as it doesn't exist
 171                 member_payload = {
 172                     "userId": user_id
 173                 }
 174                 requests.request("POST", self.url + "/api/teams/{}/members".format(team_id), json=member_payload,
 175                                  headers=self.headers)
 176         # Check if user role or project name is admin
 177         if is_admin or project_name == 'admin':
 178             # Give admin righsts to user
 179             url = "/api/org/users/{}/".format(user_id)
 180             permission_payload = {"role": "Admin", }
 181             requests.request("PATCH", self.url + url, json=permission_payload, headers=self.headers)
 182             log.info("User %s is assigned Admin permission", user_name)
 183         else:
 184             # Give editor rights to user
 185             url = "/api/org/users/{}/".format(user_id)
 186             permission_payload = {"role": "Editor", }
 187             requests.request("PATCH", self.url + url, json=permission_payload, headers=self.headers)
 188             log.info("User %s is assigned Editor permission", user_name)
 189
 190     # Create team in Grafana
 191     def create_grafana_teams(self, team_name):
 192         team_payload = {"name": team_name, }
 193         requests.request("POST", self.url + "/api/teams", json=team_payload, headers=self.headers)
 194         log.info("New team %s created in Grafana", team_name)
 195
 196     # Create folder in Grafana
 197     def create_grafana_folders(self, folder_name):
 198         folder_payload = {"uid": folder_name, "title": folder_name}
 199         requests.request("POST", self.url + "/api/folders", json=folder_payload, headers=self.headers)
 200         log.info("Dashboard folder %s created", folder_name)
 201
 202     def delete_grafana_users(self, user_name):
 203         # Get user id
 204         response_id = requests.request("GET", self.url + "/api/users/lookup?loginOrEmail={}".format(user_name),
 205                                        headers=self.headers)
 206         try:
 207             user_id = json.loads(response_id.text)["id"]
 208         except Exception:
 209             log.exception("Exception processing message: ")
 210         # Delete user
 211         response = requests.request("DELETE", self.url + "/api/admin/users/{}".format(user_id), headers=self.headers)
 212         log.info("User %s deleted in Grafana", user_name)
 213         return response
 214
 215     def delete_grafana_team(self, project_name):
 216         # Delete Grafana folder
 217         requests.request("DELETE", self.url + "/api/folders/{}".format(project_name),
 218                          headers=self.headers)
 219         # Delete Grafana team
 220         team_obj = requests.request("GET", self.url + "/api/teams/search?name={}".format(project_name),
 221                                     headers=self.headers)
 222         team_id = json.loads(team_obj.text)["teams"][0]["id"]
 223         response = requests.request("DELETE", self.url + "/api/teams/{}".format(team_id), headers=self.headers)
 224         log.info("Team %s deleted in Grafana", project_name)
 225         return response
 226
 227     def update_grafana_teams(self, project_new_name, project_old_name):
 228         team_obj = requests.request("GET", self.url + "/api/teams/search?name={}".format(project_old_name),
 229                                     headers=self.headers)
 230         team_id = json.loads(team_obj.text)["teams"][0]["id"]
 231         data = {"name": project_new_name, }
 232         response = requests.request("PUT", self.url + "/api/teams/{}".format(team_id), json=data, headers=self.headers)
 233         log.info("Grafana team updated %s", response.text)
 234         return response