Server-side implementation of the Elastic V3 shipper for the @elastic/ebt/client.
This module is intended to be used on the server-side only. It is specially designed to apply the necessary backpressure mechanisms to prevent the server from getting overloaded with too many events and identify if the server sits behind a firewall to discard any incoming events. Refer to @elastic/ebt/shippers/elastic_v3/browser for the browser-side implementation.
import { ElasticV3ServerShipper } from "@elastic/ebt/shippers/elastic_v3/server";
analytics.registerShipper(ElasticV3ServerShipper, { channelName: 'myChannel', version: '1.0.0' });| Name | Description |
|---|---|
channelName |
The name of the channel to send the events. |
version |
The version of the application generating the events. |
debug |
When true, it logs the responses from the remote Telemetry Service. Defaults to false. |
This shipper sends the events to the Elastic Internal Telemetry Service. It holds up to 1000 events in a shared queue. Any additional incoming events once it's full will be dropped. It sends the events from the queue in batches of up to 10kB every 10 seconds. When shutting down, it'll send all the remaining events in the queue.