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

DataSourceWithLogsContextSupport interface

Data sources that allow showing context rows around the provided LowRowModel should implement this method. This will enable “context” button in Logs Panel.

Signature

typescript
export interface DataSourceWithLogsContextSupport<TQuery extends DataQuery = DataQuery> 

Import

typescript
import { DataSourceWithLogsContextSupport } from '@grafana/data';

Properties

PropertyTypeDescription
getLogRowContext<TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions, query?: TQuery) => Promise<DataQueryResponse>Retrieve context for a given log row

Methods

MethodDescription
showContextToggle(row)This method can be used to show “context” button based on runtime conditions (for example row model data or plugin settings, etc.)

getLogRowContext property

Retrieve context for a given log row

Signature

typescript
getLogRowContext: <TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions, query?: TQuery) => Promise<DataQueryResponse>;

showContextToggle method

This method can be used to show “context” button based on runtime conditions (for example row model data or plugin settings, etc.)

Signature

typescript
showContextToggle(row?: LogRowModel): boolean;

Parameters

ParameterTypeDescription
rowLogRowModel

Returns:

boolean