Skip to content

Dashboard

GrafanaDashboard 

GrafanaDashboard()

Initialize the uploader with Grafana server details and credentials.

Source code in src/zenbt/grafana/dashboard.py 
13
14
15
16
17
18
def __init__(self):
    """
    Initialize the uploader with Grafana server details and credentials.
    """
    self.auth = HTTPBasicAuth(self.username, self.password)
    self.headers = {"Content-Type": "application/json"}

delete_dashboard 

delete_dashboard(dashboard_uid: str) -> bool

Delete a dashboard by its UID.

:param dashboard_uid: UID of the dashboard to delete :return: True if deletion was successful, False otherwise

Source code in src/zenbt/grafana/dashboard.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def delete_dashboard(self, dashboard_uid: str) -> bool:
    """
    Delete a dashboard by its UID.

    :param dashboard_uid: UID of the dashboard to delete
    :return: True if deletion was successful, False otherwise
    """
    response = requests.delete(
        f"{self.grafana_url}/api/dashboards/uid/{dashboard_uid}",
        headers=self.headers,
        auth=self.auth,
    )

    if response.status_code == 200:
        print(f"Dashboard with UID '{dashboard_uid}' deleted successfully.")
        return True
    else:
        print(
            f"Failed to delete dashboard. Status code: {response.status_code}, Response: {response.text}"
        )
        return False

get_dashboard_uid_by_name 

get_dashboard_uid_by_name(
    dashboard_name: str,
) -> Optional[str]

Retrieve the UID of a dashboard by its name.

:param dashboard_name: Name of the dashboard :return: UID of the dashboard if found, None otherwise

Source code in src/zenbt/grafana/dashboard.py 
 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
def get_dashboard_uid_by_name(self, dashboard_name: str) -> Optional[str]:
    """
    Retrieve the UID of a dashboard by its name.

    :param dashboard_name: Name of the dashboard
    :return: UID of the dashboard if found, None otherwise
    """
    search_response = requests.get(
        f"{self.grafana_url}/api/search",
        headers=self.headers,
        auth=self.auth,
        params={"query": dashboard_name},
    )

    if search_response.status_code == 200:
        for item in search_response.json():
            if (
                item.get("title") == dashboard_name
                and item.get("type") == "dash-db"
            ):
                return item.get("uid")
        print(f"Dashboard with name '{dashboard_name}' not found.")
    else:
        print(
            f"Failed to search dashboards. Status code: {search_response.status_code}, Response: {search_response.text}"
        )
    return None

upload_dashboard 

upload_dashboard(
    json_file_path: str,
    dashboard_name: str,
    folder_uid: Optional[str] = None,
) -> bool

Upload a dashboard to Grafana.

:param json_file_path: Path to the JSON file containing the dashboard definition :param dashboard_name: Desired name for the dashboard in Grafana :param folder_uid: UID of the folder to save the dashboard in (optional) :return: True if upload was successful, False otherwise

Source code in src/zenbt/grafana/dashboard.py 
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
def upload_dashboard(
    self, json_file_path: str, dashboard_name: str, folder_uid: Optional[str] = None
) -> bool:
    """
    Upload a dashboard to Grafana.

    :param json_file_path: Path to the JSON file containing the dashboard definition
    :param dashboard_name: Desired name for the dashboard in Grafana
    :param folder_uid: UID of the folder to save the dashboard in (optional)
    :return: True if upload was successful, False otherwise
    """
    try:
        with open(json_file_path, "r") as file:
            dashboard_json = json.load(file)
    except Exception as e:
        print(f"Error reading JSON file: {e}")
        return False

    # Update the dashboard title
    dashboard_json["title"] = dashboard_name

    # Prepare the payload
    payload = {"dashboard": dashboard_json, "overwrite": True}

    if folder_uid:
        payload["folderUid"] = folder_uid

    # Send the request to Grafana
    response = requests.post(
        f"{self.grafana_url}/api/dashboards/db",
        headers=self.headers,
        auth=self.auth,
        data=json.dumps(payload),
    )

    if response.status_code == 200:
        print(f"Dashboard '{dashboard_name}' uploaded successfully.")
        return True
    else:
        print(
            f"Failed to upload dashboard. Status code: {response.status_code}, Response: {response.text}"
        )
        return False