PromEx.GrafanaClient (PromEx v1.0.0) View Source

This module is used by the Mix tasks that are available in PromEx to update dashboards in Grafana and also by the PromEx.DashboardUpdater to update dashboards automatically on application initialization.

Dashboard models: https://grafana.com/docs/grafana/latest/dashboards/json-model/

Link to this section Summary

Functions

create_annotation(grafana_conn, tags, message)

Used to create annotations on dashboard panels

create_folder(grafana_conn, folder_uid, title)

Used to create a new folder in Grafana

get_dashboard(grafana_conn, dashboard_contents)

Used to get the dashboard definition currently in Grafana for the provided dashboard file. If the ID does not exist in Grafana an error tuple will be returned.

get_folder(grafana_conn, folder_id)

Used to fetch the details regarding a particular folder on Grafana

update_folder(grafana_conn, folder_uid, new_title)

Update an existing folder in Grafana

upload_dashboard(grafana_conn, dashboard_contents, opts \\ [])

Used to create a new dashboard or update an existing dashboard.

Link to this section Functions

create_annotation(grafana_conn, tags, message)

Specs

create_annotation(
  grafana_conn :: PromEx.GrafanaClient.Connection.t(),
  tags :: [String.t()],
  message :: String.t()
) :: handler_respose()

Used to create annotations on dashboard panels

create_folder(grafana_conn, folder_uid, title)

Specs

create_folder(
  grafana_conn :: PromEx.GrafanaClient.Connection.t(),
  folder_uid :: String.t(),
  title :: String.t()
) :: handler_respose()

Used to create a new folder in Grafana

get_dashboard(grafana_conn, dashboard_contents)

Specs

get_dashboard(
  grafana_conn :: PromEx.GrafanaClient.Connection.t(),
  dashboard_file_path :: String.t()
) :: handler_respose()

Used to get the dashboard definition currently in Grafana for the provided dashboard file. If the ID does not exist in Grafana an error tuple will be returned.

get_folder(grafana_conn, folder_id)

Specs

get_folder(
  grafana_conn :: PromEx.GrafanaClient.Connection.t(),
  folder_uid :: String.t()
) :: handler_respose()

Used to fetch the details regarding a particular folder on Grafana

update_folder(grafana_conn, folder_uid, new_title)

Specs

update_folder(
  grafana_conn :: PromEx.GrafanaClient.Connection.t(),
  folder_uid :: String.t(),
  new_title :: String.t()
) :: handler_respose()

Update an existing folder in Grafana

upload_dashboard(grafana_conn, dashboard_contents, opts \\ [])

Specs

upload_dashboard(
  grafana_conn :: PromEx.GrafanaClient.Connection.t(),
  dashboard_file_path :: String.t(),
  opts :: keyword()
) :: handler_respose()

Used to create a new dashboard or update an existing dashboard.