+++ # ----------------------------------------------------------------------- # Do not edit this file. It is automatically generated by API Documenter. # ----------------------------------------------------------------------- title = "EchoSrv" keywords = ["grafana","documentation","sdk","@grafana/runtime"] type = "docs" +++ ## EchoSrv interface Used to send events to all the registered backends. This should be accessed via the [getEchoSrv()](./runtime/getechosrv.md) 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 | Method | Description | | --- | --- | | [addBackend(backend)](#addbackend-method) | Add a new echo backend to the list of backends that will receive events. | | [addEvent(event, meta)](#addevent-method) | Call this to add event that will be sent to the echo backends upon next flush. | | [flush()](#flush-method) | 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 | Parameter | Type | Description | | --- | --- | --- | | backend | EchoBackend | | Returns: `void` ### addEvent method Call this to add event that will be sent to the echo backends upon next flush. Signature ```typescript addEvent(event: Omit, meta?: {}): void; ``` Parameters | Parameter | Type | Description | | --- | --- | --- | | event | Omit<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`