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.

Documentation Grafana documentation API Reference @grafana/runtime EchoSrv
Enterprise Open source

EchoSrv interface

Used to send events to all the registered backends. This should be accessed via the getEchoSrv() function. Will, by default, flush events to the backends every 10s or when the flush function is triggered.

Signature

typescript 
export interface EchoSrv

Import

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

Methods

MethodDescription
addBackend(backend)Add a new echo backend to the list of backends that will receive events.
addEvent(event, meta)Call this to add event that will be sent to the echo backends upon next flush.
flush()Call this to flush current events to the echo backends.

addBackend method

Add a new echo backend to the list of backends that will receive events.

Signature

typescript 
addBackend(backend: EchoBackend): void;

Parameters

ParameterTypeDescription
backendEchoBackend

Returns:

void

addEvent method

Call this to add event that will be sent to the echo backends upon next flush.

Signature

typescript 
addEvent<T extends EchoEvent>(event: Omit<T, 'meta'>, meta?: {}): void;

Parameters

ParameterTypeDescription
eventOmit<T, ‘meta’>Object containing event information.
meta{}Object that will extend/override the default meta object.

Returns:

void

flush method

Call this to flush current events to the echo backends.

Signature

typescript 
flush(): void;

Returns:

void