Configuring Telemetry

See how to download example files from the helm chart here.

Configuration

For a quick setup using the default settings, see the minimal fragment example in charts/matrix-stack/ci/fragments/telemetry-minimal.yaml.

By default Telemetry only stores the Telemetry data in the cluster in a Secret named <release name>-telemetry-data.

The Telemetry service gets deployed by default (but does not automatically send any data), however it can be disabled with the following values:

telemetry:
  enabled: false

Automatic Reporting

The Telemetry component can also be configured to automatically send the Telemetry data to Element. This will cause the service to reach out to Element servers regularly and submit the telemetry data. Depending on your setup you might also want to check whether the service can reach the public internet (i.e., firewall rules). This is done with

telemetry:
  automaticReporting:
    enabled: true

It requires either essCredentials to be correctly populated at the top-level or, if you haven't configured that because you're running with the container images sourced from your private registry, to be configured like one of the below:

From charts/matrix-stack/ci/fragments/telemetry-secrets-in-helm.yaml

telemetry:
  automaticReporting:
    enabled: true
    credentials:
      username: "<ESS username>"
      password:
        value: "<ESS password>"

Or from charts/matrix-stack/ci/fragments/telemetry-secrets-externally.yaml

telemetry:
  automaticReporting:
    enabled: true
    credentials:
      username: "<ESS username>"
      password:
        secret: "{{ $.Release.Name }}-telemetry-external"
        secretKey: telemetrypassword

Where that Secret already exists in the cluster with your ESS password.

The frequency with which the Telemetry data is reported to Element is configured with

telemetry:
  automaticReporting:
    reportingPeriod: 5m