This is documentation for the next version of Grafana. For the latest stable release, go to the latest version.

API Reference@grafana/runtimeGetDataSourceListFilters

GetDataSourceListFilters interface

Signature

export interface GetDataSourceListFilters 

Import

import { GetDataSourceListFilters } from '@grafana/runtime';

Properties

Property Type Description
alerting boolean Only filter data sources that support alerting
all boolean By default only data sources that can be queried will be returned. Meaning they have tracing, metrics, logs or annotations flag set in plugin.json file
annotations boolean Only return data sources that support annotations
dashboard boolean Set to true to return dashboard data source
filter (dataSource: DataSourceInstanceSettings) => boolean apply a function to filter
metrics boolean Only return data sources that support metrics response
mixed boolean Include mixed deta source by setting this to true
pluginId string filter list by plugin
tracing boolean Only return data sources that support tracing response
type string | string[] Only returns datasources matching the specified types (ie. Loki, Prometheus)
variables boolean Set to true to return data source variables

alerting property

Only filter data sources that support alerting

Signature

alerting?: boolean;

all property

By default only data sources that can be queried will be returned. Meaning they have tracing, metrics, logs or annotations flag set in plugin.json file

Signature

all?: boolean;

annotations property

Only return data sources that support annotations

Signature

annotations?: boolean;

dashboard property

Set to true to return dashboard data source

Signature

dashboard?: boolean;

filter property

apply a function to filter

Signature

filter?: (dataSource: DataSourceInstanceSettings) => boolean;

metrics property

Only return data sources that support metrics response

Signature

metrics?: boolean;

mixed property

Include mixed deta source by setting this to true

Signature

mixed?: boolean;

pluginId property

filter list by plugin

Signature

pluginId?: string;

tracing property

Only return data sources that support tracing response

Signature

tracing?: boolean;

type property

Only returns datasources matching the specified types (ie. Loki, Prometheus)

Signature

type?: string | string[];

variables property

Set to true to return data source variables

Signature

variables?: boolean;