Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Enterprise Open source

GetDataSourceListFilters interface

Signature

typescript
export interface GetDataSourceListFilters 

Import

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

Properties

PropertyTypeDescription
alertingbooleanOnly filter data sources that support alerting
allbooleanBy 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
annotationsbooleanOnly return data sources that support annotations
dashboardbooleanSet to true to return dashboard data source
filter(dataSource: DataSourceInstanceSettings) => booleanapply a function to filter
metricsbooleanOnly return data sources that support metrics response
mixedbooleanInclude mixed deta source by setting this to true
pluginIdstringfilter list by plugin
tracingbooleanOnly return data sources that support tracing response
typestring | string[]Only returns datasources matching the specified types (ie. Loki, Prometheus)
variablesbooleanSet to true to return data source variables

alerting property

Only filter data sources that support alerting

Signature

typescript
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

typescript
all?: boolean;

annotations property

Only return data sources that support annotations

Signature

typescript
annotations?: boolean;

dashboard property

Set to true to return dashboard data source

Signature

typescript
dashboard?: boolean;

filter property

apply a function to filter

Signature

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

metrics property

Only return data sources that support metrics response

Signature

typescript
metrics?: boolean;

mixed property

Include mixed deta source by setting this to true

Signature

typescript
mixed?: boolean;

pluginId property

filter list by plugin

Signature

typescript
pluginId?: string;

tracing property

Only return data sources that support tracing response

Signature

typescript
tracing?: boolean;

type property

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

Signature

typescript
type?: string | string[];

variables property

Set to true to return data source variables

Signature

typescript
variables?: boolean;