BackendSrv interface
Used to communicate via http(s) to a remote backend such as the Grafana backend, a datasource etc. The BackendSrv is using the Fetch API under the hood to handle all the communication.
The request function can be used to perform a remote call by specifying a BackendSrvRequest. To make the BackendSrv a bit easier to use we have added a couple of shorthand functions that will use default values executing the request.
Signature
export interface BackendSrv
Import
import { BackendSrv } from '@grafana/runtime';
Remarks
By default, Grafana displays an error message alert if the remote call fails. To prevent this from happening showErrorAlert = true on the options object.
Methods
| Method | Description |
|---|---|
| datasourceRequest(options) | |
| delete(url) | |
| fetch(options) | Observable http request interface |
| get(url, params, requestId) | |
| patch(url, data) | |
| post(url, data) | |
| put(url, data) | |
| request(options) |
datasourceRequest method
Signature
datasourceRequest(options: BackendSrvRequest): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | BackendSrvRequest |
Returns:
Promise<any>
delete method
Signature
delete(url: string): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
Returns:
Promise<any>
fetch method
Observable http request interface
Signature
fetch<T>(options: BackendSrvRequest): Observable<FetchResponse<T>>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | BackendSrvRequest |
Returns:
Observable<FetchResponse<T>>
get method
Signature
get(url: string, params?: any, requestId?: string): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
|
| params | any |
|
| requestId | string |
Returns:
Promise<any>
patch method
Signature
patch(url: string, data?: any): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
|
| data | any |
Returns:
Promise<any>
post method
Signature
post(url: string, data?: any): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
|
| data | any |
Returns:
Promise<any>
put method
Signature
put(url: string, data?: any): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| url | string |
|
| data | any |
Returns:
Promise<any>
request method
Signature
request(options: BackendSrvRequest): Promise<any>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | BackendSrvRequest |
Returns:
Promise<any>
Related Grafana video resources
Getting started with Grafana
Take a guided tour of Grafana and learn how to monitor a web service using Prometheus and Loki in this beginner-friendly webinar.
All about Grafana plugins: Visualizing disparate data sources in one place
Grafana Enterprise plugins are integrations with other commercial monitoring tools (such as Datadog, Splunk, New Relic, ServiceNow, Oracle, and Dynatrace) that are created, maintained, and supported by the Grafana Labs team.
Demo: Getting started with Grafana Enterprise and observability
Join the Grafana Labs team for a 30-minute demo of how to get started with the Grafana Stack, so you can go from zero to observability in just a few minutes.
