com.appnexus.grafana.client

Class GrafanaClient

java.lang.Object

com.appnexus.grafana.client.GrafanaClient

public class GrafanaClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
GrafanaClient(GrafanaConfiguration configuration)
GrafanaClient(GrafanaConfiguration configuration, okhttp3.OkHttpClient client) Allows for the user to provide an OkHttpClient that can be used to connect to the Grafana service.

Method Summary

Modifier and Type	Method and Description
DashboardMeta	createDashboard(GrafanaDashboard grafanaDashboard) Creates a Grafana dashboard.
AlertNotification	createNotification(AlertNotification alertNotification) Creates a Grafana alert notification.
java.lang.String	deleteDashboard(java.lang.String dashboardName) Deletes Grafana dashboard by name.
java.lang.String	deleteNotification(java.lang.Integer id) Deletes Grafana notification by id.
DashboardPanelAlert	getAlert(java.lang.Integer id) Searches for a Grafana alert with a given id.
GrafanaDashboard	getDashboard(java.lang.String dashboardName) Searches for an existing dashboard by name.
java.lang.String	getHost()
AlertNotification	getNotification(java.lang.Integer id) Searches for a Grafana notification with a given id.
java.util.List<AlertNotification>	getNotifications() Returns a list of all Grafana notifications.
java.util.List<GrafanaSearchResult>	search(java.lang.String query, java.lang.String tag, java.lang.Boolean starred, java.lang.Boolean tagcloud)
DashboardMeta	updateDashboard(GrafanaDashboard dashboard) Updates a Grafana dashboard.
AlertNotification	updateNotification(java.lang.Integer id, AlertNotification alertNotification) Updates a Grafana alert notification by id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GrafanaClient

public GrafanaClient(GrafanaConfiguration configuration)

Parameters:

configuration - the information needed to communicate with Grafana.

GrafanaClient

public GrafanaClient(GrafanaConfiguration configuration,
                     okhttp3.OkHttpClient client)

Allows for the user to provide an OkHttpClient that can be used to connect to the Grafana service. The client provided can be configured with an Interceptor or other specifics that are then used during communications with Grafana

Parameters:

configuration - the information needed to communicate with Grafana.

client - An OkHttpClient that is used to connect to Grafana

Method Detail

getHost

public java.lang.String getHost()

getDashboard

public GrafanaDashboard getDashboard(java.lang.String dashboardName)
                              throws GrafanaDashboardDoesNotExistException,
                                     GrafanaException,
                                     java.io.IOException

Searches for an existing dashboard by name.

Parameters:

dashboardName - the name of the dashboard to search for.

Returns:

GrafanaDashboard with matching name.

Throws:

GrafanaDashboardDoesNotExistException - if a dashboard with matching name does not exist.

GrafanaException - if Grafana returns an error when trying to retrieve the dashboard.

java.io.IOException - if a problem occurred talking to the server.

createDashboard

public DashboardMeta createDashboard(GrafanaDashboard grafanaDashboard)
                              throws GrafanaException,
                                     java.io.IOException

Creates a Grafana dashboard. If a dashboard already exists with the same name it will be updated.

Parameters:

grafanaDashboard - the dashboard to be created.

Returns:

Meta information about the newly created dashboard

Throws:

GrafanaException - if Grafana returns an error when trying to create the dashboard.

java.io.IOException - if a problem occurred talking to the server.

updateDashboard

public DashboardMeta updateDashboard(GrafanaDashboard dashboard)
                              throws GrafanaException,
                                     java.io.IOException

Updates a Grafana dashboard. If the dashboard did not previously exist it will be created.

Parameters:

dashboard - the dashboard to be updated.

Returns:

Meta information about the updated dashboard

Throws:

GrafanaException - if Grafana returns an error when trying to create the dashboard.

java.io.IOException - if a problem occurred talking to the server.

deleteDashboard

public java.lang.String deleteDashboard(java.lang.String dashboardName)
                                 throws GrafanaDashboardDoesNotExistException,
                                        GrafanaDashboardCouldNotDeleteException,
                                        java.io.IOException

Deletes Grafana dashboard by name.

Parameters:

dashboardName - the name of the dashboard to delete.

Returns:

The name of the deleted dashboard.

Throws:

GrafanaDashboardDoesNotExistException - if the dashboard does not exist

GrafanaDashboardCouldNotDeleteException - if Grafana returns an error when trying to delete the dashboard.

java.io.IOException - if a problem occurred talking to the server.

getNotification

public AlertNotification getNotification(java.lang.Integer id)
                                  throws GrafanaException,
                                         java.io.IOException

Searches for a Grafana notification with a given id.

Parameters:

id - the id of the notification to search for.

Returns:

the notification with the given id.

Throws:

GrafanaException - if a notification with the given id does not exist.

java.io.IOException - if a problem occurred talking to the server.

getNotifications

public java.util.List<AlertNotification> getNotifications()
                                                   throws GrafanaException,
                                                          java.io.IOException

Returns a list of all Grafana notifications.

Returns:

a list of notifications.

Throws:

GrafanaException - if Grafana returns an unexpected error.

java.io.IOException - if a problem occurred talking to the server.

createNotification

public AlertNotification createNotification(AlertNotification alertNotification)
                                     throws GrafanaException,
                                            java.io.IOException

Creates a Grafana alert notification.

Parameters:

alertNotification - the notification to be created.

Returns:

the newly created notification

Throws:

GrafanaException - if Grafana returns an error when trying to create the notification.

java.io.IOException - if a problem occurred talking to the server.

updateNotification

public AlertNotification updateNotification(java.lang.Integer id,
                                            AlertNotification alertNotification)
                                     throws GrafanaException,
                                            java.io.IOException

Updates a Grafana alert notification by id.

Parameters:

id - the id of the notification to be updated.

alertNotification - the notification values to be updated.

Returns:

the newly updated notification

Throws:

GrafanaException - if a notification does not exist for the given id.

java.io.IOException - if a problem occurred talking to the server.

deleteNotification

public java.lang.String deleteNotification(java.lang.Integer id)
                                    throws GrafanaException,
                                           java.io.IOException

Deletes Grafana notification by id.

Parameters:

id - the id of the notification to delete.

Returns:

confirmation of the deleted notification.

Throws:

GrafanaException - if Grafana returns an error when trying to delete the notification.

java.io.IOException - if a problem occurred talking to the server.

getAlert

public DashboardPanelAlert getAlert(java.lang.Integer id)
                             throws GrafanaException,
                                    java.io.IOException

Searches for a Grafana alert with a given id.

Parameters:

id - the id of the alert to search for.

Returns:

the alert with the given id.

Throws:

GrafanaException - if Grafana returns an error when trying to find the alert.

java.io.IOException - if a problem occurred talking to the server.

search

public java.util.List<GrafanaSearchResult> search(java.lang.String query,
                                                  java.lang.String tag,
                                                  java.lang.Boolean starred,
                                                  java.lang.Boolean tagcloud)
                                           throws GrafanaException,
                                                  java.io.IOException

Throws:

GrafanaException

java.io.IOException