Skip to content

ESS Telemetry

Note, this feature will be available starting from Element Pro version 25.12.0.

ESS now includes a Telemetry service. This service automatically scrapes various ESS components and configurations and provides a report in a transparent JSON format. We typically include things such as:

  • Enabled components
  • Enabled features
  • Component statistics
  • Component and Kube versions
  • Logging (when explicitly requested by the server admin)

The aim of the Telemetry service is to both report to Element what features are in use, and to help Element Support understand the kind of deployment you are running. Our support team may request that you send a copy of your telemetry report so that we are able to better identify your configuration and any potential problems.

See Configuring Telemetry for setting this up.

Reading telemetry from the cluster

The telemetry system is completely transparent to you, and can be read from your cluster with a simple command (you will need to have base64 installed on the host system).

kubectl --namespace <namespace> get secrets <your-helm-release>-telemetry-data \
    --output jsonpath='{.data.telemetry\.json}' | base64 --decode

Optionally pretty-print the output with jq

kubectl --namespace <namespace> get secrets <your-helm-release>-telemetry-data \
    --output jsonpath='{.data.telemetry\.json}' | base64 --decode | jq .

The information in this file is identical to the information we would send automatically.