ElectricTelemetry

Library used by Electric to gather telemetry and export it to a number of supported destinations. Originally extracted from electric-sql/electric.

Installation

Install it by adding electric_telemetry to your list of dependencies in mix.exs:

def deps do
  [
    {:electric_telemetry, github: "electric-sql/electric", sparse: "packages/electric-telemetry"}
  ]
end

Configuration

Runtime configuration is available for the underlying otel_metric_exporter lib:

config :otel_metric_exporter,
  otlp_endpoint: "...",
  otlp_headers: %{...}
  resource: %{...}

The configuration options for ElectricTelemetry.ApplicationTelemetry or ElectricTelemetry.StackTelemetry must be passed as a keyword list function argument. See ElectricTelemetry.Opts for the supported options.

Overview

At a high level, the library includes these modules:

• ElectricTelemetry includes basic utilities such as validating user options.

• ElectricTelemetry.ApplicationTelemetry defines metrics and periodic measurements that apply to BEAM as a whole.

• ElectricTelemetry.StackTelemetry defines metrics that are specific to the notion of an Electric stack: shape stats, replication client stats, etc. No builtin measurements are defines here.

• Reporter modules. These are enabled individually and are used for exporting metrics to the corresponding destination.