API Reference@grafana/runtimeGetDataSourceListFilters

GetDataSourceListFilters interface

Signature

export interface GetDataSourceListFilters 

Import

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
logsbooleanOnly return data sources that support logging response
metricsbooleanOnly return data sources that support metrics response
mixedbooleanInclude mixed data 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

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;

logs property

Only return data sources that support logging response

Signature

logs?: boolean;

metrics property

Only return data sources that support metrics response

Signature

metrics?: boolean;

mixed property

Include mixed data 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;