grafana

v0.1.3

grafana v0.1.3 Grafana.Dashboard View Source

Link to this section Summary

Functions

delete(slug)

Delete an existing dashboard with the given slug. Slug is the url-friendly version of the dashboard title

get()
get(slug)

Get a dashboard with the given slug. Slug is the url-friendly version of the dashboard title

get_from_json(json)

Get dashboard from json file

home()

Get the home dashboard

new(json)

Create a new dashboard specified by json

params_to_json(id \\ "null", title \\ "new dashboard", tags \\ [], rows \\ [], overwrite \\ false, version \\ 0, editable \\ false, style \\ "light")

Format dashboard parameters into JSON

search(query, starred, tag, tagcloud)

Search dashboards with given parameters. “starred” is a boolean flag indicating whether only starred dashboards should be returned. “tagcloud” is a boolean indicating if a tagcloud should be returned

tags()

Get all the available tags for dashboards

update(json)

Update an existing dashboard as specified in json

Link to this section Functions

Link to this function delete(slug) View Source

Delete an existing dashboard with the given slug. Slug is the url-friendly version of the dashboard title.

iex> {:ok, response} = Grafana.Dashboard.delete(“test”) …> Map.keys(response) [“title”]

Link to this function get(slug) View Source

Get a dashboard with the given slug. Slug is the url-friendly version of the dashboard title.

iex> {:ok, dash} = Grafana.Dashboard.get “worldping-endpoint-dns” …> Map.keys(dash) [“dashboard”, “meta”]

Link to this function get_from_json(json) View Source

Get dashboard from json file.

Link to this function home() View Source

Get the home dashboard

iex> {:ok, dash} = Grafana.Dashboard.home …> Map.keys(dash) [“dashboard”, “meta”]

iex> {:ok, dash} = Grafana.Dashboard.get …> Map.keys(dash) [“dashboard”, “meta”]

Link to this function new(json) View Source

Create a new dashboard specified by json.

Link to this function params_to_json(id \\ "null", title \\ "new dashboard", tags \\ [], rows \\ [], overwrite \\ false, version \\ 0, editable \\ false, style \\ "light") View Source

Format dashboard parameters into JSON.

Model: { “dashboard”: {

"id": null,
"title": "Production Overview",
"tags": [ "templated" ],
"timezone": "browser",
"rows": [
  {
  }
],
"schemaVersion": 6,
"version": 0

}, “overwrite”: false }

Link to this function search(query, starred, tag, tagcloud) View Source

Search dashboards with given parameters. “starred” is a boolean flag indicating whether only starred dashboards should be returned. “tagcloud” is a boolean indicating if a tagcloud should be returned.

iex> {:ok, search} = Grafana.Dashboard.search(“”, false, “Endpoints”, false) …> Map.keys(hd(search)) [“id”, “isStarred”, “tags”, “title”, “type”, “uri”]

Link to this function tags() View Source

Get all the available tags for dashboards.

iex> {:ok, tags} = Grafana.Dashboard.tags …> Map.keys(hd(tags)) [“count”, “term”]

Link to this function update(json) View Source

Update an existing dashboard as specified in json.

iex> {:ok, dash} = Grafana.Dashboard.update(%{}) …> Map.keys(dash) [“slug”, “status”, “version”]